This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Clinical Quality Information Work Group | Maturity Level: 2 | Trial Use | Compartments: Not linked to any defined compartments |
The Measure resource provides the definition of a quality measure.
This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.
The Measure resource represents a structured computable definition of a clinical quality 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 contain any logic; rather a Library resource is referenced that contains the logic required by the measure, and the various expression elements, such as poulation 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.
The Measure resource describes a specific quality measure, 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 CQL expressions for the actual criteria.
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.
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 measurereport
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | DomainResource | A quality measure definition Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
url | Σ | 0..1 | uri | Logical URI to reference this measure (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the measure |
version | Σ | 0..1 | string | Business version of the measure |
name | Σ | 0..1 | string | Name for this measure (computer friendly) |
title | Σ | 0..1 | string | Name for this measure (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date this was last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
description | Σ | 0..1 | markdown | Natural language description of the measure |
purpose | 0..1 | markdown | Why this measure is defined | |
usage | 0..1 | string | Describes the clinical usage of the measure | |
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 |
useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Jurisdiction ValueSet (Extensible) |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc DefinitionTopic (Example) | |
contributor | 0..* | Contributor | A content contributor | |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |
library | 0..* | Reference(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 is risk adjustment applied for this measure |
rateAggregation | Σ | 0..1 | string | How is rate aggregation performed for this measure |
rationale | Σ | 0..1 | markdown | Why does this measure exist |
clinicalRecommendationStatement | Σ | 0..1 | markdown | Summary of clinical guidelines |
improvementNotation | Σ | 0..1 | string | Improvement notation for the measure, e.g. higher score indicates better quality |
definition | Σ | 0..* | markdown | Defined terms used in the measure documentation |
guidance | Σ | 0..1 | markdown | Additional guidance for implementers |
set | Σ | 0..1 | string | The measure set, e.g. Preventive Care and Screening |
group | 0..* | BackboneElement | Population criteria group | |
identifier | 1..1 | Identifier | Unique identifier | |
name | 0..1 | string | Short name | |
description | 0..1 | string | Summary description | |
population | 0..* | BackboneElement | Population criteria | |
identifier | 0..1 | Identifier | Unique identifier | |
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) | |
name | 0..1 | string | Short name | |
description | 0..1 | string | The human readable description of this population criteria | |
criteria | 1..1 | string | The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria | |
stratifier | 0..* | BackboneElement | Stratifier criteria for the measure | |
identifier | 0..1 | Identifier | The identifier for the stratifier used to coordinate the reported data back to this stratifier | |
criteria | 0..1 | string | How the measure should be stratified | |
path | 0..1 | string | Path to the stratifier | |
supplementalData | 0..* | BackboneElement | What other data should be reported with the measure | |
identifier | 0..1 | Identifier | Identifier, unique within the measure | |
usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor MeasureDataUsage (Extensible) | |
criteria | 0..1 | string | Expression describing additional data to be reported | |
path | 0..1 | string | Path to the supplemental data element | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<Measure xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical URI to reference this measure (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) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date this was last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <description value="[markdown]"/><!-- 0..1 Natural language description of the measure --> <purpose value="[markdown]"/><!-- 0..1 Why this measure is defined --> <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the measure --> <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> <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for measure (if applicable) --></jurisdiction> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <contributor><!-- 0..* Contributor A content contributor --></contributor> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <library><!-- 0..* Reference(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 is risk adjustment applied for this measure --> <rateAggregation value="[string]"/><!-- 0..1 How is rate aggregation performed for this measure --> <rationale value="[markdown]"/><!-- 0..1 Why does this measure exist --> <clinicalRecommendationStatement value="[markdown]"/><!-- 0..1 Summary of clinical guidelines --> <improvementNotation value="[string]"/><!-- 0..1 Improvement notation for the measure, e.g. higher score indicates better quality --> <definition value="[markdown]"/><!-- 0..* Defined terms used in the measure documentation --> <guidance value="[markdown]"/><!-- 0..1 Additional guidance for implementers --> <set value="[string]"/><!-- 0..1 The measure set, e.g. Preventive Care and Screening --> <group> <!-- 0..* Population criteria group --> <identifier><!-- 1..1 Identifier Unique identifier --></identifier> <name value="[string]"/><!-- 0..1 Short name --> <description value="[string]"/><!-- 0..1 Summary description --> <population> <!-- 0..* Population criteria --> <identifier><!-- 0..1 Identifier Unique identifier --></identifier> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <name value="[string]"/><!-- 0..1 Short name --> <description value="[string]"/><!-- 0..1 The human readable description of this population criteria --> <criteria value="[string]"/><!-- 1..1 The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria --> </population> <stratifier> <!-- 0..* Stratifier criteria for the measure --> <identifier><!-- 0..1 Identifier The identifier for the stratifier used to coordinate the reported data back to this stratifier --></identifier> <criteria value="[string]"/><!-- 0..1 How the measure should be stratified --> <path value="[string]"/><!-- 0..1 Path to the stratifier --> </stratifier> </group> <supplementalData> <!-- 0..* What other data should be reported with the measure --> <identifier><!-- 0..1 Identifier Identifier, unique within the measure --></identifier> <usage><!-- 0..* CodeableConcept supplemental-data | risk-adjustment-factor --></usage> <criteria value="[string]"/><!-- 0..1 Expression describing additional data to be reported --> <path value="[string]"/><!-- 0..1 Path to the supplemental data element --> </supplementalData> </Measure>
JSON Template
{ "resourceType" : "Measure", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Logical URI to reference this measure (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the measure "version" : "<string>", // Business version of the measure "name" : "<string>", // Name for this measure (computer friendly) "title" : "<string>", // Name for this measure (human friendly) "status" : "<code>", // R! draft | active | retired | unknown "experimental" : <boolean>, // For testing purposes, not real usage "date" : "<dateTime>", // Date this was last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "description" : "<markdown>", // Natural language description of the measure "purpose" : "<markdown>", // Why this measure is defined "usage" : "<string>", // Describes the clinical usage of the measure "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 "useContext" : [{ UsageContext }], // Context the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for measure (if applicable) "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc "contributor" : [{ Contributor }], // A content contributor "contact" : [{ ContactDetail }], // Contact details for the publisher "copyright" : "<markdown>", // Use and/or publishing restrictions "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc "library" : [{ Reference(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 is risk adjustment applied for this measure "rateAggregation" : "<string>", // How is rate aggregation performed for this measure "rationale" : "<markdown>", // Why does this measure exist "clinicalRecommendationStatement" : "<markdown>", // Summary of clinical guidelines "improvementNotation" : "<string>", // Improvement notation for the measure, e.g. higher score indicates better quality "definition" : ["<markdown>"], // Defined terms used in the measure documentation "guidance" : "<markdown>", // Additional guidance for implementers "set" : "<string>", // The measure set, e.g. Preventive Care and Screening "group" : [{ // Population criteria group "identifier" : { Identifier }, // R! Unique identifier "name" : "<string>", // Short name "description" : "<string>", // Summary description "population" : [{ // Population criteria "identifier" : { Identifier }, // Unique identifier "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation "name" : "<string>", // Short name "description" : "<string>", // The human readable description of this population criteria "criteria" : "<string>" // R! The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria }], "stratifier" : [{ // Stratifier criteria for the measure "identifier" : { Identifier }, // The identifier for the stratifier used to coordinate the reported data back to this stratifier "criteria" : "<string>", // How the measure should be stratified "path" : "<string>" // Path to the stratifier }] }], "supplementalData" : [{ // What other data should be reported with the measure "identifier" : { Identifier }, // Identifier, unique within the measure "usage" : [{ CodeableConcept }], // supplemental-data | risk-adjustment-factor "criteria" : "<string>", // Expression describing additional data to be reported "path" : "<string>" // Path to the supplemental data element }] }
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 # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Measure.url [ uri ]; # 0..1 Logical URI to reference this measure (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.status [ code ]; # 1..1 draft | active | retired | unknown fhir:Measure.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:Measure.date [ dateTime ]; # 0..1 Date this was last changed fhir:Measure.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:Measure.description [ markdown ]; # 0..1 Natural language description of the measure 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.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.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support fhir:Measure.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for measure (if applicable) fhir:Measure.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc fhir:Measure.contributor [ Contributor ], ... ; # 0..* A content contributor fhir:Measure.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:Measure.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:Measure.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc fhir:Measure.library [ Reference(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 is risk adjustment applied for this measure fhir:Measure.rateAggregation [ string ]; # 0..1 How is rate aggregation performed for this measure fhir:Measure.rationale [ markdown ]; # 0..1 Why does this measure exist fhir:Measure.clinicalRecommendationStatement [ markdown ]; # 0..1 Summary of clinical guidelines fhir:Measure.improvementNotation [ string ]; # 0..1 Improvement notation for the measure, e.g. higher score indicates better quality fhir:Measure.definition [ markdown ], ... ; # 0..* Defined terms used in the measure documentation fhir:Measure.guidance [ markdown ]; # 0..1 Additional guidance for implementers fhir:Measure.set [ string ]; # 0..1 The measure set, e.g. Preventive Care and Screening fhir:Measure.group [ # 0..* Population criteria group fhir:Measure.group.identifier [ Identifier ]; # 1..1 Unique identifier fhir:Measure.group.name [ string ]; # 0..1 Short name fhir:Measure.group.description [ string ]; # 0..1 Summary description fhir:Measure.group.population [ # 0..* Population criteria fhir:Measure.group.population.identifier [ Identifier ]; # 0..1 Unique identifier 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.name [ string ]; # 0..1 Short name fhir:Measure.group.population.description [ string ]; # 0..1 The human readable description of this population criteria fhir:Measure.group.population.criteria [ string ]; # 1..1 The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria ], ...; fhir:Measure.group.stratifier [ # 0..* Stratifier criteria for the measure fhir:Measure.group.stratifier.identifier [ Identifier ]; # 0..1 The identifier for the stratifier used to coordinate the reported data back to this stratifier fhir:Measure.group.stratifier.criteria [ string ]; # 0..1 How the measure should be stratified fhir:Measure.group.stratifier.path [ string ]; # 0..1 Path to the stratifier ], ...; ], ...; fhir:Measure.supplementalData [ # 0..* What other data should be reported with the measure fhir:Measure.supplementalData.identifier [ Identifier ]; # 0..1 Identifier, unique within the measure fhir:Measure.supplementalData.usage [ CodeableConcept ], ... ; # 0..* supplemental-data | risk-adjustment-factor fhir:Measure.supplementalData.criteria [ string ]; # 0..1 Expression describing additional data to be reported fhir:Measure.supplementalData.path [ string ]; # 0..1 Path to the supplemental data element ], ...; ]
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | DomainResource | A quality measure definition Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
url | Σ | 0..1 | uri | Logical URI to reference this measure (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the measure |
version | Σ | 0..1 | string | Business version of the measure |
name | Σ | 0..1 | string | Name for this measure (computer friendly) |
title | Σ | 0..1 | string | Name for this measure (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date this was last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
description | Σ | 0..1 | markdown | Natural language description of the measure |
purpose | 0..1 | markdown | Why this measure is defined | |
usage | 0..1 | string | Describes the clinical usage of the measure | |
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 |
useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Jurisdiction ValueSet (Extensible) |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc DefinitionTopic (Example) | |
contributor | 0..* | Contributor | A content contributor | |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |
library | 0..* | Reference(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 is risk adjustment applied for this measure |
rateAggregation | Σ | 0..1 | string | How is rate aggregation performed for this measure |
rationale | Σ | 0..1 | markdown | Why does this measure exist |
clinicalRecommendationStatement | Σ | 0..1 | markdown | Summary of clinical guidelines |
improvementNotation | Σ | 0..1 | string | Improvement notation for the measure, e.g. higher score indicates better quality |
definition | Σ | 0..* | markdown | Defined terms used in the measure documentation |
guidance | Σ | 0..1 | markdown | Additional guidance for implementers |
set | Σ | 0..1 | string | The measure set, e.g. Preventive Care and Screening |
group | 0..* | BackboneElement | Population criteria group | |
identifier | 1..1 | Identifier | Unique identifier | |
name | 0..1 | string | Short name | |
description | 0..1 | string | Summary description | |
population | 0..* | BackboneElement | Population criteria | |
identifier | 0..1 | Identifier | Unique identifier | |
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) | |
name | 0..1 | string | Short name | |
description | 0..1 | string | The human readable description of this population criteria | |
criteria | 1..1 | string | The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria | |
stratifier | 0..* | BackboneElement | Stratifier criteria for the measure | |
identifier | 0..1 | Identifier | The identifier for the stratifier used to coordinate the reported data back to this stratifier | |
criteria | 0..1 | string | How the measure should be stratified | |
path | 0..1 | string | Path to the stratifier | |
supplementalData | 0..* | BackboneElement | What other data should be reported with the measure | |
identifier | 0..1 | Identifier | Identifier, unique within the measure | |
usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor MeasureDataUsage (Extensible) | |
criteria | 0..1 | string | Expression describing additional data to be reported | |
path | 0..1 | string | Path to the supplemental data element | |
Documentation for this format |
XML Template
<Measure xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical URI to reference this measure (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) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date this was last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <description value="[markdown]"/><!-- 0..1 Natural language description of the measure --> <purpose value="[markdown]"/><!-- 0..1 Why this measure is defined --> <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the measure --> <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> <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for measure (if applicable) --></jurisdiction> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <contributor><!-- 0..* Contributor A content contributor --></contributor> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <library><!-- 0..* Reference(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 is risk adjustment applied for this measure --> <rateAggregation value="[string]"/><!-- 0..1 How is rate aggregation performed for this measure --> <rationale value="[markdown]"/><!-- 0..1 Why does this measure exist --> <clinicalRecommendationStatement value="[markdown]"/><!-- 0..1 Summary of clinical guidelines --> <improvementNotation value="[string]"/><!-- 0..1 Improvement notation for the measure, e.g. higher score indicates better quality --> <definition value="[markdown]"/><!-- 0..* Defined terms used in the measure documentation --> <guidance value="[markdown]"/><!-- 0..1 Additional guidance for implementers --> <set value="[string]"/><!-- 0..1 The measure set, e.g. Preventive Care and Screening --> <group> <!-- 0..* Population criteria group --> <identifier><!-- 1..1 Identifier Unique identifier --></identifier> <name value="[string]"/><!-- 0..1 Short name --> <description value="[string]"/><!-- 0..1 Summary description --> <population> <!-- 0..* Population criteria --> <identifier><!-- 0..1 Identifier Unique identifier --></identifier> <code><!-- 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <name value="[string]"/><!-- 0..1 Short name --> <description value="[string]"/><!-- 0..1 The human readable description of this population criteria --> <criteria value="[string]"/><!-- 1..1 The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria --> </population> <stratifier> <!-- 0..* Stratifier criteria for the measure --> <identifier><!-- 0..1 Identifier The identifier for the stratifier used to coordinate the reported data back to this stratifier --></identifier> <criteria value="[string]"/><!-- 0..1 How the measure should be stratified --> <path value="[string]"/><!-- 0..1 Path to the stratifier --> </stratifier> </group> <supplementalData> <!-- 0..* What other data should be reported with the measure --> <identifier><!-- 0..1 Identifier Identifier, unique within the measure --></identifier> <usage><!-- 0..* CodeableConcept supplemental-data | risk-adjustment-factor --></usage> <criteria value="[string]"/><!-- 0..1 Expression describing additional data to be reported --> <path value="[string]"/><!-- 0..1 Path to the supplemental data element --> </supplementalData> </Measure>
JSON Template
{ "resourceType" : "Measure", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Logical URI to reference this measure (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the measure "version" : "<string>", // Business version of the measure "name" : "<string>", // Name for this measure (computer friendly) "title" : "<string>", // Name for this measure (human friendly) "status" : "<code>", // R! draft | active | retired | unknown "experimental" : <boolean>, // For testing purposes, not real usage "date" : "<dateTime>", // Date this was last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "description" : "<markdown>", // Natural language description of the measure "purpose" : "<markdown>", // Why this measure is defined "usage" : "<string>", // Describes the clinical usage of the measure "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 "useContext" : [{ UsageContext }], // Context the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for measure (if applicable) "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc "contributor" : [{ Contributor }], // A content contributor "contact" : [{ ContactDetail }], // Contact details for the publisher "copyright" : "<markdown>", // Use and/or publishing restrictions "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc "library" : [{ Reference(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 is risk adjustment applied for this measure "rateAggregation" : "<string>", // How is rate aggregation performed for this measure "rationale" : "<markdown>", // Why does this measure exist "clinicalRecommendationStatement" : "<markdown>", // Summary of clinical guidelines "improvementNotation" : "<string>", // Improvement notation for the measure, e.g. higher score indicates better quality "definition" : ["<markdown>"], // Defined terms used in the measure documentation "guidance" : "<markdown>", // Additional guidance for implementers "set" : "<string>", // The measure set, e.g. Preventive Care and Screening "group" : [{ // Population criteria group "identifier" : { Identifier }, // R! Unique identifier "name" : "<string>", // Short name "description" : "<string>", // Summary description "population" : [{ // Population criteria "identifier" : { Identifier }, // Unique identifier "code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation "name" : "<string>", // Short name "description" : "<string>", // The human readable description of this population criteria "criteria" : "<string>" // R! The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria }], "stratifier" : [{ // Stratifier criteria for the measure "identifier" : { Identifier }, // The identifier for the stratifier used to coordinate the reported data back to this stratifier "criteria" : "<string>", // How the measure should be stratified "path" : "<string>" // Path to the stratifier }] }], "supplementalData" : [{ // What other data should be reported with the measure "identifier" : { Identifier }, // Identifier, unique within the measure "usage" : [{ CodeableConcept }], // supplemental-data | risk-adjustment-factor "criteria" : "<string>", // Expression describing additional data to be reported "path" : "<string>" // Path to the supplemental data element }] }
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 # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Measure.url [ uri ]; # 0..1 Logical URI to reference this measure (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.status [ code ]; # 1..1 draft | active | retired | unknown fhir:Measure.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:Measure.date [ dateTime ]; # 0..1 Date this was last changed fhir:Measure.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:Measure.description [ markdown ]; # 0..1 Natural language description of the measure 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.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.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support fhir:Measure.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for measure (if applicable) fhir:Measure.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc fhir:Measure.contributor [ Contributor ], ... ; # 0..* A content contributor fhir:Measure.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:Measure.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:Measure.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc fhir:Measure.library [ Reference(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 is risk adjustment applied for this measure fhir:Measure.rateAggregation [ string ]; # 0..1 How is rate aggregation performed for this measure fhir:Measure.rationale [ markdown ]; # 0..1 Why does this measure exist fhir:Measure.clinicalRecommendationStatement [ markdown ]; # 0..1 Summary of clinical guidelines fhir:Measure.improvementNotation [ string ]; # 0..1 Improvement notation for the measure, e.g. higher score indicates better quality fhir:Measure.definition [ markdown ], ... ; # 0..* Defined terms used in the measure documentation fhir:Measure.guidance [ markdown ]; # 0..1 Additional guidance for implementers fhir:Measure.set [ string ]; # 0..1 The measure set, e.g. Preventive Care and Screening fhir:Measure.group [ # 0..* Population criteria group fhir:Measure.group.identifier [ Identifier ]; # 1..1 Unique identifier fhir:Measure.group.name [ string ]; # 0..1 Short name fhir:Measure.group.description [ string ]; # 0..1 Summary description fhir:Measure.group.population [ # 0..* Population criteria fhir:Measure.group.population.identifier [ Identifier ]; # 0..1 Unique identifier 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.name [ string ]; # 0..1 Short name fhir:Measure.group.population.description [ string ]; # 0..1 The human readable description of this population criteria fhir:Measure.group.population.criteria [ string ]; # 1..1 The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria ], ...; fhir:Measure.group.stratifier [ # 0..* Stratifier criteria for the measure fhir:Measure.group.stratifier.identifier [ Identifier ]; # 0..1 The identifier for the stratifier used to coordinate the reported data back to this stratifier fhir:Measure.group.stratifier.criteria [ string ]; # 0..1 How the measure should be stratified fhir:Measure.group.stratifier.path [ string ]; # 0..1 Path to the stratifier ], ...; ], ...; fhir:Measure.supplementalData [ # 0..* What other data should be reported with the measure fhir:Measure.supplementalData.identifier [ Identifier ]; # 0..1 Identifier, unique within the measure fhir:Measure.supplementalData.usage [ CodeableConcept ], ... ; # 0..* supplemental-data | risk-adjustment-factor fhir:Measure.supplementalData.criteria [ string ]; # 0..1 Expression describing additional data to be reported fhir:Measure.supplementalData.path [ string ]; # 0..1 Path to the supplemental data element ], ...; ]
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
Path | Definition | Type | Reference |
---|---|---|---|
Measure.status | The lifecycle status of a Value Set or Concept Map. | Required | PublicationStatus |
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.group.population.code | The type of population | Extensible | MeasurePopulationType |
Measure.supplementalData.usage | The intended usage for supplemental data elements in the measure | Extensible | MeasureDataUsage |
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) | |
date | 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 | 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 | string | Computationally friendly name of the measure | Measure.name | |
predecessor | reference | What resource is being referenced | Measure.relatedArtifact.where(type='predecessor').resource (Any) | |
publisher | string | Name of the publisher of the measure | Measure.publisher | |
status | token | The current status of the measure | Measure.status | |
successor | reference | What resource is being referenced | Measure.relatedArtifact.where(type='successor').resource (Any) | |
title | string | The human-friendly name of the measure | Measure.title | |
topic | token | Topics associated with the module | Measure.topic | |
url | uri | The uri that identifies the measure | Measure.url | |
version | token | The business version of the measure | Measure.version |