Data Model Libraries
    Preparing search index...

    Class MeasureSupplementalDataComponent

    MeasureSupplementalDataComponent Class

    FHIR Specification

    • Short: What other data should be reported with the measure
    • Definition: The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.
    • Comment: Note that supplemental data are reported as resources for each patient and referenced in the supplementalData element of the MeasureReport. If the supplementalData expression results in a value other than a resource, it is reported using an Observation resource, typically contained in the resulting MeasureReport. See the MeasureReport resource and the Quality Reporting topic for more information.

    FHIR Measure

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    linkId? code? usage? description? criteria

    Methods

    parse getLinkIdElement setLinkIdElement hasLinkIdElement getLinkId setLinkId hasLinkId getCode setCode hasCode getUsage setUsage addUsage hasUsage getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getCriteria setCriteria hasCriteria fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initUsage

    Constructors

    Properties

    linkId?: StringType

    Measure.supplementalData.linkId Element

    FHIR Specification

    • Short: Unique id for supplementalData 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 supplementalData to be included.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    code?: CodeableConcept

    Measure.supplementalData.code Element

    FHIR Specification

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

    Measure.supplementalData.usage Element

    FHIR Specification

    • Short: supplemental-data | risk-adjustment-factor
    • Definition: An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    Measure.supplementalData.description Element

    FHIR Specification

    • Short: The human readable description of this supplemental data
    • Definition: The human readable description of this supplemental data.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    criteria: null | Expression

    Measure.supplementalData.criteria Element

    FHIR Specification

    • Short: Expression describing additional data to be reported
    • Definition: The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.
    • FHIR Type: Expression
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MeasureSupplementalDataComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MeasureSupplementalDataComponent

      MeasureSupplementalDataComponent data model or undefined for MeasureSupplementalDataComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods