Data Model Libraries
    Preparing search index...

    Class MeasureGroupComponent

    MeasureGroupComponent Class

    FHIR Specification

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

    FHIR Measure

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    linkId? code? description? type_? subject? fhirTypesEnum basis? scoring? scoringUnit? rateAggregation? improvementNotation? library? population? stratifier?

    Methods

    parse getLinkIdElement setLinkIdElement hasLinkIdElement getLinkId setLinkId hasLinkId getCode setCode hasCode getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getType setType addType hasType getSubject setSubject hasSubject getSubjectCodeableConcept hasSubjectCodeableConcept getSubjectReference hasSubjectReference getBasisEnumType setBasisEnumType hasBasisEnumType getBasisElement setBasisElement hasBasisElement getBasis setBasis hasBasis getScoring setScoring hasScoring getScoringUnit setScoringUnit hasScoringUnit getRateAggregationElement setRateAggregationElement hasRateAggregationElement getRateAggregation setRateAggregation hasRateAggregation getImprovementNotation setImprovementNotation hasImprovementNotation getLibraryElement setLibraryElement addLibraryElement hasLibraryElement getLibrary setLibrary addLibrary hasLibrary getPopulation setPopulation addPopulation hasPopulation getStratifier setStratifier addStratifier hasStratifier fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initType initLibrary initPopulation initStratifier

    Constructors

    Properties

    linkId?: StringType

    Measure.group.linkId Element

    FHIR Specification

    • Short: Unique id for group in measure
    • Definition: An identifier that is unique within the Measure allowing linkage to the equivalent item 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 groups to be included.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    code?: CodeableConcept

    Measure.group.code Element

    FHIR Specification

    • Short: Meaning of the group
    • Definition: Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    Measure.group.description Element

    FHIR Specification

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

    Private Optionaltype_

    type_?: CodeableConcept[]

    Measure.group.type Element

    FHIR Specification

    • Short: process | outcome | structure | patient-reported-outcome | composite
    • Definition: Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.
    • Comment: When specified at the group level, defines the measure type for this specific group. If not specified, the measureType of the group is determined by the root type element
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subject?: IDataType

    Measure.group.subject[x] Element

    @ChoiceDataTypesMeta('Measure.group.subject[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    • Definition: The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
    • Comment: The subject of the measure is critical in interpreting the criteria definitions, as the logic in the measures is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    fhirTypesEnum: FhirTypesEnum

    FHIR CodeSystem: FhirTypes

    FhirTypesEnum

    basis?: EnumCodeType

    Measure.group.basis Element

    FHIR Specification

    • Short: Population basis
    • Definition: The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters.
    • Comment: When specified at the group level, defines the population basis for this specific group. If not specified, the basis for the group is determined by the root basis element
    • Requirements: Allows non-subject-based measures to be specified
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: FhirTypesEnum

    scoring?: CodeableConcept

    Measure.group.scoring Element

    FHIR Specification

    • Short: proportion | ratio | continuous-variable | cohort
    • Definition: Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
    • Comment: When specified at the group level, defines the scoring for this specific group. If not specified, scoring for this group is determined by the root scoring element
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    scoringUnit?: CodeableConcept

    Measure.group.scoringUnit Element

    FHIR Specification

    • Short: What units?
    • Definition: Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.
    • Comment: When specified at the group level, this defines the scoringUnit for this specific group. If not specified, the scoringUnit for this group is determined by the root scoringUnit element. As with the root element, when this element is specified, implementations are expected to report measure scores in the specified units. Note that this may involve unit conversion if the expected units are different than the units of the resulting score calculation. In this case, unit conversions SHALL be performed according to the unit conversion semantics specified by UCUM.
    • Requirements: When the unit cannot be inferred directly from the calculation logic, this element allows the specification of the desired units of measure of the output.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    rateAggregation?: MarkdownType

    Measure.group.rateAggregation Element

    FHIR Specification

    • Short: How is rate aggregation performed for this measure
    • Definition: Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
    • Comment: The measure rate for an organization or clinician is based upon the entities' aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    improvementNotation?: CodeableConcept

    Measure.group.improvementNotation Element

    FHIR Specification

    • Short: increase | decrease
    • Definition: Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).
    • Comment: When specified at the group level, this element defines the improvementNotation for this specific group. If not specified, improvementNotation for this group is determined by the root improvementNotation element
    • Requirements: Measure consumers and implementers must be able to determine how to interpret a measure score.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    library?: CanonicalType[]

    Measure.group.library Element

    FHIR Specification

    • Short: Logic used by the measure group
    • Definition: A reference to a Library resource containing the formal logic used by the measure group.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    population?: MeasureGroupPopulationComponent[]

    Measure.group.population Element

    FHIR Specification

    • Short: Population criteria
    • Definition: A population criteria for the measure.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    stratifier?: MeasureGroupStratifierComponent[]

    Measure.group.stratifier Element

    FHIR Specification

    • Short: Stratifier criteria for the measure
    • Definition: The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MeasureGroupComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MeasureGroupComponent

      MeasureGroupComponent data model or undefined for MeasureGroupComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetLinkIdElementsetLinkIdElementhasLinkIdElementgetLinkIdsetLinkIdhasLinkIdgetCodesetCodehasCodegetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetTypesetTypeaddTypehasTypegetSubjectsetSubjecthasSubjectgetSubjectCodeableConcepthasSubjectCodeableConceptgetSubjectReferencehasSubjectReferencegetBasisEnumTypesetBasisEnumTypehasBasisEnumTypegetBasisElementsetBasisElementhasBasisElementgetBasissetBasishasBasisgetScoringsetScoringhasScoringgetScoringUnitsetScoringUnithasScoringUnitgetRateAggregationElementsetRateAggregationElementhasRateAggregationElementgetRateAggregationsetRateAggregationhasRateAggregationgetImprovementNotationsetImprovementNotationhasImprovementNotationgetLibraryElementsetLibraryElementaddLibraryElementhasLibraryElementgetLibrarysetLibraryaddLibraryhasLibrarygetPopulationsetPopulationaddPopulationhasPopulationgetStratifiersetStratifieraddStratifierhasStratifierfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitTypeinitLibraryinitPopulationinitStratifier