FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Clinical Quality Information icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Business Compartments: Patient

Detailed Descriptions for the elements in the MeasureReport resource.

MeasureReport
Element Id MeasureReport
Definition

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

Short Display Results of a measure evaluation
Cardinality 0..*
Type DomainResource
Summary false
Invariants
Defined on this element
mrp-1Rule Measure Reports used for data collection SHALL NOT communicate group and score information(type != 'data-exchange') or group.exists().not()
mrp-2Rule Stratifiers SHALL be either a single criteria or a set of criteria componentsgroup.stratifier.stratum.all(value.exists() xor component.exists())
MeasureReport.identifier
Element Id MeasureReport.identifier
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.

Short Display Additional identifier for the MeasureReport
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summary true
Comments

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.

MeasureReport.status
Element Id MeasureReport.status
Definition

The MeasureReport status. No data will be available until the MeasureReport status is complete.

Short Display complete | pending | error
Cardinality 1..1
Terminology Binding Measure Report Status (Required)
Type code
Is Modifier true (Reason: 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)
Summary true
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

MeasureReport.type
Element Id MeasureReport.type
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.

Short Display individual | subject-list | summary | data-exchange
Cardinality 1..1
Terminology Binding Measure Report Type (Required)
Type code
Summary true
Comments

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.

Invariants
Affect this element
mrp-1Rule Measure Reports used for data collection SHALL NOT communicate group and score information(type != 'data-exchange') or group.exists().not()
MeasureReport.dataUpdateType
Element Id MeasureReport.dataUpdateType
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.

Short Display incremental | snapshot
Cardinality 0..1
Terminology Binding Submit Data Update Type (Required)
Type code
Is Modifier true (Reason: 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)
Requirements

Allows receiving systems to support incremental exchange of data, reducing overall bandwidth requirements.

Summary true
Comments

This element only applies to Data-collection reports used to communicate the data-of-interest for a measure

MeasureReport.measure
Element Id MeasureReport.measure
Definition

A reference to the Measure that was calculated to produce this report.

Short Display What measure was calculated
Cardinality 0..1
Type canonical(Measure)
Summary true
MeasureReport.subject
Element Id MeasureReport.subject
Definition

Optional subject identifying the individual or individuals the report is for.

Short Display What individual(s) the report is for
Cardinality 0..1
Type Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
Summary true
MeasureReport.date
Element Id MeasureReport.date
Definition

The date this measure was calculated.

Short Display When the measure was calculated
Cardinality 0..1
Type dateTime
Summary true
MeasureReport.reporter
Element Id MeasureReport.reporter
Definition

The individual or organization that is reporting the data.

Short Display Who is reporting the data
Cardinality 0..1
Type Reference(Practitioner | PractitionerRole | Organization | Group)
Summary true
MeasureReport.reportingVendor
Element Id MeasureReport.reportingVendor
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.

Short Display What vendor prepared the data
Cardinality 0..1
Type Reference(Organization)
Summary false
MeasureReport.location
Element Id MeasureReport.location
Definition

A reference to the location for which the data is being reported.

Short Display Where the reported data is from
Cardinality 0..1
Type Reference(Location)
Summary false
MeasureReport.period
Element Id MeasureReport.period
Definition

The reporting period for which the report was calculated.

Short Display What period the report covers
Cardinality 1..1
Type Period
Summary true
MeasureReport.inputParameters
Element Id MeasureReport.inputParameters
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.

Short Display What parameters were provided to the report
Cardinality 0..1
Type Reference(Parameters)
Summary false
Comments

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).

MeasureReport.scoring
Element Id MeasureReport.scoring
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.

Short Display What scoring method (e.g. proportion, ratio, continuous-variable)
Cardinality 0..1
Terminology Binding Measure Scoring icon (Extensible)
Type CodeableConcept
Is Modifier true (Reason: Scoring determines what method was used to calculate the measure score and is required for correct interpretation of the score)
Summary true
MeasureReport.improvementNotation
Element Id MeasureReport.improvementNotation
Definition

Whether improvement in the measure is noted by an increase or decrease in the measure score.

Short Display increase | decrease
Cardinality 0..1
Terminology Binding Measure Improvement Notation (Required)
Type CodeableConcept
Is Modifier true (Reason: Improvement notation determines how to interpret the measure score (i.e. whether an increase is an improvement))
Summary true
Comments

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.

MeasureReport.group
Element Id MeasureReport.group
Definition

The results of the calculation, one for each population group in the measure.

Short Display Measure results for each group
Cardinality 0..*
Summary false
Invariants
Affect this element
mrp-2Rule Stratifiers SHALL be either a single criteria or a set of criteria componentsgroup.stratifier.stratum.all(value.exists() xor component.exists())
mrp-1Rule Measure Reports used for data collection SHALL NOT communicate group and score information(type != 'data-exchange') or group.exists().not()
MeasureReport.group.linkId
Element Id MeasureReport.group.linkId
Definition

