Data Model Libraries
    Preparing search index...

    Class MeasureReport

    MeasureReport Class

    The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.

    FHIR Specification

    • Short: Results of a measure evaluation
    • Definition: The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
    • FHIR Version: 5.0.0

    FHIR MeasureReport

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? measureReportStatusEnum status measureReportTypeEnum type_ submitDataUpdateTypeEnum dataUpdateType? measure? subject? date? reporter? reportingVendor? location? period inputParameters? scoring? improvementNotation? group? supplementalData? evaluatedResource?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getTypeEnumType setTypeEnumType hasTypeEnumType getTypeElement setTypeElement hasTypeElement getType setType hasType getDataUpdateTypeEnumType setDataUpdateTypeEnumType hasDataUpdateTypeEnumType getDataUpdateTypeElement setDataUpdateTypeElement hasDataUpdateTypeElement getDataUpdateType setDataUpdateType hasDataUpdateType getMeasureElement setMeasureElement hasMeasureElement getMeasure setMeasure hasMeasure getSubject setSubject hasSubject getDateElement setDateElement hasDateElement getDate setDate hasDate getReporter setReporter hasReporter getReportingVendor setReportingVendor hasReportingVendor getLocation setLocation hasLocation getPeriod setPeriod hasPeriod getInputParameters setInputParameters hasInputParameters getScoring setScoring hasScoring getImprovementNotation setImprovementNotation hasImprovementNotation getGroup setGroup addGroup hasGroup getSupplementalData setSupplementalData addSupplementalData hasSupplementalData getEvaluatedResource setEvaluatedResource addEvaluatedResource hasEvaluatedResource fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initGroup initSupplementalData initEvaluatedResource

    Constructors

    Properties

    identifier?: Identifier[]

    MeasureReport.identifier Element

    FHIR Specification

    • Short: Additional identifier for the MeasureReport
    • Definition: A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.
    • Comment: Typically, this is used for identifiers that can go in an HL7 V3 II data type - e.g. to identify this {{title}} outside of FHIR, where the logical URL is not possible to use.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    measureReportStatusEnum: MeasureReportStatusEnum

    FHIR CodeSystem: MeasureReportStatus

    MeasureReportStatusEnum

    status: null | EnumCodeType

    MeasureReport.status Element

    FHIR Specification

    • Short: complete | pending | error
    • Definition: The MeasureReport status. No data will be available until the MeasureReport status is complete.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: MeasureReportStatusEnum

    measureReportTypeEnum: MeasureReportTypeEnum

    FHIR CodeSystem: MeasureReportType

    MeasureReportTypeEnum

    Privatetype_

    type_: null | EnumCodeType

    MeasureReport.type Element

    FHIR Specification

    • Short: individual | subject-list | summary | data-exchange
    • Definition: The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.
    • Comment: Data-exchange reports are used only to communicate data-of-interest for a measure. They do not necessarily include all the data for a particular subject or population, but they may.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: MeasureReportTypeEnum

    submitDataUpdateTypeEnum: SubmitDataUpdateTypeEnum

    FHIR CodeSystem: SubmitDataUpdateType

    SubmitDataUpdateTypeEnum

    dataUpdateType?: EnumCodeType

    MeasureReport.dataUpdateType Element

    FHIR Specification

    • Short: incremental | snapshot
    • Definition: Indicates whether the data submitted in a data-exchange report represents a snapshot or incremental update. A snapshot update replaces all previously submitted data for the receiver, whereas an incremental update represents only updated and/or changed data and should be applied as a differential update to the existing submitted data for the receiver.
    • Comment: This element only applies to Data-collection reports used to communicate the data-of-interest for a measure
    • Requirements: Allows receiving systems to support incremental exchange of data, reducing overall bandwidth requirements.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element determines whether the data in a data-exchange measure report is a snapshot or incremental update and is required in order to correctly apply the data update to a receiving system
    • isSummary: true

    CodeSystem Enumeration: SubmitDataUpdateTypeEnum

    measure?: CanonicalType

    MeasureReport.measure Element

    FHIR Specification

    • Short: What measure was calculated
    • Definition: A reference to the Measure that was calculated to produce this report.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject?: Reference

    MeasureReport.subject Element

    FHIR Specification

    date?: DateTimeType

    MeasureReport.date Element

    FHIR Specification

    • Short: When the measure was calculated
    • Definition: The date this measure was calculated.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    reporter?: Reference

    MeasureReport.reporter Element

    FHIR Specification

    reportingVendor?: Reference

    MeasureReport.reportingVendor Element

    FHIR Specification

    • Short: What vendor prepared the data
    • Definition: A reference to the vendor who queried the data, calculated results and/or generated the report. The 'reporting vendor' is intended to represent the submitting entity when it is not the same as the reporting entity. This extension is used when the Receiver is interested in getting vendor information in the report.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    location?: Reference

    MeasureReport.location Element

    FHIR Specification

    • Short: Where the reported data is from
    • Definition: A reference to the location for which the data is being reported.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    period: null | Period

    MeasureReport.period Element

    FHIR Specification

    • Short: What period the report covers
    • Definition: The reporting period for which the report was calculated.
    • FHIR Type: Period
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    inputParameters?: Reference

    MeasureReport.inputParameters Element

    FHIR Specification

    • Short: What parameters were provided to the report
    • Definition: A reference to a Parameters resource (typically represented using a contained resource) that represents any input parameters that were provided to the operation that generated the report.
    • Comment: Whenever an operation returns a MeasureReport, the IN parameters from that operation can be returned to the caller of the operation using MeasureReport.inputParameters. Operations include but are not limited to $evaluate-measure, $care-gaps, $data-requirements, and $collect-data. The inputParameters can also be used in a MeasureReport used to define a test case (i.e., not as a result of an operation).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    scoring?: CodeableConcept

    MeasureReport.scoring Element

    FHIR Specification

    • Short: What scoring method (e.g. proportion, ratio, continuous-variable)
    • 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. It is expected to be the same as the scoring element on the referenced Measure.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: Scoring determines what method was used to calculate the measure score and is required for correct interpretation of the score
    • isSummary: true
    improvementNotation?: CodeableConcept

    MeasureReport.improvementNotation Element

    FHIR Specification

    • Short: increase | decrease
    • Definition: Whether improvement in the measure is noted by an increase or decrease in the measure score.
    • Comment: This element is typically defined by the measure, but reproduced here to ensure the measure score can be interpreted. The element is labeled as a modifier because it changes the interpretation of the reported measure score. Note also that a MeasureReport instance includes the improvementNotation as defined by the Measure being reported. It is duplicated in the MeasureReport because it is a critical aspect of interpreting the measure score but it is not intended to reflect whether the measure report is an increase or decrease. It helps interpret if the measure score is an increase or decrease, I.e., moving in the direction of the desired outcome.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: Improvement notation determines how to interpret the measure score (i.e. whether an increase is an improvement)
    • isSummary: true
    group?: MeasureReportGroupComponent[]

    MeasureReport.group Element

    FHIR Specification

    • Short: Measure results for each group
    • Definition: The results of the calculation, one for each population group in the measure.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    supplementalData?: Reference[]

    MeasureReport.supplementalData Element

    FHIR Specification

    • Short: Additional information collected for the report
    • Definition: A reference to a Resource that represents additional information collected for the report. If the value of the supplemental data is not a Resource (i.e. evaluating the supplementalData expression for this case in the measure results in a value that is not a FHIR Resource), it is reported as a reference to a contained Observation resource.
    • Comment: For individual measure reports, the supplementalData elements represent the direct result of evaluating the supplementalData expression for the subject of the report. For summary reports, supplementalData is reported as references to contained Observation resources that represent the number of times each value appeared as a supplementalData result for members of the population.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    evaluatedResource?: Reference[]

    MeasureReport.evaluatedResource Element

    FHIR Specification

    • Short: What data was used to calculate the measure score
    • Definition: Evaluated resources are used to capture what data was involved in the calculation of a measure. This usage is only allowed for individual reports to ensure that the size of the MeasureReport resource is bounded.
    • Comment: Evaluated resources are only reported for individual reports.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MeasureReport

      • OptionaloptSourceField: string

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

      Returns undefined | MeasureReport

      MeasureReport data model or undefined for MeasureReport

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Subject object value to the subject property.

      Parameters

      • value: undefined | Reference

        the subject object value

      Returns this

      this

      @ReferenceTargets('MeasureReport.subject', ['CareTeam','Device','Group','HealthcareService','Location','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetTypeEnumTypesetTypeEnumTypehasTypeEnumTypegetTypeElementsetTypeElementhasTypeElementgetTypesetTypehasTypegetDataUpdateTypeEnumTypesetDataUpdateTypeEnumTypehasDataUpdateTypeEnumTypegetDataUpdateTypeElementsetDataUpdateTypeElementhasDataUpdateTypeElementgetDataUpdateTypesetDataUpdateTypehasDataUpdateTypegetMeasureElementsetMeasureElementhasMeasureElementgetMeasuresetMeasurehasMeasuregetSubjectsetSubjecthasSubjectgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetReportersetReporterhasReportergetReportingVendorsetReportingVendorhasReportingVendorgetLocationsetLocationhasLocationgetPeriodsetPeriodhasPeriodgetInputParameterssetInputParametershasInputParametersgetScoringsetScoringhasScoringgetImprovementNotationsetImprovementNotationhasImprovementNotationgetGroupsetGroupaddGrouphasGroupgetSupplementalDatasetSupplementalDataaddSupplementalDatahasSupplementalDatagetEvaluatedResourcesetEvaluatedResourceaddEvaluatedResourcehasEvaluatedResourcefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitGroupinitSupplementalDatainitEvaluatedResource