This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Clinical Quality Information Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/shareablemeasure
Enforces the minimum information set for the measure metadata required by HL7 and other organizations that share and publish measures
This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This indicates the differences between this profile and the base Measure structure.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | 1..1 | Measure | A quality measure definition | |
url | 1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | |
identifier | S | 0..* | Identifier | Additional identifier for the measure |
version | 1..1 | string | Business version of the measure | |
name | 1..1 | string | Name for this measure (computer friendly) | |
title | S | 0..1 | string | Name for this measure (human friendly) |
experimental | 1..1 | boolean | For testing purposes, not real usage | |
date | S | 0..1 | dateTime | Date last changed |
publisher | 1..1 | string | Name of the publisher/steward (organization or individual) | |
contact | S | 0..* | ContactDetail | Contact details for the publisher |
description | 1..1 | markdown | Natural language description of the measure | |
useContext | S | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | S | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) |
Documentation for this format |
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Measure structure.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Measure | C | 1..1 | Measure | A quality measure definition | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred): IETF language tag
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | ΣC | 1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | ||||
identifier | SΣ | 0..* | Identifier | Additional identifier for the measure | ||||
version | Σ | 1..1 | string | Business version of the measure | ||||
name | ΣC | 1..1 | string | Name for this measure (computer friendly) | ||||
title | SΣ | 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 Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
subject[x] | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: Participant Resource Types (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
basis | Σ | 0..1 | code | Population basis Binding: All FHIR Types (required) | ||||
date | SΣ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher/steward (organization or individual) | ||||
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 1..1 | markdown | Natural language description of the measure | ||||
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction (extensible): Countries and regions within which this artifact is targeted for use. | ||||
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. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
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 Binding: MeasureScoring (extensible): The scoring type of the measure. | ||||
scoringUnit | Σ | 0..1 | CodeableConcept | What units? Binding: Measure Scoring Unit (example) | ||||
compositeScoring | Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure. | ||||
type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible): The type of measure (includes codes from 2.16.840.1.113883.1.11.20368). | ||||
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 Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. | ||||
term | 0..* | BackboneElement | Defined terms used in the measure documentation | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | What term? Binding: MeasureDefinitionExample (example): Codeable representations of measure definition terms. | |||||
definition | 0..1 | markdown | Meaning of the term | |||||
guidance | Σ | 0..1 | markdown | Additional guidance for implementers | ||||
group | 0..* | BackboneElement | Population criteria group | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Meaning of the group Binding: MeasureGroupExample (example): Example of measure groups. | |||||
description | 0..1 | string | Summary description | |||||
type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) | ||||
basis | Σ | 0..1 | code | Population basis Binding: All FHIR Types (required) | ||||
scoring | Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible) | ||||
scoringUnit | Σ | 0..1 | CodeableConcept | What units? Binding: Measure Scoring Unit (example) | ||||
improvementNotation | Σ | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required) | ||||
population | 0..* | BackboneElement | Population criteria | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible): The type of population. | |||||
description | 0..1 | string | The human readable description of this population criteria | |||||
criteria | 1..1 | Expression | The criteria that defines this population | |||||
inputPopulationId | 0..1 | string | Which population | |||||
aggregateMethod | 0..1 | CodeableConcept | Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count) Binding: Measure Aggregate Method (extensible) | |||||
stratifier | 0..* | BackboneElement | Stratifier criteria for the measure | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Meaning of the stratifier Binding: MeasureStratifierExample (example): 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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Meaning of the stratifier component Binding: MeasureStratifierExample (example): Meaning of the stratifier. | |||||
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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureSupplementalDataExample (example): Meaning of the supplemental data. | |||||
usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure. | |||||
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 |
<!-- Shareable Measure --> <Measure xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this measure, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the measure --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the measure --> <name value="[string]"/><!-- I 1..1 Name for this measure (computer friendly) --> <title value="[string]"/><!-- I 0..1 Name for this measure (human friendly) --> <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the measure --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage --> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]> <basis value="[code]"/><!-- I 0..1 Population basis --> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 1..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the measure --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for measure (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this measure is defined --> <usage value="[string]"/><!-- I 0..1 Describes the clinical usage of the measure --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- I 0..1 When the measure was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the measure was last reviewed --> <effectivePeriod><!-- I 0..1 Period When the measure is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc. --></topic> <author><!-- I 0..* ContactDetail Who authored the content --></author> <editor><!-- I 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <library value="[canonical]"/><!-- I 0..* Logic used by the measure --> <disclaimer value="[markdown]"/><!-- I 0..1 Disclaimer for use of the measure or its referenced content --> <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort --></scoring> <scoringUnit><!-- I 0..1 CodeableConcept What units? --></scoringUnit> <compositeScoring><!-- I 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted --></compositeScoring> <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <riskAdjustment value="[string]"/><!-- I 0..1 How risk adjustment is applied for this measure --> <rateAggregation value="[string]"/><!-- I 0..1 How is rate aggregation performed for this measure --> <rationale value="[markdown]"/><!-- I 0..1 Detailed description of why the measure exists --> <clinicalRecommendationStatement value="[markdown]"/><!-- I 0..1 Summary of clinical guidelines --> <improvementNotation><!-- I 0..1 CodeableConcept increase | decrease --></improvementNotation> <term> I 0..* BackboneElement <!-- I 0..* Defined terms used in the measure documentation --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept What term? --></code> <definition value="[markdown]"/><!-- I 0..1 Meaning of the term --> </term> <guidance value="[markdown]"/><!-- I 0..1 Additional guidance for implementers --> <group> I 0..* BackboneElement <!-- I 0..* Population criteria group --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept Meaning of the group --></code> <description value="[string]"/><!-- I 0..1 Summary description --> <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <basis value="[code]"/><!-- I 0..1 Population basis --> <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort --></scoring> <scoringUnit><!-- I 0..1 CodeableConcept What units? --></scoringUnit> <improvementNotation><!-- I 0..1 CodeableConcept increase | decrease --></improvementNotation> <population> I 0..* BackboneElement <!-- I 0..* Population criteria --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <description value="[string]"/><!-- I 0..1 The human readable description of this population criteria --> <criteria><!-- I 1..1 Expression The criteria that defines this population --></criteria> <inputPopulationId value="[string]"/><!-- I 0..1 Which population --> <aggregateMethod><!-- I 0..1 CodeableConcept Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count) --></aggregateMethod> </population> <stratifier> I 0..* BackboneElement <!-- I 0..* Stratifier criteria for the measure --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept Meaning of the stratifier --></code> <description value="[string]"/><!-- I 0..1 The human readable description of this stratifier --> <criteria><!-- I 0..1 Expression How the measure should be stratified --></criteria> <component> I 0..* BackboneElement <!-- I 0..* Stratifier criteria component for the measure --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept Meaning of the stratifier component --></code> <description value="[string]"/><!-- I 0..1 The human readable description of this stratifier component --> <criteria><!-- I 1..1 Expression Component of how the measure should be stratified --></criteria> </component> </stratifier> </group> <supplementalData> I 0..* BackboneElement <!-- I 0..* What other data should be reported with the measure --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept Meaning of the supplemental data --></code> <usage><!-- I 0..* CodeableConcept supplemental-data | risk-adjustment-factor --></usage> <description value="[string]"/><!-- I 0..1 The human readable description of this supplemental data --> <criteria><!-- I 1..1 Expression Expression describing additional data to be reported --></criteria> </supplementalData> </Measure>
{ // Shareable Measure // from Element: extension "meta" : { Meta }, // IMetadata about the resource "implicitRules" : "<uri>", // IA set of rules under which this content was created "language" : "<code>", // ILanguage of the resource content "text" : { Narrative }, // IText summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored "url" : "<uri>", // I R! Canonical identifier for this measure, represented as a URI (globally unique) "identifier" : [{ Identifier }], // IAdditional identifier for the measure "version" : "<string>", // I R! Business version of the measure "name" : "<string>", // I R! Name for this measure (computer friendly) "title" : "<string>", // IName for this measure (human friendly) "subtitle" : "<string>", // ISubordinate title of the measure "status" : "<code>", // I R! draft | active | retired | unknown "experimental" : <boolean>, // I R! For testing purposes, not real usage // value[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2: "subjectCodeableConcept" : { CodeableConcept }, // IE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device "subjectReference" : { Reference(Group) }, // IE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device "basis" : "<code>", // IPopulation basis "date" : "<dateTime>", // IDate last changed "publisher" : "<string>", // I R! Name of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // IContact details for the publisher "description" : "<markdown>", // I R! Natural language description of the measure "useContext" : [{ UsageContext }], // IThe context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for measure (if applicable) "purpose" : "<markdown>", // IWhy this measure is defined "usage" : "<string>", // IDescribes the clinical usage of the measure "copyright" : "<markdown>", // IUse and/or publishing restrictions "approvalDate" : "<date>", // IWhen the measure was approved by publisher "lastReviewDate" : "<date>", // IWhen the measure was last reviewed "effectivePeriod" : { Period }, // IWhen the measure is expected to be used "topic" : [{ CodeableConcept }], // IThe category of the measure, such as Education, Treatment, Assessment, etc. "author" : [{ ContactDetail }], // IWho authored the content "editor" : [{ ContactDetail }], // IWho edited the content "reviewer" : [{ ContactDetail }], // IWho reviewed the content "endorser" : [{ ContactDetail }], // IWho endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc. "library" : ["<canonical>"], // ILogic used by the measure "disclaimer" : "<markdown>", // IDisclaimer for use of the measure or its referenced content "scoring" : { CodeableConcept }, // Iproportion | ratio | continuous-variable | cohort "scoringUnit" : { CodeableConcept }, // IWhat units? "compositeScoring" : { CodeableConcept }, // Iopportunity | all-or-nothing | linear | weighted "type" : [{ CodeableConcept }], // Iprocess | outcome | structure | patient-reported-outcome | composite "riskAdjustment" : "<string>", // IHow risk adjustment is applied for this measure "rateAggregation" : "<string>", // IHow is rate aggregation performed for this measure "rationale" : "<markdown>", // IDetailed description of why the measure exists "clinicalRecommendationStatement" : "<markdown>", // ISummary of clinical guidelines "improvementNotation" : { CodeableConcept }, // Iincrease | decrease "term" : [{ BackboneElement }], // IDefined terms used in the measure documentation "guidance" : "<markdown>", // IAdditional guidance for implementers "group" : [{ BackboneElement }], // IPopulation criteria group "supplementalData" : [{ BackboneElement }] // IWhat other data should be reported with the measure }
This structure is derived from Measure.
Differential View
This indicates the differences between this profile and the base Measure structure.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | 1..1 | Measure | A quality measure definition | |
url | 1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | |
identifier | S | 0..* | Identifier | Additional identifier for the measure |
version | 1..1 | string | Business version of the measure | |
name | 1..1 | string | Name for this measure (computer friendly) | |
title | S | 0..1 | string | Name for this measure (human friendly) |
experimental | 1..1 | boolean | For testing purposes, not real usage | |
date | S | 0..1 | dateTime | Date last changed |
publisher | 1..1 | string | Name of the publisher/steward (organization or individual) | |
contact | S | 0..* | ContactDetail | Contact details for the publisher |
description | 1..1 | markdown | Natural language description of the measure | |
useContext | S | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | S | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) |
Documentation for this format |
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Measure structure.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Measure | C | 1..1 | Measure | A quality measure definition | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred): IETF language tag
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | ΣC | 1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | ||||
identifier | SΣ | 0..* | Identifier | Additional identifier for the measure | ||||
version | Σ | 1..1 | string | Business version of the measure | ||||
name | ΣC | 1..1 | string | Name for this measure (computer friendly) | ||||
title | SΣ | 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 Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
subject[x] | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: Participant Resource Types (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
basis | Σ | 0..1 | code | Population basis Binding: All FHIR Types (required) | ||||
date | SΣ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher/steward (organization or individual) | ||||
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 1..1 | markdown | Natural language description of the measure | ||||
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction (extensible): Countries and regions within which this artifact is targeted for use. | ||||
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. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
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 Binding: MeasureScoring (extensible): The scoring type of the measure. | ||||
scoringUnit | Σ | 0..1 | CodeableConcept | What units? Binding: Measure Scoring Unit (example) | ||||
compositeScoring | Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure. | ||||
type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible): The type of measure (includes codes from 2.16.840.1.113883.1.11.20368). | ||||
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 Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. | ||||
term | 0..* | BackboneElement | Defined terms used in the measure documentation | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | What term? Binding: MeasureDefinitionExample (example): Codeable representations of measure definition terms. | |||||
definition | 0..1 | markdown | Meaning of the term | |||||
guidance | Σ | 0..1 | markdown | Additional guidance for implementers | ||||
group | 0..* | BackboneElement | Population criteria group | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Meaning of the group Binding: MeasureGroupExample (example): Example of measure groups. | |||||
description | 0..1 | string | Summary description | |||||
type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) | ||||
basis | Σ | 0..1 | code | Population basis Binding: All FHIR Types (required) | ||||
scoring | Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible) | ||||
scoringUnit | Σ | 0..1 | CodeableConcept | What units? Binding: Measure Scoring Unit (example) | ||||
improvementNotation | Σ | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required) | ||||
population | 0..* | BackboneElement | Population criteria | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible): The type of population. | |||||
description | 0..1 | string | The human readable description of this population criteria | |||||
criteria | 1..1 | Expression | The criteria that defines this population | |||||
inputPopulationId | 0..1 | string | Which population | |||||
aggregateMethod | 0..1 | CodeableConcept | Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count) Binding: Measure Aggregate Method (extensible) | |||||
stratifier | 0..* | BackboneElement | Stratifier criteria for the measure | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Meaning of the stratifier Binding: MeasureStratifierExample (example): 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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Meaning of the stratifier component Binding: MeasureStratifierExample (example): Meaning of the stratifier. | |||||
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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureSupplementalDataExample (example): Meaning of the supplemental data. | |||||
usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure. | |||||
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
<!-- Shareable Measure --> <Measure xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this measure, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the measure --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the measure --> <name value="[string]"/><!-- I 1..1 Name for this measure (computer friendly) --> <title value="[string]"/><!-- I 0..1 Name for this measure (human friendly) --> <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the measure --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage --> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]> <basis value="[code]"/><!-- I 0..1 Population basis --> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 1..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the measure --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for measure (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this measure is defined --> <usage value="[string]"/><!-- I 0..1 Describes the clinical usage of the measure --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- I 0..1 When the measure was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the measure was last reviewed --> <effectivePeriod><!-- I 0..1 Period When the measure is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc. --></topic> <author><!-- I 0..* ContactDetail Who authored the content --></author> <editor><!-- I 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <library value="[canonical]"/><!-- I 0..* Logic used by the measure --> <disclaimer value="[markdown]"/><!-- I 0..1 Disclaimer for use of the measure or its referenced content --> <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort --></scoring> <scoringUnit><!-- I 0..1 CodeableConcept What units? --></scoringUnit> <compositeScoring><!-- I 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted --></compositeScoring> <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <riskAdjustment value="[string]"/><!-- I 0..1 How risk adjustment is applied for this measure --> <rateAggregation value="[string]"/><!-- I 0..1 How is rate aggregation performed for this measure --> <rationale value="[markdown]"/><!-- I 0..1 Detailed description of why the measure exists --> <clinicalRecommendationStatement value="[markdown]"/><!-- I 0..1 Summary of clinical guidelines --> <improvementNotation><!-- I 0..1 CodeableConcept increase | decrease --></improvementNotation> <term> I 0..* BackboneElement <!-- I 0..* Defined terms used in the measure documentation --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept What term? --></code> <definition value="[markdown]"/><!-- I 0..1 Meaning of the term --> </term> <guidance value="[markdown]"/><!-- I 0..1 Additional guidance for implementers --> <group> I 0..* BackboneElement <!-- I 0..* Population criteria group --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept Meaning of the group --></code> <description value="[string]"/><!-- I 0..1 Summary description --> <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <basis value="[code]"/><!-- I 0..1 Population basis --> <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort --></scoring> <scoringUnit><!-- I 0..1 CodeableConcept What units? --></scoringUnit> <improvementNotation><!-- I 0..1 CodeableConcept increase | decrease --></improvementNotation> <population> I 0..* BackboneElement <!-- I 0..* Population criteria --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <description value="[string]"/><!-- I 0..1 The human readable description of this population criteria --> <criteria><!-- I 1..1 Expression The criteria that defines this population --></criteria> <inputPopulationId value="[string]"/><!-- I 0..1 Which population --> <aggregateMethod><!-- I 0..1 CodeableConcept Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count) --></aggregateMethod> </population> <stratifier> I 0..* BackboneElement <!-- I 0..* Stratifier criteria for the measure --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept Meaning of the stratifier --></code> <description value="[string]"/><!-- I 0..1 The human readable description of this stratifier --> <criteria><!-- I 0..1 Expression How the measure should be stratified --></criteria> <component> I 0..* BackboneElement <!-- I 0..* Stratifier criteria component for the measure --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept Meaning of the stratifier component --></code> <description value="[string]"/><!-- I 0..1 The human readable description of this stratifier component --> <criteria><!-- I 1..1 Expression Component of how the measure should be stratified --></criteria> </component> </stratifier> </group> <supplementalData> I 0..* BackboneElement <!-- I 0..* What other data should be reported with the measure --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept Meaning of the supplemental data --></code> <usage><!-- I 0..* CodeableConcept supplemental-data | risk-adjustment-factor --></usage> <description value="[string]"/><!-- I 0..1 The human readable description of this supplemental data --> <criteria><!-- I 1..1 Expression Expression describing additional data to be reported --></criteria> </supplementalData> </Measure>
JSON Template
{ // Shareable Measure // from Element: extension "meta" : { Meta }, // IMetadata about the resource "implicitRules" : "<uri>", // IA set of rules under which this content was created "language" : "<code>", // ILanguage of the resource content "text" : { Narrative }, // IText summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored "url" : "<uri>", // I R! Canonical identifier for this measure, represented as a URI (globally unique) "identifier" : [{ Identifier }], // IAdditional identifier for the measure "version" : "<string>", // I R! Business version of the measure "name" : "<string>", // I R! Name for this measure (computer friendly) "title" : "<string>", // IName for this measure (human friendly) "subtitle" : "<string>", // ISubordinate title of the measure "status" : "<code>", // I R! draft | active | retired | unknown "experimental" : <boolean>, // I R! For testing purposes, not real usage // value[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2: "subjectCodeableConcept" : { CodeableConcept }, // IE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device "subjectReference" : { Reference(Group) }, // IE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device "basis" : "<code>", // IPopulation basis "date" : "<dateTime>", // IDate last changed "publisher" : "<string>", // I R! Name of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // IContact details for the publisher "description" : "<markdown>", // I R! Natural language description of the measure "useContext" : [{ UsageContext }], // IThe context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for measure (if applicable) "purpose" : "<markdown>", // IWhy this measure is defined "usage" : "<string>", // IDescribes the clinical usage of the measure "copyright" : "<markdown>", // IUse and/or publishing restrictions "approvalDate" : "<date>", // IWhen the measure was approved by publisher "lastReviewDate" : "<date>", // IWhen the measure was last reviewed "effectivePeriod" : { Period }, // IWhen the measure is expected to be used "topic" : [{ CodeableConcept }], // IThe category of the measure, such as Education, Treatment, Assessment, etc. "author" : [{ ContactDetail }], // IWho authored the content "editor" : [{ ContactDetail }], // IWho edited the content "reviewer" : [{ ContactDetail }], // IWho reviewed the content "endorser" : [{ ContactDetail }], // IWho endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc. "library" : ["<canonical>"], // ILogic used by the measure "disclaimer" : "<markdown>", // IDisclaimer for use of the measure or its referenced content "scoring" : { CodeableConcept }, // Iproportion | ratio | continuous-variable | cohort "scoringUnit" : { CodeableConcept }, // IWhat units? "compositeScoring" : { CodeableConcept }, // Iopportunity | all-or-nothing | linear | weighted "type" : [{ CodeableConcept }], // Iprocess | outcome | structure | patient-reported-outcome | composite "riskAdjustment" : "<string>", // IHow risk adjustment is applied for this measure "rateAggregation" : "<string>", // IHow is rate aggregation performed for this measure "rationale" : "<markdown>", // IDetailed description of why the measure exists "clinicalRecommendationStatement" : "<markdown>", // ISummary of clinical guidelines "improvementNotation" : { CodeableConcept }, // Iincrease | decrease "term" : [{ BackboneElement }], // IDefined terms used in the measure documentation "guidance" : "<markdown>", // IAdditional guidance for implementers "group" : [{ BackboneElement }], // IPopulation criteria group "supplementalData" : [{ BackboneElement }] // IWhat other data should be reported with the measure }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
Measure.language | Common Languages | preferred | Common Languages |
Measure.status | PublicationStatus | required | PublicationStatus |
Measure.subject[x] | Participant Resource Types | extensible | Participant Resource Types |
Measure.basis | All FHIR Types | required | All FHIR Types |
Measure.jurisdiction | Jurisdiction | extensible | Jurisdiction |
Measure.topic | DefinitionTopic | example | DefinitionTopic |
Measure.scoring | MeasureScoring | extensible | MeasureScoring |
Measure.scoringUnit | Measure Scoring Unit | example | Measure Scoring Unit |
Measure.compositeScoring | CompositeMeasureScoring | extensible | CompositeMeasureScoring |
Measure.type | MeasureType | extensible | MeasureType |
Measure.improvementNotation | MeasureImprovementNotation | required | MeasureImprovementNotation |
Measure.term.code | MeasureDefinitionExample | example | MeasureDefinitionExample |
Measure.group.code | MeasureGroupExample | example | MeasureGroupExample |
Measure.group.type | MeasureType | extensible | MeasureType |
Measure.group.basis | All FHIR Types | required | All FHIR Types |
Measure.group.scoring | MeasureScoring | extensible | MeasureScoring |
Measure.group.scoringUnit | Measure Scoring Unit | example | Measure Scoring Unit |
Measure.group.improvementNotation | MeasureImprovementNotation | required | MeasureImprovementNotation |
Measure.group.population.code | MeasurePopulationType | extensible | MeasurePopulationType |
Measure.group.population.aggregateMethod | Measure Aggregate Method | extensible | Measure Aggregate Method |
Measure.group.stratifier.code | MeasureStratifierExample | example | MeasureStratifierExample |
Measure.group.stratifier.component.code | MeasureStratifierExample | example | MeasureStratifierExample |
Measure.supplementalData.code | MeasureSupplementalDataExample | example | MeasureSupplementalDataExample |
Measure.supplementalData.usage | MeasureDataUsage | extensible | MeasureDataUsage |