The group from the Measure that corresponds to this group in the MeasureReport resource.

Short Display Pointer to specific group from Measure
Cardinality 0..1
Type string
Summary false
MeasureReport.group.code
Element Id MeasureReport.group.code
Definition

The meaning of the population group as defined in the measure definition.

Short Display Meaning of the group
Cardinality 0..1
Terminology Binding Measure Group Example (Example)
Type CodeableConcept
Summary true
MeasureReport.group.subject
Element Id MeasureReport.group.subject
Definition

Optional subject identifying the individual or individuals the report is for.

Short Display What individual(s) the report is for
Cardinality 0..1
Type Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
Summary true
MeasureReport.group.population
Element Id MeasureReport.group.population
Definition

The populations that make up the population group, one for each type of population appropriate for the measure.

Short Display The populations in the group
Cardinality 0..*
Summary false
MeasureReport.group.population.linkId
Element Id MeasureReport.group.population.linkId
Definition

The population from the Measure that corresponds to this population in the MeasureReport resource.

Short Display Pointer to specific population from Measure
Cardinality 0..1
Type string
Summary false
MeasureReport.group.population.code
Element Id MeasureReport.group.population.code
Definition

The type of the population.

Short Display initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Cardinality 0..1
Terminology Binding Measure Population Type (Extensible)
Type CodeableConcept
Summary true
MeasureReport.group.population.count
Element Id MeasureReport.group.population.count
Definition

The number of members of the population.

Short Display Size of the population
Cardinality 0..1
Type integer
Summary false
MeasureReport.group.population.subjectResults
Element Id MeasureReport.group.population.subjectResults
Definition

This element refers to a List of individual level MeasureReport resources, one for each subject in this population.

Short Display For subject-list reports, the subject results in this population
Cardinality 0..1
Type Reference(List)
Summary false
MeasureReport.group.population.subjectReport
Element Id MeasureReport.group.population.subjectReport
Definition

A reference to an individual level MeasureReport resource for a member of the population.

Short Display For subject-list reports, a subject result in this population
Cardinality 0..*
Type Reference(MeasureReport)
Summary false
Comments

This element SHALL NOT be used in with subjectResults, either systems provide results as a List of MeasureReport, or as references to individual MeasureReports. Note that using this element introduces a constraint on the size of the subject-list MeasureReport; implementations would be free to return a TOO-COSTLY response if a request is made for a subject-list report with too many subjects.

MeasureReport.group.population.subjects
Element Id MeasureReport.group.population.subjects
Definition

Optional Group identifying the individuals that make up the population.

Short Display What individual(s) in the population
Cardinality 0..1
Type Reference(Group)
Summary false
Comments

Note that this element can only be used for summary and subject-list reports 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 an actual (as opposed to a definitional) group.

MeasureReport.group.measureScore[x]
Element Id MeasureReport.group.measureScore[x]
Definition

The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.

Short Display What score this group achieved
Cardinality 0..1
Type Quantity|dateTime|CodeableConcept|Period|Range|Duration
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
MeasureReport.group.stratifier
Element Id MeasureReport.group.stratifier
Definition

When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.

Short Display Stratification results
Cardinality 0..*
Summary false
Invariants
Affect this element
mrp-2Rule Stratifiers SHALL be either a single criteria or a set of criteria componentsgroup.stratifier.stratum.all(value.exists() xor component.exists())
MeasureReport.group.stratifier.linkId
Element Id MeasureReport.group.stratifier.linkId
Definition

The stratifier from the Measure that corresponds to this stratifier in the MeasureReport resource.

Short Display Pointer to specific stratifier from Measure
Cardinality 0..1
Type string
Summary false
MeasureReport.group.stratifier.code
Element Id MeasureReport.group.stratifier.code
Definition

The meaning of this stratifier, as defined in the measure definition.

Short Display What stratifier of the group
Cardinality 0..1
Terminology Binding Measure Stratifier Example (Example)
Type CodeableConcept
Summary false
MeasureReport.group.stratifier.stratum
Element Id MeasureReport.group.stratifier.stratum
Definition

This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.

Short Display Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components
Cardinality 0..*
Summary false
Invariants
Affect this element
mrp-2Rule Stratifiers SHALL be either a single criteria or a set of criteria componentsgroup.stratifier.stratum.all(value.exists() xor component.exists())
MeasureReport.group.stratifier.stratum.value[x]
Element Id MeasureReport.group.stratifier.stratum.value[x]
Definition

The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.

Short Display The stratum value, e.g. male
Cardinality 0..1
Terminology Binding Measure Report Stratifier Value Example (Example)
Type CodeableConcept|boolean|Quantity|Range|Reference
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
Invariants
Affect this element
mrp-2Rule Stratifiers SHALL be either a single criteria or a set of criteria componentsgroup.stratifier.stratum.all(value.exists() xor component.exists())
MeasureReport.group.stratifier.stratum.component
Element Id MeasureReport.group.stratifier.stratum.component
Definition

A stratifier component value.

Short Display Stratifier component values
Cardinality 0..*
Summary false
Invariants
Affect this element
mrp-2Rule Stratifiers SHALL be either a single criteria or a set of criteria componentsgroup.stratifier.stratum.all(value.exists() xor component.exists())
MeasureReport.group.stratifier.stratum.component.linkId
Element Id MeasureReport.group.stratifier.stratum.component.linkId
Definition

The stratifier component from the Measure that corresponds to this stratifier component in the MeasureReport resource.

Short Display Pointer to specific stratifier component from Measure
Cardinality 0..1
Type string
Summary false
MeasureReport.group.stratifier.stratum.component.code
Element Id MeasureReport.group.stratifier.stratum.component.code
Definition

The code for the stratum component value.

Short Display What stratifier component of the group
Cardinality 1..1
Terminology Binding Measure Stratifier Example (Example)
Type CodeableConcept
Summary false
MeasureReport.group.stratifier.stratum.component.value[x]
Element Id MeasureReport.group.stratifier.stratum.component.value[x]
Definition

The stratum component value.

Short Display The stratum component value, e.g. male
Cardinality 1..1
Terminology Binding Measure Report Stratifier Value Example (Example)
Type CodeableConcept|boolean|Quantity|Range|Reference
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
MeasureReport.group.stratifier.stratum.population
Element Id MeasureReport.group.stratifier.stratum.population
Definition

The populations that make up the stratum, one for each type of population appropriate to the measure.

Short Display Population results in this stratum
Cardinality 0..*
Summary false
MeasureReport.group.stratifier.stratum.population.linkId
Element Id MeasureReport.group.stratifier.stratum.population.linkId
Definition

The population from the Measure that corresponds to this population in the MeasureReport resource.

Short Display Pointer to specific population from Measure
Cardinality 0..1
Type string
Summary false
MeasureReport.group.stratifier.stratum.population.code
Element Id MeasureReport.group.stratifier.stratum.population.code
Definition

The type of the population.

Short Display initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Cardinality 0..1
Terminology Binding Measure Population Type (Extensible)
Type CodeableConcept
Summary false
MeasureReport.group.stratifier.stratum.population.count
Element Id MeasureReport.group.stratifier.stratum.population.count
Definition

The number of members of the population in this stratum.

Short Display Size of the population
Cardinality 0..1
Type integer
Summary false
MeasureReport.group.stratifier.stratum.population.subjectResults
Element Id MeasureReport.group.stratifier.stratum.population.subjectResults
Definition

This element refers to a List of individual level MeasureReport resources, one for each subject in this population in this stratum.

Short Display For subject-list reports, the subject results in this population
Cardinality 0..1
Type Reference(List)
Summary false
MeasureReport.group.stratifier.stratum.population.subjectReport
Element Id MeasureReport.group.stratifier.stratum.population.subjectReport
Definition

A reference to an individual level MeasureReport resource for a member of the population.

Short Display For subject-list reports, a subject result in this population
Cardinality 0..*
Type Reference(MeasureReport)
Summary false
Comments

This element SHALL NOT be used in with subjectResults, either systems provide results as a List of MeasureReport, or as references to individual MeasureReports. Note that using this element introduces a constraint on the size of the subject-list MeasureReport; implementations would be free to return a TOO-COSTLY response if a request is made for a subject-list report with too many subjects.

MeasureReport.group.stratifier.stratum.population.subjects
Element Id MeasureReport.group.stratifier.stratum.population.subjects
Definition

Optional Group identifying the individuals that make up the population.

Short Display What individual(s) in the population
Cardinality 0..1
Type Reference(Group)
Summary false
Comments

Note that this element can only be used for summary and subject-list reports 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 SHALL be an actual (as opposed to a definitional) group.

MeasureReport.group.stratifier.stratum.measureScore[x]
Element Id MeasureReport.group.stratifier.stratum.measureScore[x]
Definition

The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.

Short Display What score this stratum achieved
Cardinality 0..1
Type Quantity|dateTime|CodeableConcept|Period|Range|Duration
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
MeasureReport.supplementalData
Element Id MeasureReport.supplementalData
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.

Short Display Additional information collected for the report
Cardinality 0..*
Type Reference(Any)
Summary false
Comments

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.

MeasureReport.evaluatedResource
Element Id MeasureReport.evaluatedResource
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.

Short Display What data was used to calculate the measure score
Cardinality 0..*
Type Reference(Any)
Summary false
Comments

Evaluated resources are only reported for individual reports.