This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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
Clinical Quality Information Work Group | Maturity Level: 2 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
The Measure resource provides the definition of a quality measure.
The Measure resource represents a structured, computable definition of a health-related measure such as a clinical quality measure, public health indicator, or population analytics measure. A quality measure is a quantitative tool to assess the performance of an individual or organization with respect to a specified process or outcome via the measurement of actions, processes, or outcomes of clinical care. Quality measures are often derived from clinical guidelines and are designed to determine whether the appropriate care has been provided given a set of clinical criteria and an evidence base.
Note that the Measure itself does not typically contain any logic; rather a Library resource is referenced that contains the logic required by the measure, and the various expression elements, such as population criteria, reference named expressions within that library (or libraries). In addition, if the Measure references multiple libraries, then any expression references within the resource must be qualified with the name of the library that contains the referenced expression.
For a detailed discussion of how to use the Measure and MeasureReport resources, refer to the Quality Reporting topic.
The Measure resource describes a specific quality measure, or population analytic, providing the structure of the measure in terms of the calculation elements (the populations involved). The Group resource is also capable of describing a population, however, the complexity involved in specifying the criteria in the general case requires the use of a high-level query language such as Clinical Quality Language (CQL). As such, the Measure resource defines only the top-level populations and references expressions for the actual criteria. These expressions are typically provided using a Library resource containing CQL or ELM expressions. In addition, the individual members of a population may be cases such as encounters or procedures and in these cases, the Group resource would be unable to represent the population characteristics accurately.
A Measure is also similar to an Observation resource, with the exception that the Measure is purely definitional, it contains no actual measurements, only a description of how to calculate a particular measurement or set of measurements.
A Measure is also similar to a clinical document, but as with the relationship to Observation, a Document is specific to a particular subject.
This resource is referenced by CarePlan, Communication, FamilyMemberHistory, MeasureReport and Procedure.
This resource implements the Definition pattern.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | TU | MetadataResource | A quality measure definition + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Stratifier SHALL be either a single criteria or a set of criteria components Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod | |
url | Σ | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the measure |
version | Σ | 0..1 | string | Business version of the measure |
name | ΣI | 0..1 | string | Name for this measure (computer friendly) |
title | Σ | 0..1 | string | Name for this measure (human friendly) |
subtitle | 0..1 | string | Subordinate title of the measure | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
subject[x] | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Subject type (Extensible) | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 0..1 | markdown | Natural language description of the measure |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Jurisdiction (Extensible) |
purpose | 0..1 | markdown | Why this measure is defined | |
usage | 0..1 | string | Describes the clinical usage of the measure | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the measure was approved by publisher | |
lastReviewDate | 0..1 | date | When the measure was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the measure is expected to be used |
topic | 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc. DefinitionTopic (Example) | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |
library | 0..* | canonical(Library) | Logic used by the measure | |
disclaimer | Σ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
scoring | Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort MeasureScoring (Extensible) |
compositeScoring | Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted CompositeMeasureScoring (Extensible) |
type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite MeasureType (Extensible) |
riskAdjustment | Σ | 0..1 | string | How risk adjustment is applied for this measure |
rateAggregation | Σ | 0..1 | string | How is rate aggregation performed for this measure |
rationale | Σ | 0..1 | markdown | Detailed description of why the measure exists |
clinicalRecommendationStatement | Σ | 0..1 | markdown | Summary of clinical guidelines |
improvementNotation | Σ | 0..1 | CodeableConcept | increase | decrease MeasureImprovementNotation (Required) |
definition | Σ | 0..* | markdown | Defined terms used in the measure documentation |
guidance | Σ | 0..1 | markdown | Additional guidance for implementers |
group | 0..* | BackboneElement | Population criteria group | |
code | 0..1 | CodeableConcept | Meaning of the group | |
description | 0..1 | string | Summary description | |
population | 0..* | BackboneElement | Population criteria | |
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) | |
description | 0..1 | string | The human readable description of this population criteria | |
criteria | 1..1 | Expression | The criteria that defines this population | |
stratifier | 0..* | BackboneElement | Stratifier criteria for the measure | |
code | 0..1 | CodeableConcept | Meaning of the stratifier | |
description | 0..1 | string | The human readable description of this stratifier | |
criteria | 0..1 | Expression | How the measure should be stratified | |
component | 0..* | BackboneElement | Stratifier criteria component for the measure | |
code | 0..1 | CodeableConcept | Meaning of the stratifier component | |
description | 0..1 | string | The human readable description of this stratifier component | |
criteria | 1..1 | Expression | Component of how the measure should be stratified | |
supplementalData | 0..* | BackboneElement | What other data should be reported with the measure | |
code | 0..1 | CodeableConcept | Meaning of the supplemental data | |
usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor MeasureDataUsage (Extensible) | |
description | 0..1 | string | The human readable description of this supplemental data | |
criteria | 1..1 | Expression | Expression describing additional data to be reported | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<Measure xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this measure, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the measure --></identifier> <version value="[string]"/><!-- 0..1 Business version of the measure --> <name value="[string]"/><!-- 0..1 Name for this measure (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this measure (human friendly) --> <subtitle value="[string]"/><!-- 0..1 Subordinate title of the measure --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the measure --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for measure (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this measure is defined --> <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the measure --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the measure was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the measure was last reviewed --> <effectivePeriod><!-- 0..1 Period When the measure is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc. --></topic> <author><!-- 0..* ContactDetail Who authored the content --></author> <editor><!-- 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <library><!-- 0..* canonical(Library) Logic used by the measure --></library> <disclaimer value="[markdown]"/><!-- 0..1 Disclaimer for use of the measure or its referenced content --> <scoring><!-- 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort --></scoring> <compositeScoring><!-- 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted --></compositeScoring> <type><!-- 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <riskAdjustment value="[string]"/><!-- 0..1 How risk adjustment is applied for this measure --> <rateAggregation value="[string]"/><!-- 0..1 How is rate aggregation performed for this measure --> <rationale value="[markdown]"/><!-- 0..1 Detailed description of why the measure exists --> <clinicalRecommendationStatement value="[markdown]"/><!-- 0..1 Summary of clinical guidelines --> <improvementNotation><!-- 0..1 CodeableConcept increase | decrease --></improvementNotation> <definition value="[markdown]"/><!-- 0..* Defined terms used in the measure documentation --> <guidance value="[markdown]"/><!-- 0..1 Additional guidance for implementers --> <group> <!-- 0..* Population criteria group --> <code><!-- 0..1 CodeableConcept Meaning of the group --></code> <description value="[string]"/><!-- 0..1 Summary description --> <population> <!-- 0..* Population criteria --> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <description value="[string]"/><!-- 0..1 The human readable description of this population criteria --> <criteria><!-- 1..1 Expression The criteria that defines this population --></criteria> </population> <stratifier> <!-- 0..* Stratifier criteria for the measure --> <code><!-- 0..1 CodeableConcept Meaning of the stratifier --></code> <description value="[string]"/><!-- 0..1 The human readable description of this stratifier --> <criteria><!-- 0..1 Expression How the measure should be stratified --></criteria> <component> <!-- 0..* Stratifier criteria component for the measure --> <code><!-- 0..1 CodeableConcept Meaning of the stratifier component --></code> <description value="[string]"/><!-- 0..1 The human readable description of this stratifier component --> <criteria><!-- 1..1 Expression Component of how the measure should be stratified --></criteria> </component> </stratifier> </group> <supplementalData> <!-- 0..* What other data should be reported with the measure --> <code><!-- 0..1 CodeableConcept Meaning of the supplemental data --></code> <usage><!-- 0..* CodeableConcept supplemental-data | risk-adjustment-factor --></usage> <description value="[string]"/><!-- 0..1 The human readable description of this supplemental data --> <criteria><!-- 1..1 Expression Expression describing additional data to be reported --></criteria> </supplementalData> </Measure>
JSON Template
{ "resourceType" : "Measure", // from Resource: id, meta, implicitRules, and language "url" : "<uri>", // Canonical identifier for this measure, represented as a URI (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the measure "version" : "<string>", // Business version of the measure "name" : "<string>", // C? Name for this measure (computer friendly) "title" : "<string>", // Name for this measure (human friendly) "subtitle" : "<string>", // Subordinate title of the measure "status" : "<code>", // R! draft | active | retired | unknown "experimental" : <boolean>, // For testing purposes, not real usage // subject[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2: "subjectCodeableConcept" : { CodeableConcept }, "subjectReference" : { Reference(Group) }, "date" : "<dateTime>", // Date last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // Natural language description of the measure "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for measure (if applicable) "purpose" : "<markdown>", // Why this measure is defined "usage" : "<string>", // Describes the clinical usage of the measure "copyright" : "<markdown>", // Use and/or publishing restrictions "approvalDate" : "<date>", // When the measure was approved by publisher "lastReviewDate" : "<date>", // When the measure was last reviewed "effectivePeriod" : { Period }, // When the measure is expected to be used "topic" : [{ CodeableConcept }], // The category of the measure, such as Education, Treatment, Assessment, etc. "author" : [{ ContactDetail }], // Who authored the content "editor" : [{ ContactDetail }], // Who edited the content "reviewer" : [{ ContactDetail }], // Who reviewed the content "endorser" : [{ ContactDetail }], // Who endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc. "library" : [{ canonical(Library) }], // Logic used by the measure "disclaimer" : "<markdown>", // Disclaimer for use of the measure or its referenced content "scoring" : { CodeableConcept }, // proportion | ratio | continuous-variable | cohort "compositeScoring" : { CodeableConcept }, // opportunity | all-or-nothing | linear | weighted "type" : [{ CodeableConcept }], // process | outcome | structure | patient-reported-outcome | composite "riskAdjustment" : "<string>", // How risk adjustment is applied for this measure "rateAggregation" : "<string>", // How is rate aggregation performed for this measure "rationale" : "<markdown>", // Detailed description of why the measure exists "clinicalRecommendationStatement" : "<markdown>", // Summary of clinical guidelines "improvementNotation" : { CodeableConcept }, // increase | decrease "definition" : ["<markdown>"], // Defined terms used in the measure documentation "guidance" : "<markdown>", // Additional guidance for implementers "group" : [{ // Population criteria group "code" : { CodeableConcept }, // Meaning of the group "description" : "<string>", // Summary description "population" : [{ // Population criteria "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation "description" : "<string>", // The human readable description of this population criteria "criteria" : { Expression } // R! The criteria that defines this population }], "stratifier" : [{ // Stratifier criteria for the measure "code" : { CodeableConcept }, // Meaning of the stratifier "description" : "<string>", // The human readable description of this stratifier "criteria" : { Expression }, // How the measure should be stratified "component" : [{ // Stratifier criteria component for the measure "code" : { CodeableConcept }, // Meaning of the stratifier component "description" : "<string>", // The human readable description of this stratifier component "criteria" : { Expression } // R! Component of how the measure should be stratified }] }] }], "supplementalData" : [{ // What other data should be reported with the measure "code" : { CodeableConcept }, // Meaning of the supplemental data "usage" : [{ CodeableConcept }], // supplemental-data | risk-adjustment-factor "description" : "<string>", // The human readable description of this supplemental data "criteria" : { Expression } // R! Expression describing additional data to be reported }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Measure; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language fhir:Measure.url [ uri ]; # 0..1 Canonical identifier for this measure, represented as a URI (globally unique) fhir:Measure.identifier [ Identifier ], ... ; # 0..* Additional identifier for the measure fhir:Measure.version [ string ]; # 0..1 Business version of the measure fhir:Measure.name [ string ]; # 0..1 Name for this measure (computer friendly) fhir:Measure.title [ string ]; # 0..1 Name for this measure (human friendly) fhir:Measure.subtitle [ string ]; # 0..1 Subordinate title of the measure fhir:Measure.status [ code ]; # 1..1 draft | active | retired | unknown fhir:Measure.experimental [ boolean ]; # 0..1 For testing purposes, not real usage # Measure.subject[x] : 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2 fhir:Measure.subjectCodeableConcept [ CodeableConcept ] fhir:Measure.subjectReference [ Reference(Group) ] fhir:Measure.date [ dateTime ]; # 0..1 Date last changed fhir:Measure.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:Measure.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:Measure.description [ markdown ]; # 0..1 Natural language description of the measure fhir:Measure.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:Measure.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for measure (if applicable) fhir:Measure.purpose [ markdown ]; # 0..1 Why this measure is defined fhir:Measure.usage [ string ]; # 0..1 Describes the clinical usage of the measure fhir:Measure.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:Measure.approvalDate [ date ]; # 0..1 When the measure was approved by publisher fhir:Measure.lastReviewDate [ date ]; # 0..1 When the measure was last reviewed fhir:Measure.effectivePeriod [ Period ]; # 0..1 When the measure is expected to be used fhir:Measure.topic [ CodeableConcept ], ... ; # 0..* The category of the measure, such as Education, Treatment, Assessment, etc. fhir:Measure.author [ ContactDetail ], ... ; # 0..* Who authored the content fhir:Measure.editor [ ContactDetail ], ... ; # 0..* Who edited the content fhir:Measure.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content fhir:Measure.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content fhir:Measure.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc. fhir:Measure.library [ canonical(Library) ], ... ; # 0..* Logic used by the measure fhir:Measure.disclaimer [ markdown ]; # 0..1 Disclaimer for use of the measure or its referenced content fhir:Measure.scoring [ CodeableConcept ]; # 0..1 proportion | ratio | continuous-variable | cohort fhir:Measure.compositeScoring [ CodeableConcept ]; # 0..1 opportunity | all-or-nothing | linear | weighted fhir:Measure.type [ CodeableConcept ], ... ; # 0..* process | outcome | structure | patient-reported-outcome | composite fhir:Measure.riskAdjustment [ string ]; # 0..1 How risk adjustment is applied for this measure fhir:Measure.rateAggregation [ string ]; # 0..1 How is rate aggregation performed for this measure fhir:Measure.rationale [ markdown ]; # 0..1 Detailed description of why the measure exists fhir:Measure.clinicalRecommendationStatement [ markdown ]; # 0..1 Summary of clinical guidelines fhir:Measure.improvementNotation [ CodeableConcept ]; # 0..1 increase | decrease fhir:Measure.definition [ markdown ], ... ; # 0..* Defined terms used in the measure documentation fhir:Measure.guidance [ markdown ]; # 0..1 Additional guidance for implementers fhir:Measure.group [ # 0..* Population criteria group fhir:Measure.group.code [ CodeableConcept ]; # 0..1 Meaning of the group fhir:Measure.group.description [ string ]; # 0..1 Summary description fhir:Measure.group.population [ # 0..* Population criteria fhir:Measure.group.population.code [ CodeableConcept ]; # 0..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation fhir:Measure.group.population.description [ string ]; # 0..1 The human readable description of this population criteria fhir:Measure.group.population.criteria [ Expression ]; # 1..1 The criteria that defines this population ], ...; fhir:Measure.group.stratifier [ # 0..* Stratifier criteria for the measure fhir:Measure.group.stratifier.code [ CodeableConcept ]; # 0..1 Meaning of the stratifier fhir:Measure.group.stratifier.description [ string ]; # 0..1 The human readable description of this stratifier fhir:Measure.group.stratifier.criteria [ Expression ]; # 0..1 How the measure should be stratified fhir:Measure.group.stratifier.component [ # 0..* Stratifier criteria component for the measure fhir:Measure.group.stratifier.component.code [ CodeableConcept ]; # 0..1 Meaning of the stratifier component fhir:Measure.group.stratifier.component.description [ string ]; # 0..1 The human readable description of this stratifier component fhir:Measure.group.stratifier.component.criteria [ Expression ]; # 1..1 Component of how the measure should be stratified ], ...; ], ...; ], ...; fhir:Measure.supplementalData [ # 0..* What other data should be reported with the measure fhir:Measure.supplementalData.code [ CodeableConcept ]; # 0..1 Meaning of the supplemental data fhir:Measure.supplementalData.usage [ CodeableConcept ], ... ; # 0..* supplemental-data | risk-adjustment-factor fhir:Measure.supplementalData.description [ string ]; # 0..1 The human readable description of this supplemental data fhir:Measure.supplementalData.criteria [ Expression ]; # 1..1 Expression describing additional data to be reported ], ...; ]
Changes since R3
Measure | |
Measure.status |
|
Measure.improvementNotation |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 6 tests that all execute ok. All tests pass round-trip testing and 6 r3 resources are invalid (0 errors).)
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | TU | MetadataResource | A quality measure definition + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Stratifier SHALL be either a single criteria or a set of criteria components Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod | |
url | Σ | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the measure |
version | Σ | 0..1 | string | Business version of the measure |
name | ΣI | 0..1 | string | Name for this measure (computer friendly) |
title | Σ | 0..1 | string | Name for this measure (human friendly) |
subtitle | 0..1 | string | Subordinate title of the measure | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
subject[x] | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Subject type (Extensible) | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 0..1 | markdown | Natural language description of the measure |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Jurisdiction (Extensible) |
purpose | 0..1 | markdown | Why this measure is defined | |
usage | 0..1 | string | Describes the clinical usage of the measure | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the measure was approved by publisher | |
lastReviewDate | 0..1 | date | When the measure was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the measure is expected to be used |
topic | 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc. DefinitionTopic (Example) | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |
library | 0..* | canonical(Library) | Logic used by the measure | |
disclaimer | Σ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
scoring | Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort MeasureScoring (Extensible) |
compositeScoring | Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted CompositeMeasureScoring (Extensible) |
type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite MeasureType (Extensible) |
riskAdjustment | Σ | 0..1 | string | How risk adjustment is applied for this measure |
rateAggregation | Σ | 0..1 | string | How is rate aggregation performed for this measure |
rationale | Σ | 0..1 | markdown | Detailed description of why the measure exists |
clinicalRecommendationStatement | Σ | 0..1 | markdown | Summary of clinical guidelines |
improvementNotation | Σ | 0..1 | CodeableConcept | increase | decrease MeasureImprovementNotation (Required) |
definition | Σ | 0..* | markdown | Defined terms used in the measure documentation |
guidance | Σ | 0..1 | markdown | Additional guidance for implementers |
group | 0..* | BackboneElement | Population criteria group | |
code | 0..1 | CodeableConcept | Meaning of the group | |
description | 0..1 | string | Summary description | |
population | 0..* | BackboneElement | Population criteria | |
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) | |
description | 0..1 | string | The human readable description of this population criteria | |
criteria | 1..1 | Expression | The criteria that defines this population | |
stratifier | 0..* | BackboneElement | Stratifier criteria for the measure | |
code | 0..1 | CodeableConcept | Meaning of the stratifier | |
description | 0..1 | string | The human readable description of this stratifier | |
criteria | 0..1 | Expression | How the measure should be stratified | |
component | 0..* | BackboneElement | Stratifier criteria component for the measure | |
code | 0..1 | CodeableConcept | Meaning of the stratifier component | |
description | 0..1 | string | The human readable description of this stratifier component | |
criteria | 1..1 | Expression | Component of how the measure should be stratified | |
supplementalData | 0..* | BackboneElement | What other data should be reported with the measure | |
code | 0..1 | CodeableConcept | Meaning of the supplemental data | |
usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor MeasureDataUsage (Extensible) | |
description | 0..1 | string | The human readable description of this supplemental data | |
criteria | 1..1 | Expression | Expression describing additional data to be reported | |
Documentation for this format |
XML Template
<Measure xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this measure, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the measure --></identifier> <version value="[string]"/><!-- 0..1 Business version of the measure --> <name value="[string]"/><!-- 0..1 Name for this measure (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this measure (human friendly) --> <subtitle value="[string]"/><!-- 0..1 Subordinate title of the measure --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the measure --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for measure (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this measure is defined --> <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the measure --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the measure was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the measure was last reviewed --> <effectivePeriod><!-- 0..1 Period When the measure is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc. --></topic> <author><!-- 0..* ContactDetail Who authored the content --></author> <editor><!-- 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <library><!-- 0..* canonical(Library) Logic used by the measure --></library> <disclaimer value="[markdown]"/><!-- 0..1 Disclaimer for use of the measure or its referenced content --> <scoring><!-- 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort --></scoring> <compositeScoring><!-- 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted --></compositeScoring> <type><!-- 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <riskAdjustment value="[string]"/><!-- 0..1 How risk adjustment is applied for this measure --> <rateAggregation value="[string]"/><!-- 0..1 How is rate aggregation performed for this measure --> <rationale value="[markdown]"/><!-- 0..1 Detailed description of why the measure exists --> <clinicalRecommendationStatement value="[markdown]"/><!-- 0..1 Summary of clinical guidelines --> <improvementNotation><!-- 0..1 CodeableConcept increase | decrease --></improvementNotation> <definition value="[markdown]"/><!-- 0..* Defined terms used in the measure documentation --> <guidance value="[markdown]"/><!-- 0..1 Additional guidance for implementers --> <group> <!-- 0..* Population criteria group --> <code><!-- 0..1 CodeableConcept Meaning of the group --></code> <description value="[string]"/><!-- 0..1 Summary description --> <population> <!-- 0..* Population criteria --> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <description value="[string]"/><!-- 0..1 The human readable description of this population criteria --> <criteria><!-- 1..1 Expression The criteria that defines this population --></criteria> </population> <stratifier> <!-- 0..* Stratifier criteria for the measure --> <code><!-- 0..1 CodeableConcept Meaning of the stratifier --></code> <description value="[string]"/><!-- 0..1 The human readable description of this stratifier --> <criteria><!-- 0..1 Expression How the measure should be stratified --></criteria> <component> <!-- 0..* Stratifier criteria component for the measure --> <code><!-- 0..1 CodeableConcept Meaning of the stratifier component --></code> <description value="[string]"/><!-- 0..1 The human readable description of this stratifier component --> <criteria><!-- 1..1 Expression Component of how the measure should be stratified --></criteria> </component> </stratifier> </group> <supplementalData> <!-- 0..* What other data should be reported with the measure --> <code><!-- 0..1 CodeableConcept Meaning of the supplemental data --></code> <usage><!-- 0..* CodeableConcept supplemental-data | risk-adjustment-factor --></usage> <description value="[string]"/><!-- 0..1 The human readable description of this supplemental data --> <criteria><!-- 1..1 Expression Expression describing additional data to be reported --></criteria> </supplementalData> </Measure>
JSON Template
{ "resourceType" : "Measure", // from Resource: id, meta, implicitRules, and language "url" : "<uri>", // Canonical identifier for this measure, represented as a URI (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the measure "version" : "<string>", // Business version of the measure "name" : "<string>", // C? Name for this measure (computer friendly) "title" : "<string>", // Name for this measure (human friendly) "subtitle" : "<string>", // Subordinate title of the measure "status" : "<code>", // R! draft | active | retired | unknown "experimental" : <boolean>, // For testing purposes, not real usage // subject[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2: "subjectCodeableConcept" : { CodeableConcept }, "subjectReference" : { Reference(Group) }, "date" : "<dateTime>", // Date last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // Natural language description of the measure "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for measure (if applicable) "purpose" : "<markdown>", // Why this measure is defined "usage" : "<string>", // Describes the clinical usage of the measure "copyright" : "<markdown>", // Use and/or publishing restrictions "approvalDate" : "<date>", // When the measure was approved by publisher "lastReviewDate" : "<date>", // When the measure was last reviewed "effectivePeriod" : { Period }, // When the measure is expected to be used "topic" : [{ CodeableConcept }], // The category of the measure, such as Education, Treatment, Assessment, etc. "author" : [{ ContactDetail }], // Who authored the content "editor" : [{ ContactDetail }], // Who edited the content "reviewer" : [{ ContactDetail }], // Who reviewed the content "endorser" : [{ ContactDetail }], // Who endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc. "library" : [{ canonical(Library) }], // Logic used by the measure "disclaimer" : "<markdown>", // Disclaimer for use of the measure or its referenced content "scoring" : { CodeableConcept }, // proportion | ratio | continuous-variable | cohort "compositeScoring" : { CodeableConcept }, // opportunity | all-or-nothing | linear | weighted "type" : [{ CodeableConcept }], // process | outcome | structure | patient-reported-outcome | composite "riskAdjustment" : "<string>", // How risk adjustment is applied for this measure "rateAggregation" : "<string>", // How is rate aggregation performed for this measure "rationale" : "<markdown>", // Detailed description of why the measure exists "clinicalRecommendationStatement" : "<markdown>", // Summary of clinical guidelines "improvementNotation" : { CodeableConcept }, // increase | decrease "definition" : ["<markdown>"], // Defined terms used in the measure documentation "guidance" : "<markdown>", // Additional guidance for implementers "group" : [{ // Population criteria group "code" : { CodeableConcept }, // Meaning of the group "description" : "<string>", // Summary description "population" : [{ // Population criteria "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation "description" : "<string>", // The human readable description of this population criteria "criteria" : { Expression } // R! The criteria that defines this population }], "stratifier" : [{ // Stratifier criteria for the measure "code" : { CodeableConcept }, // Meaning of the stratifier "description" : "<string>", // The human readable description of this stratifier "criteria" : { Expression }, // How the measure should be stratified "component" : [{ // Stratifier criteria component for the measure "code" : { CodeableConcept }, // Meaning of the stratifier component "description" : "<string>", // The human readable description of this stratifier component "criteria" : { Expression } // R! Component of how the measure should be stratified }] }] }], "supplementalData" : [{ // What other data should be reported with the measure "code" : { CodeableConcept }, // Meaning of the supplemental data "usage" : [{ CodeableConcept }], // supplemental-data | risk-adjustment-factor "description" : "<string>", // The human readable description of this supplemental data "criteria" : { Expression } // R! Expression describing additional data to be reported }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Measure; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language fhir:Measure.url [ uri ]; # 0..1 Canonical identifier for this measure, represented as a URI (globally unique) fhir:Measure.identifier [ Identifier ], ... ; # 0..* Additional identifier for the measure fhir:Measure.version [ string ]; # 0..1 Business version of the measure fhir:Measure.name [ string ]; # 0..1 Name for this measure (computer friendly) fhir:Measure.title [ string ]; # 0..1 Name for this measure (human friendly) fhir:Measure.subtitle [ string ]; # 0..1 Subordinate title of the measure fhir:Measure.status [ code ]; # 1..1 draft | active | retired | unknown fhir:Measure.experimental [ boolean ]; # 0..1 For testing purposes, not real usage # Measure.subject[x] : 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2 fhir:Measure.subjectCodeableConcept [ CodeableConcept ] fhir:Measure.subjectReference [ Reference(Group) ] fhir:Measure.date [ dateTime ]; # 0..1 Date last changed fhir:Measure.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:Measure.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:Measure.description [ markdown ]; # 0..1 Natural language description of the measure fhir:Measure.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:Measure.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for measure (if applicable) fhir:Measure.purpose [ markdown ]; # 0..1 Why this measure is defined fhir:Measure.usage [ string ]; # 0..1 Describes the clinical usage of the measure fhir:Measure.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:Measure.approvalDate [ date ]; # 0..1 When the measure was approved by publisher fhir:Measure.lastReviewDate [ date ]; # 0..1 When the measure was last reviewed fhir:Measure.effectivePeriod [ Period ]; # 0..1 When the measure is expected to be used fhir:Measure.topic [ CodeableConcept ], ... ; # 0..* The category of the measure, such as Education, Treatment, Assessment, etc. fhir:Measure.author [ ContactDetail ], ... ; # 0..* Who authored the content fhir:Measure.editor [ ContactDetail ], ... ; # 0..* Who edited the content fhir:Measure.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content fhir:Measure.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content fhir:Measure.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc. fhir:Measure.library [ canonical(Library) ], ... ; # 0..* Logic used by the measure fhir:Measure.disclaimer [ markdown ]; # 0..1 Disclaimer for use of the measure or its referenced content fhir:Measure.scoring [ CodeableConcept ]; # 0..1 proportion | ratio | continuous-variable | cohort fhir:Measure.compositeScoring [ CodeableConcept ]; # 0..1 opportunity | all-or-nothing | linear | weighted fhir:Measure.type [ CodeableConcept ], ... ; # 0..* process | outcome | structure | patient-reported-outcome | composite fhir:Measure.riskAdjustment [ string ]; # 0..1 How risk adjustment is applied for this measure fhir:Measure.rateAggregation [ string ]; # 0..1 How is rate aggregation performed for this measure fhir:Measure.rationale [ markdown ]; # 0..1 Detailed description of why the measure exists fhir:Measure.clinicalRecommendationStatement [ markdown ]; # 0..1 Summary of clinical guidelines fhir:Measure.improvementNotation [ CodeableConcept ]; # 0..1 increase | decrease fhir:Measure.definition [ markdown ], ... ; # 0..* Defined terms used in the measure documentation fhir:Measure.guidance [ markdown ]; # 0..1 Additional guidance for implementers fhir:Measure.group [ # 0..* Population criteria group fhir:Measure.group.code [ CodeableConcept ]; # 0..1 Meaning of the group fhir:Measure.group.description [ string ]; # 0..1 Summary description fhir:Measure.group.population [ # 0..* Population criteria fhir:Measure.group.population.code [ CodeableConcept ]; # 0..1 initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation fhir:Measure.group.population.description [ string ]; # 0..1 The human readable description of this population criteria fhir:Measure.group.population.criteria [ Expression ]; # 1..1 The criteria that defines this population ], ...; fhir:Measure.group.stratifier [ # 0..* Stratifier criteria for the measure fhir:Measure.group.stratifier.code [ CodeableConcept ]; # 0..1 Meaning of the stratifier fhir:Measure.group.stratifier.description [ string ]; # 0..1 The human readable description of this stratifier fhir:Measure.group.stratifier.criteria [ Expression ]; # 0..1 How the measure should be stratified fhir:Measure.group.stratifier.component [ # 0..* Stratifier criteria component for the measure fhir:Measure.group.stratifier.component.code [ CodeableConcept ]; # 0..1 Meaning of the stratifier component fhir:Measure.group.stratifier.component.description [ string ]; # 0..1 The human readable description of this stratifier component fhir:Measure.group.stratifier.component.criteria [ Expression ]; # 1..1 Component of how the measure should be stratified ], ...; ], ...; ], ...; fhir:Measure.supplementalData [ # 0..* What other data should be reported with the measure fhir:Measure.supplementalData.code [ CodeableConcept ]; # 0..1 Meaning of the supplemental data fhir:Measure.supplementalData.usage [ CodeableConcept ], ... ; # 0..* supplemental-data | risk-adjustment-factor fhir:Measure.supplementalData.description [ string ]; # 0..1 The human readable description of this supplemental data fhir:Measure.supplementalData.criteria [ Expression ]; # 1..1 Expression describing additional data to be reported ], ...; ]
Changes since Release 3
Measure | |
Measure.status |
|
Measure.improvementNotation |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 6 tests that all execute ok. All tests pass round-trip testing and 6 r3 resources are invalid (0 errors).)
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis a
Path | Definition | Type | Reference |
---|---|---|---|
Measure.status | The lifecycle status of an artifact. | Required | PublicationStatus |
Measure.subject[x] | The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). | Extensible | SubjectType |
Measure.jurisdiction | Countries and regions within which this artifact is targeted for use. | Extensible | Jurisdiction ValueSet |
Measure.topic | High-level categorization of the definition, used for searching, sorting, and filtering. | Example | DefinitionTopic |
Measure.scoring | The scoring type of the measure. | Extensible | MeasureScoring |
Measure.compositeScoring | The composite scoring method of the measure. | Extensible | CompositeMeasureScoring |
Measure.type | The type of measure (includes codes from 2.16.840.1.113883.1.11.20368). | Extensible | MeasureType |
Measure.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 |
Measure.group.population.code | The type of population. | Extensible | MeasurePopulationType |
Measure.supplementalData.usage | The intended usage for supplemental data elements in the measure. | Extensible | MeasureDataUsage |
id | Level | Location | Description | Expression |
cnl-0 | Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
mea-1 | Rule | (base) | Stratifier SHALL be either a single criteria or a set of criteria components | group.stratifier.all((code | description | criteria).exists() xor component.exists()) |
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 |
composed-of | reference | What resource is being referenced | Measure.relatedArtifact.where(type='composed-of').resource (Any) | |
context | token | A use context assigned to the measure | (Measure.useContext.value as CodeableConcept) | |
context-quantity | quantity | A quantity- or range-valued use context assigned to the measure | (Measure.useContext.value as Quantity) | (Measure.useContext.value as Range) | |
context-type | token | A type of use context assigned to the measure | Measure.useContext.code | |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the measure | On Measure.useContext: context-type: code context-quantity: value.as(Quantity) | value.as(Range) | |
context-type-value | composite | A use context type and value assigned to the measure | On Measure.useContext: context-type: code context: value.as(CodeableConcept) | |
date N | date | The measure publication date | Measure.date | |
depends-on | reference | What resource is being referenced | Measure.relatedArtifact.where(type='depends-on').resource | Measure.library (Library, Any) | |
derived-from | reference | What resource is being referenced | Measure.relatedArtifact.where(type='derived-from').resource (Any) | |
description N | string | The description of the measure | Measure.description | |
effective | date | The time during which the measure is intended to be in use | Measure.effectivePeriod | |
identifier | token | External identifier for the measure | Measure.identifier | |
jurisdiction | token | Intended jurisdiction for the measure | Measure.jurisdiction | |
name N | string | Computationally friendly name of the measure | Measure.name | |
predecessor | reference | What resource is being referenced | Measure.relatedArtifact.where(type='predecessor').resource (Any) | |
publisher N | string | Name of the publisher of the measure | Measure.publisher | |
status N | token | The current status of the measure | Measure.status | |
successor | reference | What resource is being referenced | Measure.relatedArtifact.where(type='successor').resource (Any) | |
title N | string | The human-friendly name of the measure | Measure.title | |
topic | token | Topics associated with the measure | Measure.topic | |
url N | uri | The uri that identifies the measure | Measure.url | |
version N | token | The business version of the measure | Measure.version |