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: 3 Trial UseSecurity Category: Business Compartments: Patient

Detailed Descriptions for the elements in the MeasureReport resource.

MeasureReport
Element IdMeasureReport
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 DisplayResults of a measure evaluation
Cardinality0..*
TypeDomainResource
Summaryfalse
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 IdMeasureReport.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 DisplayAdditional identifier for the MeasureReport
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

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

Summarytrue
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 IdMeasureReport.status
Definition

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

Short Displaycomplete | pending | error
Cardinality1..1
Terminology BindingMeasureReportStatus (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
Comments

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

MeasureReport.type
Element IdMeasureReport.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 Displayindividual | subject-list | summary | data-exchange
Cardinality1..1
Terminology BindingMeasureReportType (Required)
Typecode
Summarytrue
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 IdMeasureReport.dataUpdateType
Definition

Indicates whether the data submitted in an 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 Displayincremental | snapshot
Cardinality0..1
Terminology BindingSubmit Data Update Type (Required)
Typecode
Is Modifiertrue (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.

Summarytrue
Comments

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

MeasureReport.measure
Element IdMeasureReport.measure
Definition

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

Short DisplayWhat measure was calculated
Cardinality0..1
Typecanonical(Measure)
Summarytrue
MeasureReport.subject
Element IdMeasureReport.subject
Definition

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

Short DisplayWhat individual(s) the report is for
Cardinality0..1
TypeReference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
Summarytrue
MeasureReport.date
Element IdMeasureReport.date
Definition

The date this measure report was generated.

Short DisplayWhen the report was generated
Cardinality0..1
TypedateTime
Summarytrue
MeasureReport.reporter
Element IdMeasureReport.reporter
Definition

The individual or organization that is reporting the data.

Short DisplayWho is reporting the data
Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization | Group)
Summarytrue
MeasureReport.reportingVendor
Element IdMeasureReport.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 DisplayWhat vendor prepared the data
Cardinality0..1
TypeReference(Organization)
Summaryfalse
MeasureReport.location
Element IdMeasureReport.location
Definition

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

Short DisplayWhere the reported data is from
Cardinality0..1
TypeReference(Location)
Summaryfalse
MeasureReport.period
Element IdMeasureReport.period
Definition

The reporting period for which the report was calculated.

Short DisplayWhat period the report covers
Cardinality1..1
TypePeriod
Summarytrue
MeasureReport.inputParameters
Element IdMeasureReport.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 DisplayWhat parameters were provided to the report
Cardinality0..1
TypeReference(Parameters)
Summaryfalse
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 IdMeasureReport.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 DisplayWhat scoring method (e.g. proportion, ratio, continuous-variable)
Cardinality0..1
Terminology BindingMeasureScoring (Extensible)
TypeCodeableConcept
Is Modifiertrue (Reason: Scoring determines what method was used to calculate the measure score and is required for correct interpretation of the score)
Summarytrue
MeasureReport.improvementNotation
Element IdMeasureReport.improvementNotation
Definition

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

Short Displayincrease | decrease
Cardinality0..1
Terminology BindingMeasureImprovementNotation (Required)
TypeCodeableConcept
Is Modifiertrue (Reason: Improvement notation determines how to interpret the measure score (i.e. whether an increase is an improvement))
Summarytrue
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.

MeasureReport.group
Element IdMeasureReport.group
Definition

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

Short DisplayMeasure results for each group
Cardinality0..*
Summaryfalse
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.group.code
Element IdMeasureReport.group.code
Definition

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

Short DisplayMeaning of the group
Cardinality0..1
Terminology BindingMeasureGroupExample (Example)
TypeCodeableConcept
Summarytrue
MeasureReport.group.population
Element IdMeasureReport.group.population
Definition

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

Short DisplayThe populations in the group
Cardinality0..*
Summaryfalse
MeasureReport.group.population.code
Element IdMeasureReport.group.population.code
Definition

The type of the population.

Short Displayinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Cardinality0..1
Terminology BindingMeasurePopulationType (Extensible)
TypeCodeableConcept
Summarytrue
MeasureReport.group.population.count
Element IdMeasureReport.group.population.count
Definition

The number of members of the population.

Short DisplaySize of the population
Cardinality0..1
Typeinteger
Summaryfalse
MeasureReport.group.population.subjectResults
Element IdMeasureReport.group.population.subjectResults
Definition

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

Short DisplayFor subject-list reports, the subject results in this population
Cardinality0..1
TypeReference(List)
Summaryfalse
MeasureReport.group.measureScore[x]
Element IdMeasureReport.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 DisplayWhat score this group achieved
Cardinality0..1
TypeQuantity|dateTime|CodeableConcept|Period|Range|Duration
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
MeasureReport.group.stratifier
Element IdMeasureReport.group.stratifier
Definition

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

Short DisplayStratification results
Cardinality0..*
Summaryfalse
MeasureReport.group.stratifier.code
Element IdMeasureReport.group.stratifier.code
Definition

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

Short DisplayWhat stratifier of the group
Cardinality0..1
Terminology BindingMeasureStratifierExample (Example)
TypeCodeableConcept
Summaryfalse
MeasureReport.group.stratifier.stratum
Element IdMeasureReport.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 DisplayStratum results, one for each unique value, or set of values, in the stratifier, or stratifier components
Cardinality0..*
Summaryfalse
MeasureReport.group.stratifier.stratum.value[x]
Element IdMeasureReport.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 DisplayThe stratum value, e.g. male
Cardinality0..1
Terminology BindingMeasureReportStratifierValueExample (Example)
TypeCodeableConcept|boolean|Quantity|Range|Reference
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
MeasureReport.group.stratifier.stratum.component
Element IdMeasureReport.group.stratifier.stratum.component
Definition

A stratifier component value.

Short DisplayStratifier component values
Cardinality0..*
Summaryfalse
MeasureReport.group.stratifier.stratum.component.code
Element IdMeasureReport.group.stratifier.stratum.component.code
Definition

The code for the stratum component value.

Short DisplayWhat stratifier component of the group
Cardinality1..1
Terminology BindingMeasureStratifierExample (Example)
TypeCodeableConcept
Summaryfalse
MeasureReport.group.stratifier.stratum.component.value[x]
Element IdMeasureReport.group.stratifier.stratum.component.value[x]
Definition

The stratum component value.

Short DisplayThe stratum component value, e.g. male
Cardinality1..1
Terminology BindingMeasureReportStratifierValueExample (Example)
TypeCodeableConcept|boolean|Quantity|Range|Reference
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
MeasureReport.group.stratifier.stratum.population
Element IdMeasureReport.group.stratifier.stratum.population
Definition

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

Short DisplayPopulation results in this stratum
Cardinality0..*
Summaryfalse
MeasureReport.group.stratifier.stratum.population.code
Element IdMeasureReport.group.stratifier.stratum.population.code
Definition

The type of the population.

Short Displayinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Cardinality0..1
Terminology BindingMeasurePopulationType (Extensible)
TypeCodeableConcept
Summaryfalse
MeasureReport.group.stratifier.stratum.population.count
Element IdMeasureReport.group.stratifier.stratum.population.count
Definition

The number of members of the population in this stratum.

Short DisplaySize of the population
Cardinality0..1
Typeinteger
Summaryfalse
MeasureReport.group.stratifier.stratum.population.subjectResults
Element IdMeasureReport.group.stratifier.stratum.population.subjectResults
Definition

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

Short DisplayFor subject-list reports, the subject results in this population
Cardinality0..1
TypeReference(List)
Summaryfalse
MeasureReport.group.stratifier.stratum.measureScore[x]
Element IdMeasureReport.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 DisplayWhat score this stratum achieved
Cardinality0..1
TypeQuantity|dateTime|CodeableConcept|Period|Range|Duration
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
MeasureReport.evaluatedResource
Element IdMeasureReport.evaluatedResource
Definition

A reference to a Resource that was used in the calculation of this measure.

Short DisplayWhat data was used to calculate the measure score
Cardinality0..*
TypeReference(Any)
Summaryfalse