Data Model Libraries
    Preparing search index...

    MeasureGroupPopulationComponent Class

    FHIR Specification

    • Short: Population criteria
    • Definition: A population criteria for the measure.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    linkId?: StringType

    Measure.group.population.linkId Element

    FHIR Specification

    • Short: Unique id for population in measure
    • Definition: An identifier that is unique within the Measure allowing linkage to the equivalent population in a MeasureReport resource.
    • Comment: This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such
    • Requirements: MeasureReport does not require omitted populations to be included.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Measure.group.population.code Element

    FHIR Specification

    • Short: initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
    • Definition: The type of population criteria.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    Measure.group.population.description Element

    FHIR Specification

    • Short: The human readable description of this population criteria
    • Definition: The human readable description of this population criteria.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    criteria?: Expression

    Measure.group.population.criteria Element

    FHIR Specification

    • Short: The criteria that defines this population
    • Definition: An expression that specifies the criteria for the population, typically the name of an expression in a library.
    • Comment: In the case of a continuous-variable or ratio measure, this may be the name of a function that calculates the value of the individual observation for each patient or event in the population. For these types of measures, individual observations are reported as observation resources included in the evaluatedResources bundle for each patient. See the MeasureReport resource or the Quality Reporting topic for more information.
    • FHIR Type: Expression
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    groupDefinition?: Reference

    Measure.group.population.groupDefinition Element

    FHIR Specification

    • Short: A group resource that defines this population
    • Definition: A Group resource that defines this population as a set of characteristics.
    • Comment: Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group resource SHALL be a definitional (as opposed to an actual) group.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    inputPopulationId?: StringType

    Measure.group.population.inputPopulationId Element

    FHIR Specification

    • Short: Which population
    • Definition: The id of a population element in this measure that provides the input for this population criteria. In most cases, the scoring structure of the measure implies specific relationships (e.g. the Numerator uses the Denominator as the source in a proportion scoring). In some cases, however, multiple possible choices exist and must be resolved explicitly. For example in a ratio measure with multiple initial populations, the denominator must specify which population should be used as the starting point.
    • Requirements: For ratio and continuous variable measures, the source populations must be specified explicitly when they cannot be unambiguously determined from the scoring structure.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    aggregateMethod?: CodeableConcept

    Measure.group.population.aggregateMethod Element

    FHIR Specification

    • Short: Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count)
    • Definition: Specifies which method should be used to aggregate measure observation values. For most scoring types, this is implied by scoring (e.g. a proportion measure counts members of the populations). For continuous variables, however, this information must be specified to ensure correct calculation.
    • Requirements: For continuous variable measures, specifications must be able to indicate the aggregation method to be used for tallying results from individual observations.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided MeasureGroupPopulationComponent JSON to instantiate the MeasureGroupPopulationComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR MeasureGroupPopulationComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MeasureGroupPopulationComponent

      Returns undefined | MeasureGroupPopulationComponent

      MeasureGroupPopulationComponent data model or undefined for MeasureGroupPopulationComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided GroupDefinition object value to the groupDefinition property.

      Parameters

      • value: undefined | Reference

        the groupDefinition object value

      Returns this

      this

      @ReferenceTargets('Measure.group.population.groupDefinition', ['Group',])

      InvalidTypeError for invalid data type or reference value

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise