STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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

4.22 Resource MeasureReport - Content

Clinical Quality Information Work GroupMaturity Level: 0Compartments: Patient

The MeasureReport resource contains the results of evaluating a measure.

4.22.1 Scope and Usage

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 Quality Improvement Framework Implementation Guide. Future updates to this resource will incorporate documentation from that guide.

4.22.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MeasureReport ΣDomainResourceResults of a measure evaluation
... measure Σ1..1Reference(Measure)Measure that was evaluated
... type Σ1..1codeindividual | patient-list | summary
MeasureReportType (Required)
... patient Σ0..1Reference(Patient)Optional Patient
... period Σ1..1PeriodReporting period
... status Σ1..1codecomplete | pending | error
MeasureReportStatus (Required)
... date Σ0..1dateTimeDate the report was generated
... reportingOrganization Σ0..1Reference(Organization)Reporting Organization
... group Σ0..*BackboneElementMeasure results for each group
.... identifier Σ1..1IdentifierIdentifier of the population group being reported
.... population Σ0..*BackboneElementThe populations in the group
..... type Σ1..1codeinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score
MeasurePopulationType (Required)
..... count Σ0..1integerSize of the population
..... patients Σ0..1Reference(List)For patient-list reports, the patients in this population
.... measureScore Σ0..1decimalThe measure score
.... stratifier Σ0..*BackboneElementStratification results
..... identifier Σ1..1IdentifierIdentifier of the stratifier
..... group Σ0..*BackboneElementStratum results, one for each unique value in the stratifier
...... value Σ1..1stringThe stratum value, e.g. male
...... population Σ0..*BackboneElementPopulation results in this stratum
....... type Σ1..1codeinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score
MeasurePopulationType (Required)
....... count Σ0..1integerSize of the population
....... patients Σ0..1Reference(List)For patient-list reports, the patients in this population
...... measureScore Σ0..1decimalThe measure score
.... supplementalData Σ0..*BackboneElementSupplemental data elements for the measure
..... identifier Σ1..1IdentifierIdentifier of the supplemental data element
..... group Σ0..*BackboneElementSupplemental data results, one for each unique supplemental data value
...... value Σ1..1stringThe data value, e.g. male
...... count Σ0..1integerNumber of members in the group
...... patients Σ0..1Reference(List)For patient-list reports, the patients in this population
... evaluatedResources Σ0..1Reference(Bundle)Evaluated Resources

doco Documentation for this format

UML Diagram

MeasureReport (DomainResource)A reference to the Measure that was evaluated to produce this reportmeasure : Reference [1..1] « Measure »The type of measure report. This may be an individual report, which provides a single patient's score for the measure, a patient listing, which returns the list of patients that meet the various criteria in the measure, or a summary report, which returns a population count for each criteria in the measuretype : code [1..1] « The type of the measure report (Strength=Required)MeasureReportType! »Optional Patient if the report was requested for a single patientpatient : Reference [0..1] « Patient »The reporting period for which the report was calculatedperiod : Period [1..1]The report status. No data will be available until the report status is completestatus : code [1..1] « The status of the measure report (Strength=Required)MeasureReportStatus! »The date this measure report was generateddate : dateTime [0..1]Reporting OrganizationreportingOrganization : Reference [0..1] « Organization »A reference to a Bundle containing the Resources that were used in the evaluation of this reportevaluatedResources : Reference [0..1] « Bundle »GroupThe identifier of the population group as defined in the measure definitionidentifier : Identifier [1..1]The measure scoremeasureScore : decimal [0..1]PopulationThe type of the populationtype : code [1..1] « The type of population (e.g. initial, numerator, denominator, etc.) (Strength=Required)MeasurePopulationType! »The number of members of the populationcount : integer [0..1]This element refers to a List of patient level MeasureReport resources, one for each patient in this populationpatients : Reference [0..1] « List »StratifierThe identifier of this stratifier, as defined in the measure definitionidentifier : Identifier [1..1]GroupThe value for this stratum, expressed as a string. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is uniquevalue : string [1..1]The measure score for this stratummeasureScore : decimal [0..1]PopulationThe type of the populationtype : code [1..1] « The type of population (e.g. initial, numerator, denominator, etc.) (Strength=Required)MeasurePopulationType! »The number of members of the population in this stratumcount : integer [0..1]This element refers to a List of patient level MeasureReport resources, one for each patient in this population in this stratumpatients : Reference [0..1] « List »SupplementalDataThe identifier of the supplemental data element as defined in the measureidentifier : Identifier [1..1]GroupThe value for this supplemental data element, expressed as a string. When defining supplemental data on complex values, the value must be rendered such that the value for each group within the supplemental data element is uniquevalue : string [1..1]The number of members in the supplemental data groupcount : integer [0..1]This element refers to a List of patient level MeasureReport resources, one for each patient in this populationpatients : Reference [0..1] « List »The populations that make up the population group, one for each type of population appropriate for the measurepopulation[0..*]The populations that make up the stratum, one for each type of population appropriate to the measurepopulation[0..*]This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender valuegroup[0..*]When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measurestratifier[0..*]This element contains the results for a single value within the supplemental data. For example, when reporting supplemental data for administrative gender, there will be four groups, one for each possible gender valuegroup[0..*]Supplemental data elements for the measure provide additional information requested by the measure for each patient involved in the populationssupplementalData[0..*]The results of the calculation, one for each population group in the measuregroup[0..*]

XML Template

