This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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: 3 | Trial Use | Security Category: Business | Compartments: Patient |
The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
The MeasureReport resource represents the results of calculating a measure for a specific subject or group of subjects. 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: individual, subject-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.
For a detailed discussion of how to use the Measure and MeasureReport resources, refer to the Quality Reporting topic.
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.
No references for this Resource.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MeasureReport | TU | DomainResource | Results of a measure evaluation + Rule: Measure Reports used for data collection SHALL NOT communicate group and score information + Rule: Stratifiers SHALL be either a single criteria or a set of criteria components Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..* | Identifier | Additional identifier for the MeasureReport |
status | ?!Σ | 1..1 | code | complete | pending | error MeasureReportStatus (Required) |
type | ΣC | 1..1 | code | individual | subject-list | summary | data-exchange MeasureReportType (Required) |
dataUpdateType | ?!Σ | 0..1 | code | incremental | snapshot Submit Data Update Type (Required) |
measure | Σ | 0..1 | canonical(Measure) | What measure was calculated |
subject | Σ | 0..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | What individual(s) the report is for |
date | Σ | 0..1 | dateTime | When the report was generated |
reporter | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Group) | Who is reporting the data |
reportingVendor | 0..1 | Reference(Organization) | What vendor prepared the data | |
location | 0..1 | Reference(Location) | Where the reported data is from | |
period | Σ | 1..1 | Period | What period the report covers |
inputParameters | 0..1 | Reference(Parameters) | What parameters were provided to the report | |
scoring | ?!Σ | 0..1 | CodeableConcept | What scoring method (e.g. proportion, ratio, continuous-variable) MeasureScoring (Extensible) |
improvementNotation | ?!Σ | 0..1 | CodeableConcept | increase | decrease MeasureImprovementNotation (Required) |
group | C | 0..* | BackboneElement | Measure results for each group |
code | Σ | 0..1 | CodeableConcept | Meaning of the group MeasureGroupExample (Example) |
population | 0..* | BackboneElement | The populations in the group | |
code | Σ | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) |
count | 0..1 | integer | Size of the population | |
subjectResults | 0..1 | Reference(List) | For subject-list reports, the subject results in this population | |
measureScore[x] | Σ | 0..1 | What score this group achieved | |
measureScoreQuantity | Quantity | |||
measureScoreDateTime | dateTime | |||
measureScoreCodeableConcept | CodeableConcept | |||
measureScorePeriod | Period | |||
measureScoreRange | Range | |||
measureScoreDuration | Duration | |||
stratifier | 0..* | BackboneElement | Stratification results | |
code | 0..1 | CodeableConcept | What stratifier of the group MeasureStratifierExample (Example) | |
stratum | 0..* | BackboneElement | Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components | |
value[x] | 0..1 | The stratum value, e.g. male MeasureReportStratifierValueExample (Example) | ||
valueCodeableConcept | CodeableConcept | |||
valueBoolean | boolean | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueReference | Reference() | |||
component | 0..* | BackboneElement | Stratifier component values | |
code | 1..1 | CodeableConcept | What stratifier component of the group MeasureStratifierExample (Example) | |
value[x] | 1..1 | The stratum component value, e.g. male MeasureReportStratifierValueExample (Example) | ||
valueCodeableConcept | CodeableConcept | |||
valueBoolean | boolean | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueReference | Reference() | |||
population | 0..* | BackboneElement | Population results in this stratum | |
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) | |
count | 0..1 | integer | Size of the population | |
subjectResults | 0..1 | Reference(List) | For subject-list reports, the subject results in this population | |
measureScore[x] | 0..1 | What score this stratum achieved | ||
measureScoreQuantity | Quantity | |||
measureScoreDateTime | dateTime | |||
measureScoreCodeableConcept | CodeableConcept | |||
measureScorePeriod | Period | |||
measureScoreRange | Range | |||
measureScoreDuration | Duration | |||
evaluatedResource | 0..* | Reference(Any) | What data was used to calculate the measure score | |
Documentation for this format |
See the Extensions for this resource
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..* Identifier Additional identifier for the MeasureReport --></identifier> <status value="[code]"/><!-- 1..1 complete | pending | error --> <type value="[code]"/><!-- I 1..1 individual | subject-list | summary | data-exchange --> <dataUpdateType value="[code]"/><!-- 0..1 incremental | snapshot --> <measure><!-- 0..1 canonical(Measure) What measure was calculated --></measure> <subject><!-- 0..1 Reference(CareTeam|Device|Group|HealthcareService|Location| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) What individual(s) the report is for --></subject> <date value="[dateTime]"/><!-- 0..1 When the report was generated --> <reporter><!-- 0..1 Reference(Group|Organization|Practitioner|PractitionerRole) Who is reporting the data --></reporter> <reportingVendor><!-- 0..1 Reference(Organization) What vendor prepared the data --></reportingVendor> <location><!-- 0..1 Reference(Location) Where the reported data is from --></location> <period><!-- 1..1 Period What period the report covers --></period> <inputParameters><!-- 0..1 Reference(Parameters) What parameters were provided to the report --></inputParameters> <scoring><!-- 0..1 CodeableConcept What scoring method (e.g. proportion, ratio, continuous-variable) --></scoring> <improvementNotation><!-- 0..1 CodeableConcept increase | decrease --></improvementNotation> <group> <!-- I 0..* Measure results for each group --> <code><!-- 0..1 CodeableConcept Meaning of the group --></code> <population> <!-- 0..* The populations in the group --> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <count value="[integer]"/><!-- 0..1 Size of the population --> <subjectResults><!-- 0..1 Reference(List) For subject-list reports, the subject results in this population --></subjectResults> </population> <measureScore[x]><!-- 0..1 Quantity|dateTime|CodeableConcept|Period|Range| Duration What score this group achieved --></measureScore[x]> <stratifier> <!-- 0..* Stratification results --> <code><!-- 0..1 CodeableConcept What stratifier of the group --></code> <stratum> <!-- 0..* Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components --> <value[x]><!-- 0..1 CodeableConcept|boolean|Quantity|Range|Reference The stratum value, e.g. male --></value[x]> <component> <!-- 0..* Stratifier component values --> <code><!-- 1..1 CodeableConcept What stratifier component of the group --></code> <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range|Reference The stratum component value, e.g. male --></value[x]> </component> <population> <!-- 0..* Population results in this stratum --> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <count value="[integer]"/><!-- 0..1 Size of the population --> <subjectResults><!-- 0..1 Reference(List) For subject-list reports, the subject results in this population --></subjectResults> </population> <measureScore[x]><!-- 0..1 Quantity|dateTime|CodeableConcept|Period|Range| Duration What score this stratum achieved --></measureScore[x]> </stratum> </stratifier> </group> <evaluatedResource><!-- 0..* Reference(Any) What data was used to calculate the measure score --></evaluatedResource> </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 MeasureReport "status" : "<code>", // R! complete | pending | error "type" : "<code>", // I R! individual | subject-list | summary | data-exchange "dataUpdateType" : "<code>", // incremental | snapshot "measure" : "<canonical(Measure)>", // What measure was calculated "subject" : { Reference(CareTeam|Device|Group|HealthcareService|Location| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }, // What individual(s) the report is for "date" : "<dateTime>", // When the report was generated "reporter" : { Reference(Group|Organization|Practitioner|PractitionerRole) }, // Who is reporting the data "reportingVendor" : { Reference(Organization) }, // What vendor prepared the data "location" : { Reference(Location) }, // Where the reported data is from "period" : { Period }, // R! What period the report covers "inputParameters" : { Reference(Parameters) }, // What parameters were provided to the report "scoring" : { CodeableConcept }, // What scoring method (e.g. proportion, ratio, continuous-variable) "improvementNotation" : { CodeableConcept }, // increase | decrease "group" : [{ // I Measure results for each group "code" : { CodeableConcept }, // Meaning of the group "population" : [{ // The populations in the group "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation "count" : <integer>, // Size of the population "subjectResults" : { Reference(List) } // For subject-list reports, the subject results in this population }], // measureScore[x]: What score this group achieved. One of these 6: "measureScoreQuantity" : { Quantity }, "measureScoreDateTime" : "<dateTime>", "measureScoreCodeableConcept" : { CodeableConcept }, "measureScorePeriod" : { Period }, "measureScoreRange" : { Range }, "measureScoreDuration" : { Duration }, "stratifier" : [{ // Stratification results "code" : { CodeableConcept }, // What stratifier of the group "stratum" : [{ // Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components // value[x]: The stratum value, e.g. male. One of these 5: "valueCodeableConcept" : { CodeableConcept }, "valueBoolean" : <boolean>, "valueQuantity" : { Quantity }, "valueRange" : { Range }, "valueReference" : { Reference }, "component" : [{ // Stratifier component values "code" : { CodeableConcept }, // R! What stratifier component of the group // value[x]: The stratum component value, e.g. male. One of these 5: "valueCodeableConcept" : { CodeableConcept }, "valueBoolean" : <boolean>, "valueQuantity" : { Quantity }, "valueRange" : { Range }, "valueReference" : { Reference } }], "population" : [{ // Population results in this stratum "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation "count" : <integer>, // Size of the population "subjectResults" : { Reference(List) } // For subject-list reports, the subject results in this population }], // measureScore[x]: What score this stratum achieved. One of these 6: "measureScoreQuantity" : { Quantity }, "measureScoreDateTime" : "<dateTime>", "measureScoreCodeableConcept" : { CodeableConcept }, "measureScorePeriod" : { Period }, "measureScoreRange" : { Range }, "measureScoreDuration" : { Duration } }] }] }], "evaluatedResource" : [{ Reference(Any) }] // What data was used to calculate 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..* Additional identifier for the MeasureReport fhir:MeasureReport.status [ code ]; # 1..1 complete | pending | error fhir:MeasureReport.type [ code ]; # 1..1 I individual | subject-list | summary | data-exchange fhir:MeasureReport.dataUpdateType [ code ]; # 0..1 incremental | snapshot fhir:MeasureReport.measure [ canonical(Measure) ]; # 0..1 What measure was calculated fhir:MeasureReport.subject [ Reference(CareTeam|Device|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 What individual(s) the report is for fhir:MeasureReport.date [ dateTime ]; # 0..1 When the report was generated fhir:MeasureReport.reporter [ Reference(Group|Organization|Practitioner|PractitionerRole) ]; # 0..1 Who is reporting the data fhir:MeasureReport.reportingVendor [ Reference(Organization) ]; # 0..1 What vendor prepared the data fhir:MeasureReport.location [ Reference(Location) ]; # 0..1 Where the reported data is from fhir:MeasureReport.period [ Period ]; # 1..1 What period the report covers fhir:MeasureReport.inputParameters [ Reference(Parameters) ]; # 0..1 What parameters were provided to the report fhir:MeasureReport.scoring [ CodeableConcept ]; # 0..1 What scoring method (e.g. proportion, ratio, continuous-variable) fhir:MeasureReport.improvementNotation [ CodeableConcept ]; # 0..1 increase | decrease fhir:MeasureReport.group [ # 0..* I Measure results for each group fhir:MeasureReport.group.code [ CodeableConcept ]; # 0..1 Meaning of the group fhir:MeasureReport.group.population [ # 0..* The populations in the group fhir:MeasureReport.group.population.code [ CodeableConcept ]; # 0..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation fhir:MeasureReport.group.population.count [ integer ]; # 0..1 Size of the population fhir:MeasureReport.group.population.subjectResults [ Reference(List) ]; # 0..1 For subject-list reports, the subject results in this population ], ...; # MeasureReport.group.measureScore[x] : 0..1 What score this group achieved. One of these 6 fhir:MeasureReport.group.measureScoreQuantity [ Quantity ] fhir:MeasureReport.group.measureScoreDateTime [ dateTime ] fhir:MeasureReport.group.measureScoreCodeableConcept [ CodeableConcept ] fhir:MeasureReport.group.measureScorePeriod [ Period ] fhir:MeasureReport.group.measureScoreRange [ Range ] fhir:MeasureReport.group.measureScoreDuration [ Duration ] fhir:MeasureReport.group.stratifier [ # 0..* Stratification results fhir:MeasureReport.group.stratifier.code [ CodeableConcept ]; # 0..1 What stratifier of the group fhir:MeasureReport.group.stratifier.stratum [ # 0..* Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components # MeasureReport.group.stratifier.stratum.value[x] : 0..1 The stratum value, e.g. male. One of these 5 fhir:MeasureReport.group.stratifier.stratum.valueCodeableConcept [ CodeableConcept ] fhir:MeasureReport.group.stratifier.stratum.valueBoolean [ boolean ] fhir:MeasureReport.group.stratifier.stratum.valueQuantity [ Quantity ] fhir:MeasureReport.group.stratifier.stratum.valueRange [ Range ] fhir:MeasureReport.group.stratifier.stratum.valueReference [ Reference ] fhir:MeasureReport.group.stratifier.stratum.component [ # 0..* Stratifier component values fhir:MeasureReport.group.stratifier.stratum.component.code [ CodeableConcept ]; # 1..1 What stratifier component of the group # MeasureReport.group.stratifier.stratum.component.value[x] : 1..1 The stratum component value, e.g. male. One of these 5 fhir:MeasureReport.group.stratifier.stratum.component.valueCodeableConcept [ CodeableConcept ] fhir:MeasureReport.group.stratifier.stratum.component.valueBoolean [ boolean ] fhir:MeasureReport.group.stratifier.stratum.component.valueQuantity [ Quantity ] fhir:MeasureReport.group.stratifier.stratum.component.valueRange [ Range ] fhir:MeasureReport.group.stratifier.stratum.component.valueReference [ Reference ] ], ...; fhir:MeasureReport.group.stratifier.stratum.population [ # 0..* Population results in this stratum 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-observation fhir:MeasureReport.group.stratifier.stratum.population.count [ integer ]; # 0..1 Size of the population fhir:MeasureReport.group.stratifier.stratum.population.subjectResults [ Reference(List) ]; # 0..1 For subject-list reports, the subject results in this population ], ...; # MeasureReport.group.stratifier.stratum.measureScore[x] : 0..1 What score this stratum achieved. One of these 6 fhir:MeasureReport.group.stratifier.stratum.measureScoreQuantity [ Quantity ] fhir:MeasureReport.group.stratifier.stratum.measureScoreDateTime [ dateTime ] fhir:MeasureReport.group.stratifier.stratum.measureScoreCodeableConcept [ CodeableConcept ] fhir:MeasureReport.group.stratifier.stratum.measureScorePeriod [ Period ] fhir:MeasureReport.group.stratifier.stratum.measureScoreRange [ Range ] fhir:MeasureReport.group.stratifier.stratum.measureScoreDuration [ Duration ] ], ...; ], ...; ], ...; fhir:MeasureReport.evaluatedResource [ Reference(Any) ], ... ; # 0..* What data was used to calculate the measure score ]
Changes since R4
MeasureReport | |
MeasureReport.dataUpdateType |
|
MeasureReport.measure |
|
MeasureReport.subject |
|
MeasureReport.reporter |
|
MeasureReport.reportingVendor |
|
MeasureReport.location |
|
MeasureReport.inputParameters |
|
MeasureReport.scoring |
|
MeasureReport.group.measureScore[x] |
|
MeasureReport.group.stratifier.code |
|
MeasureReport.group.stratifier.stratum.value[x] |
|
MeasureReport.group.stratifier.stratum.component.value[x] |
|
MeasureReport.group.stratifier.stratum.measureScore[x] |
|
MeasureReport.group.measureScore |
|
MeasureReport.group.stratifier.stratum.value |
|
MeasureReport.group.stratifier.stratum.component.value |
|
MeasureReport.group.stratifier.stratum.measureScore |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and 3 r3 resources are invalid (0 errors).)
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MeasureReport | TU | DomainResource | Results of a measure evaluation + Rule: Measure Reports used for data collection SHALL NOT communicate group and score information + Rule: Stratifiers SHALL be either a single criteria or a set of criteria components Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..* | Identifier | Additional identifier for the MeasureReport |
status | ?!Σ | 1..1 | code | complete | pending | error MeasureReportStatus (Required) |
type | ΣC | 1..1 | code | individual | subject-list | summary | data-exchange MeasureReportType (Required) |
dataUpdateType | ?!Σ | 0..1 | code | incremental | snapshot Submit Data Update Type (Required) |
measure | Σ | 0..1 | canonical(Measure) | What measure was calculated |
subject | Σ | 0..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | What individual(s) the report is for |
date | Σ | 0..1 | dateTime | When the report was generated |
reporter | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Group) | Who is reporting the data |
reportingVendor | 0..1 | Reference(Organization) | What vendor prepared the data | |
location | 0..1 | Reference(Location) | Where the reported data is from | |
period | Σ | 1..1 | Period | What period the report covers |
inputParameters | 0..1 | Reference(Parameters) | What parameters were provided to the report | |
scoring | ?!Σ | 0..1 | CodeableConcept | What scoring method (e.g. proportion, ratio, continuous-variable) MeasureScoring (Extensible) |
improvementNotation | ?!Σ | 0..1 | CodeableConcept | increase | decrease MeasureImprovementNotation (Required) |
group | C | 0..* | BackboneElement | Measure results for each group |
code | Σ | 0..1 | CodeableConcept | Meaning of the group MeasureGroupExample (Example) |
population | 0..* | BackboneElement | The populations in the group | |
code | Σ | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) |
count | 0..1 | integer | Size of the population | |
subjectResults | 0..1 | Reference(List) | For subject-list reports, the subject results in this population | |
measureScore[x] | Σ | 0..1 | What score this group achieved | |
measureScoreQuantity | Quantity | |||
measureScoreDateTime | dateTime | |||
measureScoreCodeableConcept | CodeableConcept | |||
measureScorePeriod | Period | |||
measureScoreRange | Range | |||
measureScoreDuration | Duration | |||
stratifier | 0..* | BackboneElement | Stratification results | |
code | 0..1 | CodeableConcept | What stratifier of the group MeasureStratifierExample (Example) | |
stratum | 0..* | BackboneElement | Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components | |
value[x] | 0..1 | The stratum value, e.g. male MeasureReportStratifierValueExample (Example) | ||
valueCodeableConcept | CodeableConcept | |||
valueBoolean | boolean | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueReference | Reference() | |||
component | 0..* | BackboneElement | Stratifier component values | |
code | 1..1 | CodeableConcept | What stratifier component of the group MeasureStratifierExample (Example) | |
value[x] | 1..1 | The stratum component value, e.g. male MeasureReportStratifierValueExample (Example) | ||
valueCodeableConcept | CodeableConcept | |||
valueBoolean | boolean | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueReference | Reference() | |||
population | 0..* | BackboneElement | Population results in this stratum | |
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) | |
count | 0..1 | integer | Size of the population | |
subjectResults | 0..1 | Reference(List) | For subject-list reports, the subject results in this population | |
measureScore[x] | 0..1 | What score this stratum achieved | ||
measureScoreQuantity | Quantity | |||
measureScoreDateTime | dateTime | |||
measureScoreCodeableConcept | CodeableConcept | |||
measureScorePeriod | Period | |||
measureScoreRange | Range | |||
measureScoreDuration | Duration | |||
evaluatedResource | 0..* | Reference(Any) | What data was used to calculate the measure score | |
Documentation for this format |
See the Extensions for this resource
XML Template
<MeasureReport xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Additional identifier for the MeasureReport --></identifier> <status value="[code]"/><!-- 1..1 complete | pending | error --> <type value="[code]"/><!-- I 1..1 individual | subject-list | summary | data-exchange --> <dataUpdateType value="[code]"/><!-- 0..1 incremental | snapshot --> <measure><!-- 0..1 canonical(Measure) What measure was calculated --></measure> <subject><!-- 0..1 Reference(CareTeam|Device|Group|HealthcareService|Location| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) What individual(s) the report is for --></subject> <date value="[dateTime]"/><!-- 0..1 When the report was generated --> <reporter><!-- 0..1 Reference(Group|Organization|Practitioner|PractitionerRole) Who is reporting the data --></reporter> <reportingVendor><!-- 0..1 Reference(Organization) What vendor prepared the data --></reportingVendor> <location><!-- 0..1 Reference(Location) Where the reported data is from --></location> <period><!-- 1..1 Period What period the report covers --></period> <inputParameters><!-- 0..1 Reference(Parameters) What parameters were provided to the report --></inputParameters> <scoring><!-- 0..1 CodeableConcept What scoring method (e.g. proportion, ratio, continuous-variable) --></scoring> <improvementNotation><!-- 0..1 CodeableConcept increase | decrease --></improvementNotation> <group> <!-- I 0..* Measure results for each group --> <code><!-- 0..1 CodeableConcept Meaning of the group --></code> <population> <!-- 0..* The populations in the group --> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <count value="[integer]"/><!-- 0..1 Size of the population --> <subjectResults><!-- 0..1 Reference(List) For subject-list reports, the subject results in this population --></subjectResults> </population> <measureScore[x]><!-- 0..1 Quantity|dateTime|CodeableConcept|Period|Range| Duration What score this group achieved --></measureScore[x]> <stratifier> <!-- 0..* Stratification results --> <code><!-- 0..1 CodeableConcept What stratifier of the group --></code> <stratum> <!-- 0..* Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components --> <value[x]><!-- 0..1 CodeableConcept|boolean|Quantity|Range|Reference The stratum value, e.g. male --></value[x]> <component> <!-- 0..* Stratifier component values --> <code><!-- 1..1 CodeableConcept What stratifier component of the group --></code> <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range|Reference The stratum component value, e.g. male --></value[x]> </component> <population> <!-- 0..* Population results in this stratum --> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <count value="[integer]"/><!-- 0..1 Size of the population --> <subjectResults><!-- 0..1 Reference(List) For subject-list reports, the subject results in this population --></subjectResults> </population> <measureScore[x]><!-- 0..1 Quantity|dateTime|CodeableConcept|Period|Range| Duration What score this stratum achieved --></measureScore[x]> </stratum> </stratifier> </group> <evaluatedResource><!-- 0..* Reference(Any) What data was used to calculate the measure score --></evaluatedResource> </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 MeasureReport "status" : "<code>", // R! complete | pending | error "type" : "<code>", // I R! individual | subject-list | summary | data-exchange "dataUpdateType" : "<code>", // incremental | snapshot "measure" : "<canonical(Measure)>", // What measure was calculated "subject" : { Reference(CareTeam|Device|Group|HealthcareService|Location| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }, // What individual(s) the report is for "date" : "<dateTime>", // When the report was generated "reporter" : { Reference(Group|Organization|Practitioner|PractitionerRole) }, // Who is reporting the data "reportingVendor" : { Reference(Organization) }, // What vendor prepared the data "location" : { Reference(Location) }, // Where the reported data is from "period" : { Period }, // R! What period the report covers "inputParameters" : { Reference(Parameters) }, // What parameters were provided to the report "scoring" : { CodeableConcept }, // What scoring method (e.g. proportion, ratio, continuous-variable) "improvementNotation" : { CodeableConcept }, // increase | decrease "group" : [{ // I Measure results for each group "code" : { CodeableConcept }, // Meaning of the group "population" : [{ // The populations in the group "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation "count" : <integer>, // Size of the population "subjectResults" : { Reference(List) } // For subject-list reports, the subject results in this population }], // measureScore[x]: What score this group achieved. One of these 6: "measureScoreQuantity" : { Quantity }, "measureScoreDateTime" : "<dateTime>", "measureScoreCodeableConcept" : { CodeableConcept }, "measureScorePeriod" : { Period }, "measureScoreRange" : { Range }, "measureScoreDuration" : { Duration }, "stratifier" : [{ // Stratification results "code" : { CodeableConcept }, // What stratifier of the group "stratum" : [{ // Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components // value[x]: The stratum value, e.g. male. One of these 5: "valueCodeableConcept" : { CodeableConcept }, "valueBoolean" : <boolean>, "valueQuantity" : { Quantity }, "valueRange" : { Range }, "valueReference" : { Reference }, "component" : [{ // Stratifier component values "code" : { CodeableConcept }, // R! What stratifier component of the group // value[x]: The stratum component value, e.g. male. One of these 5: "valueCodeableConcept" : { CodeableConcept }, "valueBoolean" : <boolean>, "valueQuantity" : { Quantity }, "valueRange" : { Range }, "valueReference" : { Reference } }], "population" : [{ // Population results in this stratum "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation "count" : <integer>, // Size of the population "subjectResults" : { Reference(List) } // For subject-list reports, the subject results in this population }], // measureScore[x]: What score this stratum achieved. One of these 6: "measureScoreQuantity" : { Quantity }, "measureScoreDateTime" : "<dateTime>", "measureScoreCodeableConcept" : { CodeableConcept }, "measureScorePeriod" : { Period }, "measureScoreRange" : { Range }, "measureScoreDuration" : { Duration } }] }] }], "evaluatedResource" : [{ Reference(Any) }] // What data was used to calculate 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..* Additional identifier for the MeasureReport fhir:MeasureReport.status [ code ]; # 1..1 complete | pending | error fhir:MeasureReport.type [ code ]; # 1..1 I individual | subject-list | summary | data-exchange fhir:MeasureReport.dataUpdateType [ code ]; # 0..1 incremental | snapshot fhir:MeasureReport.measure [ canonical(Measure) ]; # 0..1 What measure was calculated fhir:MeasureReport.subject [ Reference(CareTeam|Device|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 What individual(s) the report is for fhir:MeasureReport.date [ dateTime ]; # 0..1 When the report was generated fhir:MeasureReport.reporter [ Reference(Group|Organization|Practitioner|PractitionerRole) ]; # 0..1 Who is reporting the data fhir:MeasureReport.reportingVendor [ Reference(Organization) ]; # 0..1 What vendor prepared the data fhir:MeasureReport.location [ Reference(Location) ]; # 0..1 Where the reported data is from fhir:MeasureReport.period [ Period ]; # 1..1 What period the report covers fhir:MeasureReport.inputParameters [ Reference(Parameters) ]; # 0..1 What parameters were provided to the report fhir:MeasureReport.scoring [ CodeableConcept ]; # 0..1 What scoring method (e.g. proportion, ratio, continuous-variable) fhir:MeasureReport.improvementNotation [ CodeableConcept ]; # 0..1 increase | decrease fhir:MeasureReport.group [ # 0..* I Measure results for each group fhir:MeasureReport.group.code [ CodeableConcept ]; # 0..1 Meaning of the group fhir:MeasureReport.group.population [ # 0..* The populations in the group fhir:MeasureReport.group.population.code [ CodeableConcept ]; # 0..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation fhir:MeasureReport.group.population.count [ integer ]; # 0..1 Size of the population fhir:MeasureReport.group.population.subjectResults [ Reference(List) ]; # 0..1 For subject-list reports, the subject results in this population ], ...; # MeasureReport.group.measureScore[x] : 0..1 What score this group achieved. One of these 6 fhir:MeasureReport.group.measureScoreQuantity [ Quantity ] fhir:MeasureReport.group.measureScoreDateTime [ dateTime ] fhir:MeasureReport.group.measureScoreCodeableConcept [ CodeableConcept ] fhir:MeasureReport.group.measureScorePeriod [ Period ] fhir:MeasureReport.group.measureScoreRange [ Range ] fhir:MeasureReport.group.measureScoreDuration [ Duration ] fhir:MeasureReport.group.stratifier [ # 0..* Stratification results fhir:MeasureReport.group.stratifier.code [ CodeableConcept ]; # 0..1 What stratifier of the group fhir:MeasureReport.group.stratifier.stratum [ # 0..* Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components # MeasureReport.group.stratifier.stratum.value[x] : 0..1 The stratum value, e.g. male. One of these 5 fhir:MeasureReport.group.stratifier.stratum.valueCodeableConcept [ CodeableConcept ] fhir:MeasureReport.group.stratifier.stratum.valueBoolean [ boolean ] fhir:MeasureReport.group.stratifier.stratum.valueQuantity [ Quantity ] fhir:MeasureReport.group.stratifier.stratum.valueRange [ Range ] fhir:MeasureReport.group.stratifier.stratum.valueReference [ Reference ] fhir:MeasureReport.group.stratifier.stratum.component [ # 0..* Stratifier component values fhir:MeasureReport.group.stratifier.stratum.component.code [ CodeableConcept ]; # 1..1 What stratifier component of the group # MeasureReport.group.stratifier.stratum.component.value[x] : 1..1 The stratum component value, e.g. male. One of these 5 fhir:MeasureReport.group.stratifier.stratum.component.valueCodeableConcept [ CodeableConcept ] fhir:MeasureReport.group.stratifier.stratum.component.valueBoolean [ boolean ] fhir:MeasureReport.group.stratifier.stratum.component.valueQuantity [ Quantity ] fhir:MeasureReport.group.stratifier.stratum.component.valueRange [ Range ] fhir:MeasureReport.group.stratifier.stratum.component.valueReference [ Reference ] ], ...; fhir:MeasureReport.group.stratifier.stratum.population [ # 0..* Population results in this stratum 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-observation fhir:MeasureReport.group.stratifier.stratum.population.count [ integer ]; # 0..1 Size of the population fhir:MeasureReport.group.stratifier.stratum.population.subjectResults [ Reference(List) ]; # 0..1 For subject-list reports, the subject results in this population ], ...; # MeasureReport.group.stratifier.stratum.measureScore[x] : 0..1 What score this stratum achieved. One of these 6 fhir:MeasureReport.group.stratifier.stratum.measureScoreQuantity [ Quantity ] fhir:MeasureReport.group.stratifier.stratum.measureScoreDateTime [ dateTime ] fhir:MeasureReport.group.stratifier.stratum.measureScoreCodeableConcept [ CodeableConcept ] fhir:MeasureReport.group.stratifier.stratum.measureScorePeriod [ Period ] fhir:MeasureReport.group.stratifier.stratum.measureScoreRange [ Range ] fhir:MeasureReport.group.stratifier.stratum.measureScoreDuration [ Duration ] ], ...; ], ...; ], ...; fhir:MeasureReport.evaluatedResource [ Reference(Any) ], ... ; # 0..* What data was used to calculate the measure score ]
Changes since Release 4
MeasureReport | |
MeasureReport.dataUpdateType |
|
MeasureReport.measure |
|
MeasureReport.subject |
|
MeasureReport.reporter |
|
MeasureReport.reportingVendor |
|
MeasureReport.location |
|
MeasureReport.inputParameters |
|
MeasureReport.scoring |
|
MeasureReport.group.measureScore[x] |
|
MeasureReport.group.stratifier.code |
|
MeasureReport.group.stratifier.stratum.value[x] |
|
MeasureReport.group.stratifier.stratum.component.value[x] |
|
MeasureReport.group.stratifier.stratum.measureScore[x] |
|
MeasureReport.group.measureScore |
|
MeasureReport.group.stratifier.stratum.value |
|
MeasureReport.group.stratifier.stratum.component.value |
|
MeasureReport.group.stratifier.stratum.measureScore |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and 3 r3 resources are invalid (0 errors).)
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis
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.dataUpdateType | Concepts for how a measure report consumer and receiver coordinate data exchange updates. The choices are snapshot or incremental updates | Required | SubmitDataUpdateType |
MeasureReport.scoring | The scoring type of the measure. | Extensible | MeasureScoring |
MeasureReport.improvementNotation | Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. | Required | MeasureImprovementNotation |
MeasureReport.group.code | Example Measure Groups for the Measure Resource. | Example | MeasureGroupExample |
MeasureReport.group.population.code | The type of population. | Extensible | MeasurePopulationType |
MeasureReport.group.stratifier.code | Identifier subgroups in a population for measuring purposes. | Example | MeasureStratifierExample |
MeasureReport.group.stratifier.stratum.value[x] | Example Measure Stratification Value for MeasureReports Resource. | Example | MeasureReportStratifierValueExample |
MeasureReport.group.stratifier.stratum.component.code | Identifier subgroups in a population for measuring purposes. | Example | MeasureStratifierExample |
MeasureReport.group.stratifier.stratum.component.value[x] | Example Measure Stratification Value for MeasureReports Resource. | Example | MeasureReportStratifierValueExample |
MeasureReport.group.stratifier.stratum.population.code | The type of population. | Extensible | MeasurePopulationType |
UniqueKey | Level | Location | Description | Expression |
mrp-1 | Rule | (base) | Measure Reports used for data collection SHALL NOT communicate group and score information | (type != 'data-exchange') or group.exists().not() |
mrp-2 | Rule | (base) | Stratifiers SHALL be either a single criteria or a set of criteria components | group.stratifier.stratum.all(value.exists() xor component.exists()) |
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 might 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 |
date N | date | The date of the measure report | MeasureReport.date | |
evaluated-resource | reference | An evaluated resource referenced by the measure report | MeasureReport.evaluatedResource (Any) | |
identifier | token | External identifier of the measure report to be returned | MeasureReport.identifier | |
location | reference | The location to return measure report results for | MeasureReport.location (Location) | |
measure N | reference | The measure to return measure report results for | MeasureReport.measure (Measure) | |
patient | reference | The identity of a patient to search for individual measure report results for | MeasureReport.subject.where(resolve() is Patient) (Patient) | |
period | date | The period of the measure report | MeasureReport.period | |
reporter | reference | The reporter to return measure report results for | MeasureReport.reporter (Practitioner, Group, Organization, PractitionerRole) | |
status N | token | The status of the measure report | MeasureReport.status | |
subject | reference | The identity of a subject to search for individual measure report results for | MeasureReport.subject (Practitioner, Group, Organization, CareTeam, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location) |