This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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: 0 | Compartments: Patient |
The MeasureReport resource contains the results of evaluating a measure.
This resource is a draft proposal for use as part of an approach to Clinical Quality within FHIR, and is documented as part of the Clinical Reasoning module.
The _evaluate_ 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 is based on 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 | ||
measure | Σ | 1..1 | Reference(Measure) | Measure that was evaluated |
type | Σ | 1..1 | code | individual | patient-list | summary MeasureReportType (Required) |
patient | Σ | 0..1 | Reference(Patient) | Optional Patient |
period | Σ | 1..1 | Period | Reporting period |
status | Σ | 1..1 | code | complete | pending | error MeasureReportStatus (Required) |
date | Σ | 0..1 | dateTime | Date the report was generated |
reportingOrganization | Σ | 0..1 | Reference(Organization) | Reporting Organization |
group | 0..* | BackboneElement | Measure results for each group | |
identifier | 1..1 | Identifier | Identifier of the population group being reported | |
population | 0..* | BackboneElement | The populations in the group | |
type | 1..1 | code | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score MeasurePopulationType (Required) | |
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 | The measure score | |
stratifier | 0..* | BackboneElement | Stratification results | |
identifier | 1..1 | Identifier | Identifier of the stratifier | |
group | 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 | |
type | 1..1 | code | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score MeasurePopulationType (Required) | |
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 | The measure score | |
supplementalData | 0..* | BackboneElement | Supplemental data elements for the measure | |
identifier | 1..1 | Identifier | Identifier of the supplemental data element | |
group | 0..* | BackboneElement | Supplemental data results, one for each unique supplemental data value | |
value | 1..1 | string | The data value, e.g. male | |
count | 0..1 | integer | Number of members in the group | |
patients | 0..1 | Reference(List) | For patient-list reports, the patients in this population | |
evaluatedResources | 0..1 | Reference(Bundle) | Evaluated Resources | |
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 --> <measure><!-- 1..1 Reference(Measure) Measure that was evaluated --></measure> <type value="[code]"/><!-- 1..1 individual | patient-list | summary --> <patient><!-- 0..1 Reference(Patient) Optional Patient --></patient> <period><!-- 1..1 Period Reporting period --></period> <status value="[code]"/><!-- 1..1 complete | pending | error --> <date value="[dateTime]"/><!-- 0..1 Date the report was generated --> <reportingOrganization><!-- 0..1 Reference(Organization) Reporting Organization --></reportingOrganization> <group> <!-- 0..* Measure results for each group --> <identifier><!-- 1..1 Identifier Identifier of the population group being reported --></identifier> <population> <!-- 0..* The populations in the group --> <type value="[code]"/><!-- 1..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score --> <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 The measure score --> <stratifier> <!-- 0..* Stratification results --> <identifier><!-- 1..1 Identifier Identifier of the stratifier --></identifier> <group> <!-- 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 --> <type value="[code]"/><!-- 1..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score --> <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 The measure score --> </group> </stratifier> <supplementalData> <!-- 0..* Supplemental data elements for the measure --> <identifier><!-- 1..1 Identifier Identifier of the supplemental data element --></identifier> <group> <!-- 0..* Supplemental data results, one for each unique supplemental data value --> <value value="[string]"/><!-- 1..1 The data value, e.g. male --> <count value="[integer]"/><!-- 0..1 Number of members in the group --> <patients><!-- 0..1 Reference(List) For patient-list reports, the patients in this population --></patients> </group> </supplementalData> </group> <evaluatedResources><!-- 0..1 Reference(Bundle) Evaluated Resources --></evaluatedResources> </MeasureReport>
JSON Template
{ "resourceType" : "MeasureReport", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "measure" : { Reference(Measure) }, // R! Measure that was evaluated "type" : "<code>", // R! individual | patient-list | summary "patient" : { Reference(Patient) }, // Optional Patient "period" : { Period }, // R! Reporting period "status" : "<code>", // R! complete | pending | error "date" : "<dateTime>", // Date the report was generated "reportingOrganization" : { Reference(Organization) }, // Reporting Organization "group" : [{ // Measure results for each group "identifier" : { Identifier }, // R! Identifier of the population group being reported "population" : [{ // The populations in the group "type" : "<code>", // R! 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>, // The measure score "stratifier" : [{ // Stratification results "identifier" : { Identifier }, // R! Identifier of the stratifier "group" : [{ // 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 "type" : "<code>", // R! 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> // The measure score }] }], "supplementalData" : [{ // Supplemental data elements for the measure "identifier" : { Identifier }, // R! Identifier of the supplemental data element "group" : [{ // Supplemental data results, one for each unique supplemental data value "value" : "<string>", // R! The data value, e.g. male "count" : <integer>, // Number of members in the group "patients" : { Reference(List) } // For patient-list reports, the patients in this population }] }] }], "evaluatedResources" : { Reference(Bundle) } // Evaluated Resources }
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.measure [ Reference(Measure) ]; # 1..1 Measure that was evaluated fhir:MeasureReport.type [ code ]; # 1..1 individual | patient-list | summary fhir:MeasureReport.patient [ Reference(Patient) ]; # 0..1 Optional Patient fhir:MeasureReport.period [ Period ]; # 1..1 Reporting period fhir:MeasureReport.status [ code ]; # 1..1 complete | pending | error fhir:MeasureReport.date [ dateTime ]; # 0..1 Date the report was generated fhir:MeasureReport.reportingOrganization [ Reference(Organization) ]; # 0..1 Reporting Organization fhir:MeasureReport.group [ # 0..* Measure results for each group fhir:MeasureReport.group.identifier [ Identifier ]; # 1..1 Identifier of the population group being reported fhir:MeasureReport.group.population [ # 0..* The populations in the group fhir:MeasureReport.group.population.type [ code ]; # 1..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 The measure score fhir:MeasureReport.group.stratifier [ # 0..* Stratification results fhir:MeasureReport.group.stratifier.identifier [ Identifier ]; # 1..1 Identifier of the stratifier fhir:MeasureReport.group.stratifier.group [ # 0..* Stratum results, one for each unique value in the stratifier fhir:MeasureReport.group.stratifier.group.value [ string ]; # 1..1 The stratum value, e.g. male fhir:MeasureReport.group.stratifier.group.population [ # 0..* Population results in this stratum fhir:MeasureReport.group.stratifier.group.population.type [ code ]; # 1..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score fhir:MeasureReport.group.stratifier.group.population.count [ integer ]; # 0..1 Size of the population fhir:MeasureReport.group.stratifier.group.population.patients [ Reference(List) ]; # 0..1 For patient-list reports, the patients in this population ], ...; fhir:MeasureReport.group.stratifier.group.measureScore [ decimal ]; # 0..1 The measure score ], ...; ], ...; fhir:MeasureReport.group.supplementalData [ # 0..* Supplemental data elements for the measure fhir:MeasureReport.group.supplementalData.identifier [ Identifier ]; # 1..1 Identifier of the supplemental data element fhir:MeasureReport.group.supplementalData.group [ # 0..* Supplemental data results, one for each unique supplemental data value fhir:MeasureReport.group.supplementalData.group.value [ string ]; # 1..1 The data value, e.g. male fhir:MeasureReport.group.supplementalData.group.count [ integer ]; # 0..1 Number of members in the group fhir:MeasureReport.group.supplementalData.group.patients [ Reference(List) ]; # 0..1 For patient-list reports, the patients in this population ], ...; ], ...; ], ...; fhir:MeasureReport.evaluatedResources [ Reference(Bundle) ]; # 0..1 Evaluated Resources ]
Changes since DSTU2
This resource did not exist in Release 2
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MeasureReport | DomainResource | Results of a measure evaluation | ||
measure | Σ | 1..1 | Reference(Measure) | Measure that was evaluated |
type | Σ | 1..1 | code | individual | patient-list | summary MeasureReportType (Required) |
patient | Σ | 0..1 | Reference(Patient) | Optional Patient |
period | Σ | 1..1 | Period | Reporting period |
status | Σ | 1..1 | code | complete | pending | error MeasureReportStatus (Required) |
date | Σ | 0..1 | dateTime | Date the report was generated |
reportingOrganization | Σ | 0..1 | Reference(Organization) | Reporting Organization |
group | 0..* | BackboneElement | Measure results for each group | |
identifier | 1..1 | Identifier | Identifier of the population group being reported | |
population | 0..* | BackboneElement | The populations in the group | |
type | 1..1 | code | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score MeasurePopulationType (Required) | |
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 | The measure score | |
stratifier | 0..* | BackboneElement | Stratification results | |
identifier | 1..1 | Identifier | Identifier of the stratifier | |
group | 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 | |
type | 1..1 | code | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score MeasurePopulationType (Required) | |
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 | The measure score | |
supplementalData | 0..* | BackboneElement | Supplemental data elements for the measure | |
identifier | 1..1 | Identifier | Identifier of the supplemental data element | |
group | 0..* | BackboneElement | Supplemental data results, one for each unique supplemental data value | |
value | 1..1 | string | The data value, e.g. male | |
count | 0..1 | integer | Number of members in the group | |
patients | 0..1 | Reference(List) | For patient-list reports, the patients in this population | |
evaluatedResources | 0..1 | Reference(Bundle) | Evaluated Resources | |
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 --> <measure><!-- 1..1 Reference(Measure) Measure that was evaluated --></measure> <type value="[code]"/><!-- 1..1 individual | patient-list | summary --> <patient><!-- 0..1 Reference(Patient) Optional Patient --></patient> <period><!-- 1..1 Period Reporting period --></period> <status value="[code]"/><!-- 1..1 complete | pending | error --> <date value="[dateTime]"/><!-- 0..1 Date the report was generated --> <reportingOrganization><!-- 0..1 Reference(Organization) Reporting Organization --></reportingOrganization> <group> <!-- 0..* Measure results for each group --> <identifier><!-- 1..1 Identifier Identifier of the population group being reported --></identifier> <population> <!-- 0..* The populations in the group --> <type value="[code]"/><!-- 1..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score --> <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 The measure score --> <stratifier> <!-- 0..* Stratification results --> <identifier><!-- 1..1 Identifier Identifier of the stratifier --></identifier> <group> <!-- 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 --> <type value="[code]"/><!-- 1..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score --> <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 The measure score --> </group> </stratifier> <supplementalData> <!-- 0..* Supplemental data elements for the measure --> <identifier><!-- 1..1 Identifier Identifier of the supplemental data element --></identifier> <group> <!-- 0..* Supplemental data results, one for each unique supplemental data value --> <value value="[string]"/><!-- 1..1 The data value, e.g. male --> <count value="[integer]"/><!-- 0..1 Number of members in the group --> <patients><!-- 0..1 Reference(List) For patient-list reports, the patients in this population --></patients> </group> </supplementalData> </group> <evaluatedResources><!-- 0..1 Reference(Bundle) Evaluated Resources --></evaluatedResources> </MeasureReport>
JSON Template
{ "resourceType" : "MeasureReport", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "measure" : { Reference(Measure) }, // R! Measure that was evaluated "type" : "<code>", // R! individual | patient-list | summary "patient" : { Reference(Patient) }, // Optional Patient "period" : { Period }, // R! Reporting period "status" : "<code>", // R! complete | pending | error "date" : "<dateTime>", // Date the report was generated "reportingOrganization" : { Reference(Organization) }, // Reporting Organization "group" : [{ // Measure results for each group "identifier" : { Identifier }, // R! Identifier of the population group being reported "population" : [{ // The populations in the group "type" : "<code>", // R! 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>, // The measure score "stratifier" : [{ // Stratification results "identifier" : { Identifier }, // R! Identifier of the stratifier "group" : [{ // 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 "type" : "<code>", // R! 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> // The measure score }] }], "supplementalData" : [{ // Supplemental data elements for the measure "identifier" : { Identifier }, // R! Identifier of the supplemental data element "group" : [{ // Supplemental data results, one for each unique supplemental data value "value" : "<string>", // R! The data value, e.g. male "count" : <integer>, // Number of members in the group "patients" : { Reference(List) } // For patient-list reports, the patients in this population }] }] }], "evaluatedResources" : { Reference(Bundle) } // Evaluated Resources }
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.measure [ Reference(Measure) ]; # 1..1 Measure that was evaluated fhir:MeasureReport.type [ code ]; # 1..1 individual | patient-list | summary fhir:MeasureReport.patient [ Reference(Patient) ]; # 0..1 Optional Patient fhir:MeasureReport.period [ Period ]; # 1..1 Reporting period fhir:MeasureReport.status [ code ]; # 1..1 complete | pending | error fhir:MeasureReport.date [ dateTime ]; # 0..1 Date the report was generated fhir:MeasureReport.reportingOrganization [ Reference(Organization) ]; # 0..1 Reporting Organization fhir:MeasureReport.group [ # 0..* Measure results for each group fhir:MeasureReport.group.identifier [ Identifier ]; # 1..1 Identifier of the population group being reported fhir:MeasureReport.group.population [ # 0..* The populations in the group fhir:MeasureReport.group.population.type [ code ]; # 1..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 The measure score fhir:MeasureReport.group.stratifier [ # 0..* Stratification results fhir:MeasureReport.group.stratifier.identifier [ Identifier ]; # 1..1 Identifier of the stratifier fhir:MeasureReport.group.stratifier.group [ # 0..* Stratum results, one for each unique value in the stratifier fhir:MeasureReport.group.stratifier.group.value [ string ]; # 1..1 The stratum value, e.g. male fhir:MeasureReport.group.stratifier.group.population [ # 0..* Population results in this stratum fhir:MeasureReport.group.stratifier.group.population.type [ code ]; # 1..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score fhir:MeasureReport.group.stratifier.group.population.count [ integer ]; # 0..1 Size of the population fhir:MeasureReport.group.stratifier.group.population.patients [ Reference(List) ]; # 0..1 For patient-list reports, the patients in this population ], ...; fhir:MeasureReport.group.stratifier.group.measureScore [ decimal ]; # 0..1 The measure score ], ...; ], ...; fhir:MeasureReport.group.supplementalData [ # 0..* Supplemental data elements for the measure fhir:MeasureReport.group.supplementalData.identifier [ Identifier ]; # 1..1 Identifier of the supplemental data element fhir:MeasureReport.group.supplementalData.group [ # 0..* Supplemental data results, one for each unique supplemental data value fhir:MeasureReport.group.supplementalData.group.value [ string ]; # 1..1 The data value, e.g. male fhir:MeasureReport.group.supplementalData.group.count [ integer ]; # 0..1 Number of members in the group fhir:MeasureReport.group.supplementalData.group.patients [ Reference(List) ]; # 0..1 For patient-list reports, the patients in this population ], ...; ], ...; ], ...; fhir:MeasureReport.evaluatedResources [ Reference(Bundle) ]; # 0..1 Evaluated Resources ]
Changes since DSTU2
This resource did not exist in Release 2
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),
Path | Definition | Type | Reference |
---|---|---|---|
MeasureReport.type | The type of the measure report | Required | MeasureReportType |
MeasureReport.status | The status of the measure report | Required | MeasureReportStatus |
MeasureReport.group.population.type MeasureReport.group.stratifier.group.population.type | The type of population (e.g. initial, numerator, denominator, etc.) | Required | MeasurePopulationType |
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 | Paths | In Common |
patient | reference | The identity of a patient to search for individual measure report results for | MeasureReport.patient (Patient) |