<MeasureReport xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MeasureReport ΣDomainResourceResults of a measure evaluation
... measure Σ1..1Reference(Measure)Measure that was evaluated
... type Σ1..1codeindividual | patient-list | summary
MeasureReportType (Required)
... patient Σ0..1Reference(Patient)Optional Patient
... period Σ1..1PeriodReporting period
... status Σ1..1codecomplete | pending | error
MeasureReportStatus (Required)
... date Σ0..1dateTimeDate the report was generated
... reportingOrganization Σ0..1Reference(Organization)Reporting Organization
... group Σ0..*BackboneElementMeasure results for each group
.... identifier Σ1..1IdentifierIdentifier of the population group being reported
.... population Σ0..*BackboneElementThe populations in the group
..... type Σ1..1codeinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score
MeasurePopulationType (Required)
..... count Σ0..1integerSize of the population
..... patients Σ0..1Reference(List)For patient-list reports, the patients in this population
.... measureScore Σ0..1decimalThe measure score
.... stratifier Σ0..*BackboneElementStratification results
..... identifier Σ1..1IdentifierIdentifier of the stratifier
..... group Σ0..*BackboneElementStratum results, one for each unique value in the stratifier
...... value Σ1..1stringThe stratum value, e.g. male
...... population Σ0..*BackboneElementPopulation results in this stratum
....... type Σ1..1codeinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score
MeasurePopulationType (Required)
....... count Σ0..1integerSize of the population
....... patients Σ0..1Reference(List)For patient-list reports, the patients in this population
...... measureScore Σ0..1decimalThe measure score
.... supplementalData Σ0..*BackboneElementSupplemental data elements for the measure
..... identifier Σ1..1IdentifierIdentifier of the supplemental data element
..... group Σ0..*BackboneElementSupplemental data results, one for each unique supplemental data value
...... value Σ1..1stringThe data value, e.g. male
...... count Σ0..1integerNumber of members in the group
...... patients Σ0..1Reference(List)For patient-list reports, the patients in this population
... evaluatedResources Σ0..1Reference(Bundle)Evaluated Resources

doco Documentation for this format

UML Diagram

MeasureReport (DomainResource)A reference to the Measure that was evaluated to produce this reportmeasure : Reference [1..1] « Measure »The type of measure report. This may be an individual report, which provides a single patient's score for the measure, a patient listing, which returns the list of patients that meet the various criteria in the measure, or a summary report, which returns a population count for each criteria in the measuretype : code [1..1] « The type of the measure report (Strength=Required)MeasureReportType! »Optional Patient if the report was requested for a single patientpatient : Reference [0..1] « Patient »The reporting period for which the report was calculatedperiod : Period [1..1]The report status. No data will be available until the report status is completestatus : code [1..1] « The status of the measure report (Strength=Required)MeasureReportStatus! »The date this measure report was generateddate : dateTime [0..1]Reporting OrganizationreportingOrganization : Reference [0..1] « Organization »A reference to a Bundle containing the Resources that were used in the evaluation of this reportevaluatedResources : Reference [0..1] « Bundle »GroupThe identifier of the population group as defined in the measure definitionidentifier : Identifier [1..1]The measure scoremeasureScore : decimal [0..1]PopulationThe type of the populationtype : code [1..1] « The type of population (e.g. initial, numerator, denominator, etc.) (Strength=Required)MeasurePopulationType! »The number of members of the populationcount : integer [0..1]This element refers to a List of patient level MeasureReport resources, one for each patient in this populationpatients : Reference [0..1] « List »StratifierThe identifier of this stratifier, as defined in the measure definitionidentifier : Identifier [1..1]GroupThe value for this stratum, expressed as a string. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is uniquevalue : string [1..1]The measure score for this stratummeasureScore : decimal [0..1]PopulationThe type of the populationtype : code [1..1] « The type of population (e.g. initial, numerator, denominator, etc.) (Strength=Required)MeasurePopulationType! »The number of members of the population in this stratumcount : integer [0..1]This element refers to a List of patient level MeasureReport resources, one for each patient in this population in this stratumpatients : Reference [0..1] « List »SupplementalDataThe identifier of the supplemental data element as defined in the measureidentifier : Identifier [1..1]GroupThe value for this supplemental data element, expressed as a string. When defining supplemental data on complex values, the value must be rendered such that the value for each group within the supplemental data element is uniquevalue : string [1..1]The number of members in the supplemental data groupcount : integer [0..1]This element refers to a List of patient level MeasureReport resources, one for each patient in this populationpatients : Reference [0..1] « List »The populations that make up the population group, one for each type of population appropriate for the measurepopulation[0..*]The populations that make up the stratum, one for each type of population appropriate to the measurepopulation[0..*]This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender valuegroup[0..*]When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measurestratifier[0..*]This element contains the results for a single value within the supplemental data. For example, when reporting supplemental data for administrative gender, there will be four groups, one for each possible gender valuegroup[0..*]Supplemental data elements for the measure provide additional information requested by the measure for each patient involved in the populationssupplementalData[0..*]The results of the calculation, one for each population group in the measuregroup[0..*]

XML Template

<MeasureReport xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

4.22.2.1 Terminology Bindings

PathDefinitionTypeReference
MeasureReport.type The type of the measure reportRequiredMeasureReportType
MeasureReport.status The status of the measure reportRequiredMeasureReportStatus
MeasureReport.group.population.type
MeasureReport.group.stratifier.group.population.type 		The type of population (e.g. initial, numerator, denominator, etc.)RequiredMeasurePopulationType

4.22.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
patientreferenceThe identity of a patient to search for individual measure report results forMeasureReport.patient
(Patient)