Release 5
Clinical ReasoningThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). 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
Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management
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 structure is derived from Measure.
Summary
Mandatory: 4 elements
Must-Support: 11 elements
Extensions
This structure refers to these extensions:
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 | |
  knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
 url | S | 1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
| version | S | 1..1 | string | Business version of the measure |
| versionAlgorithm[x] | S | 0..1 | string, Coding | How to compare versions |
| name | S | 0..1 | string | Name for this measure (computer friendly) |
| title | S | 1..1 | string | Name for this measure (human friendly) |
| experimental | S | 0..1 | boolean | For testing purposes, not real usage |
| publisher | S | 0..1 | string | Name of the publisher/steward (organization or individual) |
 description | S | 1..1 | markdown | Natural language description of the measure |
| 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: All Languages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣC | 1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
| identifier | Σ | 0..* | Identifier | Additional identifier for the measure |
| version | SΣ | 1..1 | string | Business version of the measure |
  versionAlgorithm[x] | SΣ | 0..1 | How to compare versions Binding: Version Algorithm (extensible) | |
 versionAlgorithmString | string | |||
| versionAlgorithmCoding | Coding | |||
| name | SΣC | 0..1 | string | Name for this measure (computer friendly) |
| title | SΣ | 1..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 | SΣ | 0..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 | Σ | 0..1 | dateTime | Date last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | SΣ | 1..1 | markdown | Natural language description of the measure |
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| purpose | 0..1 | markdown | Why this measure is defined | |
| usage | 0..1 | markdown | Describes the clinical usage of the measure | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| copyrightLabel | 0..1 | string | Copyright holder and year(s) | |
| approvalDate | 0..1 | date | When the measure was approved by publisher | |
| lastReviewDate | 0..1 | date | When the measure was last reviewed by the publisher | |
| effectivePeriod | Σ | 0..1 | Period | When the measure is expected to be used |
| topic | XD | 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc Binding: Definition Topic (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: Composite Measure Scoring (extensible): The composite scoring method of the measure. |
| type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: Measure Type (extensible): The type of measure (includes codes from 2.16.840.1.113883.1.11.20368). |
| riskAdjustment | Σ | 0..1 | markdown | How risk adjustment is applied for this measure |
| rateAggregation | Σ | 0..1 | markdown | 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: Measure Improvement Notation (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: Measure Definition Example (example): Codeable representations of measure definition terms. | |
| definition | 0..1 | markdown | Meaning of the term | |
| guidance | ΣXD | 0..1 | markdown | Additional guidance for implementers (deprecated) |
| group | C | 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 |
| linkId | C | 0..1 | string | Unique id for group in measure |
| code | 0..1 | CodeableConcept | Meaning of the group Binding: Measure Group Example (example): Example of measure groups. | |
| description | 0..1 | markdown | Summary description | |
| type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: Measure Type (extensible) |
| 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) |
| scoring | Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible) |
| scoringUnit | Σ | 0..1 | CodeableConcept | What units? Binding: Measure Scoring Unit (example) |
| rateAggregation | Σ | 0..1 | markdown | How is rate aggregation performed for this measure |
| improvementNotation | Σ | 0..1 | CodeableConcept | increase | decrease Binding: Measure Improvement Notation (required) |
| library | 0..* | canonical(Library) | Logic used by the measure group | |
| 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 |
| linkId | C | 0..1 | string | Unique id for population in measure |
| code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: Measure Population Type (extensible): The type of population. | |
| description | 0..1 | markdown | The human readable description of this population criteria | |
| criteria | 0..1 | Expression | The criteria that defines this population | |
| groupDefinition | 0..1 | Reference(Group) | A group resource 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 | C | 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 |
| linkId | C | 0..1 | string | Unique id for stratifier in measure |
| code | C | 0..1 | CodeableConcept | Meaning of the stratifier Binding: Measure Stratifier Example (example): Meaning of the stratifier. |
| description | C | 0..1 | markdown | The human readable description of this stratifier |
| criteria | C | 0..1 | Expression | How the measure should be stratified |
| groupDefinition | 0..1 | Reference(Group) | A group resource that defines this population | |
| component | C | 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 |
| linkId | C | 0..1 | string | Unique id for stratifier component in measure |
| code | 0..1 | CodeableConcept | Meaning of the stratifier component Binding: Measure Stratifier Example (example): Meaning of the stratifier. | |
| description | 0..1 | markdown | The human readable description of this stratifier component | |
| criteria | 0..1 | Expression | Component of how the measure should be stratified | |
| groupDefinition | 0..1 | Reference(Group) | A group resource that defines this population | |
| 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 |
| linkId | C | 0..1 | string | Unique id for supplementalData in measure |
| code | 0..1 | CodeableConcept | Meaning of the supplemental data Binding: Measure Supplemental Data Example (example): Meaning of the supplemental data. | |
| usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: Measure Data Usage (extensible): The intended usage for supplemental data elements in the measure. | |
| description | 0..1 | markdown | The human readable description of this supplemental data | |
| criteria | 1..1 | Expression | Expression describing additional data to be reported | |
| Documentation for this format | ||||
<!-- ShareableMeasure --><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 --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this measure (computer friendly) --> <title value="[string]"/><!-- I 1..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 0..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 0..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="[markdown]"/><!-- I 0..1 Describes the clinical usage of the measure --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <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 by the publisher --> <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
{ // ShareableMeasure
// 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
"extension" : [ // sliced by value:url in the specified order, Open
{ // shareable | computable | publishable | executable // I
// from Element: extension
},
{ // narrative | semi-structured | structured | executable // I
// from Element: extension
},
{ // Additional documentation, review, or usage guidance // I
// from Element: extension
}
],
"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
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // IName for this measure (computer friendly)
"title" : "<string>", // I R! Name for this measure (human friendly)
"subtitle" : "<string>", // ISubordinate title of the measure
"status" : "<code>", // I R! draft | active | retired | unknown
"experimental" : <boolean>, // IFor 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>", // IName 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" : "<markdown>", // IDescribes the clinical usage of the measure
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"approvalDate" : "<date>", // IWhen the measure was approved by publisher
"lastReviewDate" : "<date>", // IWhen the measure was last reviewed by the publisher
"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" : "<markdown>", // IHow risk adjustment is applied for this measure
"rateAggregation" : "<markdown>", // 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 (deprecated)
"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 | |
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| url | S | 1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
| version | S | 1..1 | string | Business version of the measure |
| versionAlgorithm[x] | S | 0..1 | string, Coding | How to compare versions |
| name | S | 0..1 | string | Name for this measure (computer friendly) |
| title | S | 1..1 | string | Name for this measure (human friendly) |
| experimental | S | 0..1 | boolean | For testing purposes, not real usage |
| publisher | S | 0..1 | string | Name of the publisher/steward (organization or individual) |
| description | S | 1..1 | markdown | Natural language description of the measure |
| 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: All Languages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣC | 1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
| identifier | Σ | 0..* | Identifier | Additional identifier for the measure |
| version | SΣ | 1..1 | string | Business version of the measure |
| versionAlgorithm[x] | SΣ | 0..1 | How to compare versions Binding: Version Algorithm (extensible) | |
| versionAlgorithmString | string | |||
| versionAlgorithmCoding | Coding | |||
| name | SΣC | 0..1 | string | Name for this measure (computer friendly) |
| title | SΣ | 1..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 | SΣ | 0..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 | Σ | 0..1 | dateTime | Date last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | SΣ | 1..1 | markdown | Natural language description of the measure |
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| purpose | 0..1 | markdown | Why this measure is defined | |
| usage | 0..1 | markdown | Describes the clinical usage of the measure | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| copyrightLabel | 0..1 | string | Copyright holder and year(s) | |
| approvalDate | 0..1 | date | When the measure was approved by publisher | |
| lastReviewDate | 0..1 | date | When the measure was last reviewed by the publisher | |
| effectivePeriod | Σ | 0..1 | Period | When the measure is expected to be used |
| topic | XD | 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc Binding: Definition Topic (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: Composite Measure Scoring (extensible): The composite scoring method of the measure. |
| type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: Measure Type (extensible): The type of measure (includes codes from 2.16.840.1.113883.1.11.20368). |
| riskAdjustment | Σ | 0..1 | markdown | How risk adjustment is applied for this measure |
| rateAggregation | Σ | 0..1 | markdown | 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: Measure Improvement Notation (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: Measure Definition Example (example): Codeable representations of measure definition terms. | |
| definition | 0..1 | markdown | Meaning of the term | |
| guidance | ΣXD | 0..1 | markdown | Additional guidance for implementers (deprecated) |
| group | C | 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 |
| linkId | C | 0..1 | string | Unique id for group in measure |
| code | 0..1 | CodeableConcept | Meaning of the group Binding: Measure Group Example (example): Example of measure groups. | |
| description | 0..1 | markdown | Summary description | |
| type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: Measure Type (extensible) |
| 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) |
| scoring | Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible) |
| scoringUnit | Σ | 0..1 | CodeableConcept | What units? Binding: Measure Scoring Unit (example) |
| rateAggregation | Σ | 0..1 | markdown | How is rate aggregation performed for this measure |
| improvementNotation | Σ | 0..1 | CodeableConcept | increase | decrease Binding: Measure Improvement Notation (required) |
| library | 0..* | canonical(Library) | Logic used by the measure group | |
| 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 |
| linkId | C | 0..1 | string | Unique id for population in measure |
| code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: Measure Population Type (extensible): The type of population. | |
| description | 0..1 | markdown | The human readable description of this population criteria | |
| criteria | 0..1 | Expression | The criteria that defines this population | |
| groupDefinition | 0..1 | Reference(Group) | A group resource 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 | C | 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 |
| linkId | C | 0..1 | string | Unique id for stratifier in measure |
| code | C | 0..1 | CodeableConcept | Meaning of the stratifier Binding: Measure Stratifier Example (example): Meaning of the stratifier. |
| description | C | 0..1 | markdown | The human readable description of this stratifier |
| criteria | C | 0..1 | Expression | How the measure should be stratified |
| groupDefinition | 0..1 | Reference(Group) | A group resource that defines this population | |
| component | C | 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 |
| linkId | C | 0..1 | string | Unique id for stratifier component in measure |
| code | 0..1 | CodeableConcept | Meaning of the stratifier component Binding: Measure Stratifier Example (example): Meaning of the stratifier. | |
| description | 0..1 | markdown | The human readable description of this stratifier component | |
| criteria | 0..1 | Expression | Component of how the measure should be stratified | |
| groupDefinition | 0..1 | Reference(Group) | A group resource that defines this population | |
| 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 |
| linkId | C | 0..1 | string | Unique id for supplementalData in measure |
| code | 0..1 | CodeableConcept | Meaning of the supplemental data Binding: Measure Supplemental Data Example (example): Meaning of the supplemental data. | |
| usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: Measure Data Usage (extensible): The intended usage for supplemental data elements in the measure. | |
| description | 0..1 | markdown | 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
<!-- ShareableMeasure -->
JSON Template
{ // ShareableMeasure
// 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
"extension" : [ // sliced by value:url in the specified order, Open
{ // shareable | computable | publishable | executable // I
// from Element: extension
},
{ // narrative | semi-structured | structured | executable // I
// from Element: extension
},
{ // Additional documentation, review, or usage guidance // I
// from Element: extension
}
],
"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
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // IName for this measure (computer friendly)
"title" : "<string>", // I R! Name for this measure (human friendly)
"subtitle" : "<string>", // ISubordinate title of the measure
"status" : "<code>", // I R! draft | active | retired | unknown
"experimental" : <boolean>, // IFor 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>", // IName 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" : "<markdown>", // IDescribes the clinical usage of the measure
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"approvalDate" : "<date>", // IWhen the measure was approved by publisher
"lastReviewDate" : "<date>", // IWhen the measure was last reviewed by the publisher
"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" : "<markdown>", // IHow risk adjustment is applied for this measure
"rateAggregation" : "<markdown>", // 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 (deprecated)
"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 | All Languages | required | All Languages |
| Measure.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
| 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 ValueSet | extensible | Jurisdiction ValueSet |
| Measure.topic | Definition Topic | example | Definition Topic |
| Measure.scoring | MeasureScoring | extensible | MeasureScoring |
| Measure.scoringUnit | Measure Scoring Unit | example | Measure Scoring Unit |
| Measure.compositeScoring | Composite Measure Scoring | extensible | Composite Measure Scoring |
| Measure.type | Measure Type | extensible | Measure Type |
| Measure.improvementNotation | Measure Improvement Notation | required | Measure Improvement Notation |
| Measure.term.code | Measure Definition Example | example | Measure Definition Example |
| Measure.group.code | Measure Group Example | example | Measure Group Example |
| Measure.group.type | Measure Type | extensible | Measure Type |
| Measure.group.subject[x] | Participant Resource Types | extensible | Participant Resource Types |
| 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 | Measure Improvement Notation | required | Measure Improvement Notation |
| Measure.group.population.code | Measure Population Type | extensible | Measure Population Type |
| Measure.group.population.aggregateMethod | Measure Aggregate Method | extensible | Measure Aggregate Method |
| Measure.group.stratifier.code | Measure Stratifier Example | example | Measure Stratifier Example |
| Measure.group.stratifier.component.code | Measure Stratifier Example | example | Measure Stratifier Example |
| Measure.supplementalData.code | Measure Supplemental Data Example | example | Measure Supplemental Data Example |
| Measure.supplementalData.usage | Measure Data Usage | extensible | Measure Data Usage |
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:25+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change