This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Clinical Quality Information Work Group | Maturity Level: 2 | Trial Use | Compartments: Patient |
The MeasureReport resource contains the results of evaluating a measure.
This resource is an event resource from a FHIR workflow perspective - see Workflow, specifically Event.
The MeasureReport resource represents the results of evaluating a measure for a specific patient or group of patients. The $evaluate-measure
operation of the Measure resource is defined to return a MeasureReport. The resource is capable of representing three different levels of report: patient-level, patient-list, and summary.
The resource draws requirements from the HL7 CDA R2 Implementation Guide: Quality Reporting Document Architecture - Category 1 (QRDA I) DSTU Release 3 (US Realm) and the HL7 Implementation Guide for CDA Release 2: Quality Reporting Document Architecture - Category III (QRDA III), DSTU Release 1 implementation guides.
Note that this resource is a special case of the more general notion of a query evaluation result. However, because the general case requires the ability to represent arbitrary content, this resource uses a simple indicator structure to describe population sizes for each population type defined in the measure. The intent is to be able to represent the more general case as well, either by generalizing this resource, or by making this structure a profile of a more general resource, and we are actively seeking comments about what approaches might be taken to achieve that aim.
Although the MeasureReport is conceptually an Observation, there is enough specific information required to support the quality reporting use case to warrant a separate resource.
The resource is differentiated from a general purpose query result because it communicates specific information related to quality measurement evaluation that would be difficult to convey generally without imposing some other structure on top of the general results.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MeasureReport | DomainResource | Results of a measure evaluation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
identifier | Σ | 0..1 | Identifier | Additional identifier for the Report |
status | ?!Σ | 1..1 | code | complete | pending | error MeasureReportStatus (Required) |
type | Σ | 1..1 | code | individual | patient-list | summary MeasureReportType (Required) |
measure | Σ | 1..1 | Reference(Measure) | What measure was evaluated |
patient | Σ | 0..1 | Reference(Patient) | What patient the report is for |
date | Σ | 0..1 | dateTime | When the report was generated |
reportingOrganization | Σ | 0..1 | Reference(Organization) | Who is reporting the data |
period | Σ | 1..1 | Period | What period the report covers |
group | 0..* | BackboneElement | Measure results for each group | |
identifier | 1..1 | Identifier | What group of the measure | |
population | 0..* | BackboneElement | The populations in the group | |
identifier | Σ | 0..1 | Identifier | Population identifier as defined in the measure |
code | Σ | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score MeasurePopulationType (Extensible) |
count | 0..1 | integer | Size of the population | |
patients | 0..1 | Reference(List) | For patient-list reports, the patients in this population | |
measureScore | Σ | 0..1 | decimal | What score this group achieved |
stratifier | 0..* | BackboneElement | Stratification results | |
identifier | 0..1 | Identifier | What stratifier of the group | |
stratum | 0..* | BackboneElement | Stratum results, one for each unique value in the stratifier | |
value | 1..1 | string | The stratum value, e.g. male | |
population | 0..* | BackboneElement | Population results in this stratum | |
identifier | Σ | 0..1 | Identifier | Population identifier as defined in the measure |
code | Σ | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score MeasurePopulationType (Extensible) |
count | 0..1 | integer | Size of the population | |
patients | 0..1 | Reference(List) | For patient-list reports, the patients in this population | |
measureScore | Σ | 0..1 | decimal | What score this stratum achieved |
evaluatedResources | 0..1 | Reference(Bundle) | What data was evaluated to produce the measure score | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<MeasureReport xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..1 Identifier Additional identifier for the Report --></identifier> <status value="[code]"/><!-- 1..1 complete | pending | error --> <type value="[code]"/><!-- 1..1 individual | patient-list | summary --> <measure><!-- 1..1 Reference(Measure) What measure was evaluated --></measure> <patient><!-- 0..1 Reference(Patient) What patient the report is for --></patient> <date value="[dateTime]"/><!-- 0..1 When the report was generated --> <reportingOrganization><!-- 0..1 Reference(Organization) Who is reporting the data --></reportingOrganization> <period><!-- 1..1 Period What period the report covers --></period> <group> <!-- 0..* Measure results for each group --> <identifier><!-- 1..1 Identifier What group of the measure --></identifier> <population> <!-- 0..* The populations in the group --> <identifier><!-- 0..1 Identifier Population identifier as defined in the measure --></identifier> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score --></code> <count value="[integer]"/><!-- 0..1 Size of the population --> <patients><!-- 0..1 Reference(List) For patient-list reports, the patients in this population --></patients> </population> <measureScore value="[decimal]"/><!-- 0..1 What score this group achieved --> <stratifier> <!-- 0..* Stratification results --> <identifier><!-- 0..1 Identifier What stratifier of the group --></identifier> <stratum> <!-- 0..* Stratum results, one for each unique value in the stratifier --> <value value="[string]"/><!-- 1..1 The stratum value, e.g. male --> <population> <!-- 0..* Population results in this stratum --> <identifier><!-- 0..1 Identifier Population identifier as defined in the measure --></identifier> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score --></code> <count value="[integer]"/><!-- 0..1 Size of the population --> <patients><!-- 0..1 Reference(List) For patient-list reports, the patients in this population --></patients> </population> <measureScore value="[decimal]"/><!-- 0..1 What score this stratum achieved --> </stratum> </stratifier> </group> <evaluatedResources><!-- 0..1 Reference(Bundle) What data was evaluated to produce the measure score --></evaluatedResources> </MeasureReport>
JSON Template
{ "resourceType" : "MeasureReport", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : { Identifier }, // Additional identifier for the Report "status" : "<code>", // R! complete | pending | error "type" : "<code>", // R! individual | patient-list | summary "measure" : { Reference(Measure) }, // R! What measure was evaluated "patient" : { Reference(Patient) }, // What patient the report is for "date" : "<dateTime>", // When the report was generated "reportingOrganization" : { Reference(Organization) }, // Who is reporting the data "period" : { Period }, // R! What period the report covers "group" : [{ // Measure results for each group "identifier" : { Identifier }, // R! What group of the measure "population" : [{ // The populations in the group "identifier" : { Identifier }, // Population identifier as defined in the measure "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score "count" : <integer>, // Size of the population "patients" : { Reference(List) } // For patient-list reports, the patients in this population }], "measureScore" : <decimal>, // What score this group achieved "stratifier" : [{ // Stratification results "identifier" : { Identifier }, // What stratifier of the group "stratum" : [{ // Stratum results, one for each unique value in the stratifier "value" : "<string>", // R! The stratum value, e.g. male "population" : [{ // Population results in this stratum "identifier" : { Identifier }, // Population identifier as defined in the measure "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score "count" : <integer>, // Size of the population "patients" : { Reference(List) } // For patient-list reports, the patients in this population }], "measureScore" : <decimal> // What score this stratum achieved }] }] }], "evaluatedResources" : { Reference(Bundle) } // What data was evaluated to produce the measure score }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:MeasureReport; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:MeasureReport.identifier [ Identifier ]; # 0..1 Additional identifier for the Report fhir:MeasureReport.status [ code ]; # 1..1 complete | pending | error fhir:MeasureReport.type [ code ]; # 1..1 individual | patient-list | summary fhir:MeasureReport.measure [ Reference(Measure) ]; # 1..1 What measure was evaluated fhir:MeasureReport.patient [ Reference(Patient) ]; # 0..1 What patient the report is for fhir:MeasureReport.date [ dateTime ]; # 0..1 When the report was generated fhir:MeasureReport.reportingOrganization [ Reference(Organization) ]; # 0..1 Who is reporting the data fhir:MeasureReport.period [ Period ]; # 1..1 What period the report covers fhir:MeasureReport.group [ # 0..* Measure results for each group fhir:MeasureReport.group.identifier [ Identifier ]; # 1..1 What group of the measure fhir:MeasureReport.group.population [ # 0..* The populations in the group fhir:MeasureReport.group.population.identifier [ Identifier ]; # 0..1 Population identifier as defined in the measure fhir:MeasureReport.group.population.code [ CodeableConcept ]; # 0..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score fhir:MeasureReport.group.population.count [ integer ]; # 0..1 Size of the population fhir:MeasureReport.group.population.patients [ Reference(List) ]; # 0..1 For patient-list reports, the patients in this population ], ...; fhir:MeasureReport.group.measureScore [ decimal ]; # 0..1 What score this group achieved fhir:MeasureReport.group.stratifier [ # 0..* Stratification results fhir:MeasureReport.group.stratifier.identifier [ Identifier ]; # 0..1 What stratifier of the group fhir:MeasureReport.group.stratifier.stratum [ # 0..* Stratum results, one for each unique value in the stratifier fhir:MeasureReport.group.stratifier.stratum.value [ string ]; # 1..1 The stratum value, e.g. male fhir:MeasureReport.group.stratifier.stratum.population [ # 0..* Population results in this stratum fhir:MeasureReport.group.stratifier.stratum.population.identifier [ Identifier ]; # 0..1 Population identifier as defined in the measure fhir:MeasureReport.group.stratifier.stratum.population.code [ CodeableConcept ]; # 0..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score fhir:MeasureReport.group.stratifier.stratum.population.count [ integer ]; # 0..1 Size of the population fhir:MeasureReport.group.stratifier.stratum.population.patients [ Reference(List) ]; # 0..1 For patient-list reports, the patients in this population ], ...; fhir:MeasureReport.group.stratifier.stratum.measureScore [ decimal ]; # 0..1 What score this stratum achieved ], ...; ], ...; ], ...; fhir:MeasureReport.evaluatedResources [ Reference(Bundle) ]; # 0..1 What data was evaluated to produce the measure score ]
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MeasureReport | DomainResource | Results of a measure evaluation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
identifier | Σ | 0..1 | Identifier | Additional identifier for the Report |
status | ?!Σ | 1..1 | code | complete | pending | error MeasureReportStatus (Required) |
type | Σ | 1..1 | code | individual | patient-list | summary MeasureReportType (Required) |
measure | Σ | 1..1 | Reference(Measure) | What measure was evaluated |
patient | Σ | 0..1 | Reference(Patient) | What patient the report is for |
date | Σ | 0..1 | dateTime | When the report was generated |
reportingOrganization | Σ | 0..1 | Reference(Organization) | Who is reporting the data |
period | Σ | 1..1 | Period | What period the report covers |
group | 0..* | BackboneElement | Measure results for each group | |
identifier | 1..1 | Identifier | What group of the measure | |
population | 0..* | BackboneElement | The populations in the group | |
identifier | Σ | 0..1 | Identifier | Population identifier as defined in the measure |
code | Σ | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score MeasurePopulationType (Extensible) |
count | 0..1 | integer | Size of the population | |
patients | 0..1 | Reference(List) | For patient-list reports, the patients in this population | |
measureScore | Σ | 0..1 | decimal | What score this group achieved |
stratifier | 0..* | BackboneElement | Stratification results | |
identifier | 0..1 | Identifier | What stratifier of the group | |
stratum | 0..* | BackboneElement | Stratum results, one for each unique value in the stratifier | |
value | 1..1 | string | The stratum value, e.g. male | |
population | 0..* | BackboneElement | Population results in this stratum | |
identifier | Σ | 0..1 | Identifier | Population identifier as defined in the measure |
code | Σ | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score MeasurePopulationType (Extensible) |
count | 0..1 | integer | Size of the population | |
patients | 0..1 | Reference(List) | For patient-list reports, the patients in this population | |
measureScore | Σ | 0..1 | decimal | What score this stratum achieved |
evaluatedResources | 0..1 | Reference(Bundle) | What data was evaluated to produce the measure score | |
Documentation for this format |
XML Template
<MeasureReport xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..1 Identifier Additional identifier for the Report --></identifier> <status value="[code]"/><!-- 1..1 complete | pending | error --> <type value="[code]"/><!-- 1..1 individual | patient-list | summary --> <measure><!-- 1..1 Reference(Measure) What measure was evaluated --></measure> <patient><!-- 0..1 Reference(Patient) What patient the report is for --></patient> <date value="[dateTime]"/><!-- 0..1 When the report was generated --> <reportingOrganization><!-- 0..1 Reference(Organization) Who is reporting the data --></reportingOrganization> <period><!-- 1..1 Period What period the report covers --></period> <group> <!-- 0..* Measure results for each group --> <identifier><!-- 1..1 Identifier What group of the measure --></identifier> <population> <!-- 0..* The populations in the group --> <identifier><!-- 0..1 Identifier Population identifier as defined in the measure --></identifier> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score --></code> <count value="[integer]"/><!-- 0..1 Size of the population --> <patients><!-- 0..1 Reference(List) For patient-list reports, the patients in this population --></patients> </population> <measureScore value="[decimal]"/><!-- 0..1 What score this group achieved --> <stratifier> <!-- 0..* Stratification results --> <identifier><!-- 0..1 Identifier What stratifier of the group --></identifier> <stratum> <!-- 0..* Stratum results, one for each unique value in the stratifier --> <value value="[string]"/><!-- 1..1 The stratum value, e.g. male --> <population> <!-- 0..* Population results in this stratum --> <identifier><!-- 0..1 Identifier Population identifier as defined in the measure --></identifier> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score --></code> <count value="[integer]"/><!-- 0..1 Size of the population --> <patients><!-- 0..1 Reference(List) For patient-list reports, the patients in this population --></patients> </population> <measureScore value="[decimal]"/><!-- 0..1 What score this stratum achieved --> </stratum> </stratifier> </group> <evaluatedResources><!-- 0..1 Reference(Bundle) What data was evaluated to produce the measure score --></evaluatedResources> </MeasureReport>
JSON Template
{ "resourceType" : "MeasureReport", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : { Identifier }, // Additional identifier for the Report "status" : "<code>", // R! complete | pending | error "type" : "<code>", // R! individual | patient-list | summary "measure" : { Reference(Measure) }, // R! What measure was evaluated "patient" : { Reference(Patient) }, // What patient the report is for "date" : "<dateTime>", // When the report was generated "reportingOrganization" : { Reference(Organization) }, // Who is reporting the data "period" : { Period }, // R! What period the report covers "group" : [{ // Measure results for each group "identifier" : { Identifier }, // R! What group of the measure "population" : [{ // The populations in the group "identifier" : { Identifier }, // Population identifier as defined in the measure "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score "count" : <integer>, // Size of the population "patients" : { Reference(List) } // For patient-list reports, the patients in this population }], "measureScore" : <decimal>, // What score this group achieved "stratifier" : [{ // Stratification results "identifier" : { Identifier }, // What stratifier of the group "stratum" : [{ // Stratum results, one for each unique value in the stratifier "value" : "<string>", // R! The stratum value, e.g. male "population" : [{ // Population results in this stratum "identifier" : { Identifier }, // Population identifier as defined in the measure "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score "count" : <integer>, // Size of the population "patients" : { Reference(List) } // For patient-list reports, the patients in this population }], "measureScore" : <decimal> // What score this stratum achieved }] }] }], "evaluatedResources" : { Reference(Bundle) } // What data was evaluated to produce the measure score }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:MeasureReport; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:MeasureReport.identifier [ Identifier ]; # 0..1 Additional identifier for the Report fhir:MeasureReport.status [ code ]; # 1..1 complete | pending | error fhir:MeasureReport.type [ code ]; # 1..1 individual | patient-list | summary fhir:MeasureReport.measure [ Reference(Measure) ]; # 1..1 What measure was evaluated fhir:MeasureReport.patient [ Reference(Patient) ]; # 0..1 What patient the report is for fhir:MeasureReport.date [ dateTime ]; # 0..1 When the report was generated fhir:MeasureReport.reportingOrganization [ Reference(Organization) ]; # 0..1 Who is reporting the data fhir:MeasureReport.period [ Period ]; # 1..1 What period the report covers fhir:MeasureReport.group [ # 0..* Measure results for each group fhir:MeasureReport.group.identifier [ Identifier ]; # 1..1 What group of the measure fhir:MeasureReport.group.population [ # 0..* The populations in the group fhir:MeasureReport.group.population.identifier [ Identifier ]; # 0..1 Population identifier as defined in the measure fhir:MeasureReport.group.population.code [ CodeableConcept ]; # 0..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score fhir:MeasureReport.group.population.count [ integer ]; # 0..1 Size of the population fhir:MeasureReport.group.population.patients [ Reference(List) ]; # 0..1 For patient-list reports, the patients in this population ], ...; fhir:MeasureReport.group.measureScore [ decimal ]; # 0..1 What score this group achieved fhir:MeasureReport.group.stratifier [ # 0..* Stratification results fhir:MeasureReport.group.stratifier.identifier [ Identifier ]; # 0..1 What stratifier of the group fhir:MeasureReport.group.stratifier.stratum [ # 0..* Stratum results, one for each unique value in the stratifier fhir:MeasureReport.group.stratifier.stratum.value [ string ]; # 1..1 The stratum value, e.g. male fhir:MeasureReport.group.stratifier.stratum.population [ # 0..* Population results in this stratum fhir:MeasureReport.group.stratifier.stratum.population.identifier [ Identifier ]; # 0..1 Population identifier as defined in the measure fhir:MeasureReport.group.stratifier.stratum.population.code [ CodeableConcept ]; # 0..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score fhir:MeasureReport.group.stratifier.stratum.population.count [ integer ]; # 0..1 Size of the population fhir:MeasureReport.group.stratifier.stratum.population.patients [ Reference(List) ]; # 0..1 For patient-list reports, the patients in this population ], ...; fhir:MeasureReport.group.stratifier.stratum.measureScore [ decimal ]; # 0..1 What score this stratum achieved ], ...; ], ...; ], ...; fhir:MeasureReport.evaluatedResources [ Reference(Bundle) ]; # 0..1 What data was evaluated to produce the measure score ]
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
Path | Definition | Type | Reference |
---|---|---|---|
MeasureReport.status | The status of the measure report | Required | MeasureReportStatus |
MeasureReport.type | The type of the measure report | Required | MeasureReportType |
MeasureReport.group.population.code MeasureReport.group.stratifier.stratum.population.code | The type of population (e.g. initial, numerator, denominator, etc.) | Extensible | MeasurePopulationType |
Although the MeasureReport resource does define search parameters, it is up to the individual measure evaluation service whether or not historical records of measure evaluation requests are preserved. A service may not support searching on MeasureReports at all, or it may support searching only for a pre-defined expiration period. The search parameters are defined to provide consumers with a consistent interface to searching if it is available for a specific service implementation. In any case, services should detail the support they do provide using a CapabilityStatement.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
identifier | token | External identifier of the measure report to be returned | MeasureReport.identifier | |
patient | reference | The identity of a patient to search for individual measure report results for | MeasureReport.patient (Patient) | |
status | token | The status of the measure report | MeasureReport.status |