Content Management Infrastructure Implementation Guide, published by Clinical Decision Support WG. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/Content-Management-Infrastructure-IG/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-shareablemeasure | Version: 0.1.0 | |||
Active as of 2019-02-13 | Computable Name: CMIMeasure |
The CMI Measure Profile describes minimum expectations for defining an electronic Clinical Quality Measure (eCQM)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Shareable Measure
Summary
Mandatory: 2 elements (4 nested mandatory elements)
Must-Support: 19 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Shareable Measure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | 1..1 | Shareable Measure | A quality measure definition | |
meta | S | 1..1 | Meta | Metadata about the resource |
profile | S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
extension:comment | S | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment |
extension:allocation | S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-allocation]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-allocation |
cmi-softwaresystem | S | 0..* | Reference(http://hl7.org/fhir/uv/cmi/StructureDefinition/device-softwaresystem-cmi) | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-softwaresystem |
library | SI | 0..1 | canonical(http://hl7.org/fhir/uv/cmi/StructureDefinition/library-cmi) | CMIMeasures are not required to use a Library, but if they do, it SHALL be a CMILibrary. cqm-2: Measures utilizing CQL SHALL reference one and only one CQL library (and that referenced library MUST be the primary library for the measure) |
type | S | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) |
group | S | 0..* | BackboneElement | Population criteria group |
id | SI | 0..1 | string | Unique id for inter-element referencing cqm-3: Group identifiers SHOULD use the convention: "group-[group number]", where [group number] corresponds with the group naming convention for the criteria within the group |
population | S | 0..* | BackboneElement | Population criteria |
id | S | 1..1 | string | Unique id for inter-element referencing |
code | S | 1..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible) |
criteria | SI | 1..1 | Expression | The criteria that defines this population cqm-4: Group population criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. |
stratifier | S | 0..* | BackboneElement | Stratifier criteria for the measure |
id | S | 1..1 | string | Unique id for inter-element referencing |
criteria | SI | 0..1 | Expression | How the measure should be stratified cqm-5: Group stratifier criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. |
supplementalData | SI | 0..* | BackboneElement | What other data should be reported with the measure cqm-6: Supplemental data SHALL use either criteria or path |
id | S | 1..1 | string | Unique id for inter-element referencing |
code | S | 0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureDataUsage (extensible) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Measure | I | 1..1 | Shareable Measure | A quality measure definition | ||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | |||||
extension:comment | S | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment | ||||
extension:allocation | S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-allocation]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-allocation | ||||
cmi-softwaresystem | S | 0..* | Reference(http://hl7.org/fhir/uv/cmi/StructureDefinition/device-softwaresystem-cmi) | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-softwaresystem | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
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 | ΣI | 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: SubjectType (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
date | SΣ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher (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 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 | 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 | SI | 0..1 | canonical(http://hl7.org/fhir/uv/cmi/StructureDefinition/library-cmi) | CMIMeasures are not required to use a Library, but if they do, it SHALL be a CMILibrary. cqm-2: Measures utilizing CQL SHALL reference one and only one CQL library (and that referenced library MUST be the primary library for 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. | ||||
compositeScoring | Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure. | ||||
type | SΣ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) | ||||
riskAdjustment | Σ | 0..1 | string | How risk adjustment is applied for this measure | ||||
rateAggregation | Σ | 0..1 | string | How is rate aggregation performed for this measure | ||||
rationale | Σ | 0..1 | markdown | Detailed description of why the measure exists | ||||
clinicalRecommendationStatement | Σ | 0..1 | markdown | Summary of clinical guidelines | ||||
improvementNotation | Σ | 0..1 | CodeableConcept | increase | decrease 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. | ||||
definition | Σ | 0..* | markdown | Defined terms used in the measure documentation | ||||
guidance | Σ | 0..1 | markdown | Additional guidance for implementers | ||||
group | S | 0..* | BackboneElement | Population criteria group | ||||
id | SI | 0..1 | string | Unique id for inter-element referencing cqm-3: Group identifiers SHOULD use the convention: "group-[group number]", where [group number] corresponds with the group naming convention for the criteria within the group | ||||
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 | |||||
description | 0..1 | string | Summary description | |||||
population | S | 0..* | BackboneElement | Population criteria | ||||
id | S | 1..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 | S | 1..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible) | ||||
description | 0..1 | string | The human readable description of this population criteria | |||||
criteria | SI | 1..1 | Expression | The criteria that defines this population cqm-4: Group population criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. | ||||
stratifier | S | 0..* | BackboneElement | Stratifier criteria for the measure | ||||
id | S | 1..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 | |||||
description | 0..1 | string | The human readable description of this stratifier | |||||
criteria | SI | 0..1 | Expression | How the measure should be stratified cqm-5: Group stratifier criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. | ||||
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 | |||||
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 | SI | 0..* | BackboneElement | What other data should be reported with the measure cqm-6: Supplemental data SHALL use either criteria or path | ||||
id | S | 1..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 | S | 0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureDataUsage (extensible) | ||||
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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | I | 1..1 | Shareable Measure | A quality measure definition |
meta | Σ | 1..1 | Meta | Metadata about the resource |
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
extension:comment | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment | |
extension:allocation | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-allocation]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-allocation | |
cmi-softwaresystem | 0..* | Reference(http://hl7.org/fhir/uv/cmi/StructureDefinition/device-softwaresystem-cmi) | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-softwaresystem | |
identifier | Σ | 0..* | Identifier | Additional identifier for the measure |
title | Σ | 0..1 | string | Name for this measure (human friendly) |
date | Σ | 0..1 | dateTime | Date last changed |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
library | I | 0..1 | canonical(http://hl7.org/fhir/uv/cmi/StructureDefinition/library-cmi) | CMIMeasures are not required to use a Library, but if they do, it SHALL be a CMILibrary. cqm-2: Measures utilizing CQL SHALL reference one and only one CQL library (and that referenced library MUST be the primary library for the measure) |
type | Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) |
group | 0..* | BackboneElement | Population criteria group | |
id | I | 0..1 | string | Unique id for inter-element referencing cqm-3: Group identifiers SHOULD use the convention: "group-[group number]", where [group number] corresponds with the group naming convention for the criteria within the group |
population | 0..* | BackboneElement | Population criteria | |
id | 1..1 | string | Unique id for inter-element referencing | |
code | 1..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible) | |
criteria | I | 1..1 | Expression | The criteria that defines this population cqm-4: Group population criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. |
stratifier | 0..* | BackboneElement | Stratifier criteria for the measure | |
id | 1..1 | string | Unique id for inter-element referencing | |
criteria | I | 0..1 | Expression | How the measure should be stratified cqm-5: Group stratifier criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. |
supplementalData | I | 0..* | BackboneElement | What other data should be reported with the measure cqm-6: Supplemental data SHALL use either criteria or path |
id | 1..1 | string | Unique id for inter-element referencing | |
code | 0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureDataUsage (extensible) | |
Documentation for this format |
This structure is derived from Shareable Measure
Summary
Mandatory: 2 elements (4 nested mandatory elements)
Must-Support: 19 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Shareable Measure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | 1..1 | Shareable Measure | A quality measure definition | |
meta | S | 1..1 | Meta | Metadata about the resource |
profile | S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
extension:comment | S | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment |
extension:allocation | S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-allocation]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-allocation |
cmi-softwaresystem | S | 0..* | Reference(http://hl7.org/fhir/uv/cmi/StructureDefinition/device-softwaresystem-cmi) | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-softwaresystem |
library | SI | 0..1 | canonical(http://hl7.org/fhir/uv/cmi/StructureDefinition/library-cmi) | CMIMeasures are not required to use a Library, but if they do, it SHALL be a CMILibrary. cqm-2: Measures utilizing CQL SHALL reference one and only one CQL library (and that referenced library MUST be the primary library for the measure) |
type | S | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) |
group | S | 0..* | BackboneElement | Population criteria group |
id | SI | 0..1 | string | Unique id for inter-element referencing cqm-3: Group identifiers SHOULD use the convention: "group-[group number]", where [group number] corresponds with the group naming convention for the criteria within the group |
population | S | 0..* | BackboneElement | Population criteria |
id | S | 1..1 | string | Unique id for inter-element referencing |
code | S | 1..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible) |
criteria | SI | 1..1 | Expression | The criteria that defines this population cqm-4: Group population criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. |
stratifier | S | 0..* | BackboneElement | Stratifier criteria for the measure |
id | S | 1..1 | string | Unique id for inter-element referencing |
criteria | SI | 0..1 | Expression | How the measure should be stratified cqm-5: Group stratifier criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. |
supplementalData | SI | 0..* | BackboneElement | What other data should be reported with the measure cqm-6: Supplemental data SHALL use either criteria or path |
id | S | 1..1 | string | Unique id for inter-element referencing |
code | S | 0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureDataUsage (extensible) |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Measure | I | 1..1 | Shareable Measure | A quality measure definition | ||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | |||||
extension:comment | S | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment | ||||
extension:allocation | S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-allocation]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-allocation | ||||
cmi-softwaresystem | S | 0..* | Reference(http://hl7.org/fhir/uv/cmi/StructureDefinition/device-softwaresystem-cmi) | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-softwaresystem | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
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 | ΣI | 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: SubjectType (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
date | SΣ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher (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 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 | 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 | SI | 0..1 | canonical(http://hl7.org/fhir/uv/cmi/StructureDefinition/library-cmi) | CMIMeasures are not required to use a Library, but if they do, it SHALL be a CMILibrary. cqm-2: Measures utilizing CQL SHALL reference one and only one CQL library (and that referenced library MUST be the primary library for 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. | ||||
compositeScoring | Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure. | ||||
type | SΣ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) | ||||
riskAdjustment | Σ | 0..1 | string | How risk adjustment is applied for this measure | ||||
rateAggregation | Σ | 0..1 | string | How is rate aggregation performed for this measure | ||||
rationale | Σ | 0..1 | markdown | Detailed description of why the measure exists | ||||
clinicalRecommendationStatement | Σ | 0..1 | markdown | Summary of clinical guidelines | ||||
improvementNotation | Σ | 0..1 | CodeableConcept | increase | decrease 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. | ||||
definition | Σ | 0..* | markdown | Defined terms used in the measure documentation | ||||
guidance | Σ | 0..1 | markdown | Additional guidance for implementers | ||||
group | S | 0..* | BackboneElement | Population criteria group | ||||
id | SI | 0..1 | string | Unique id for inter-element referencing cqm-3: Group identifiers SHOULD use the convention: "group-[group number]", where [group number] corresponds with the group naming convention for the criteria within the group | ||||
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 | |||||
description | 0..1 | string | Summary description | |||||
population | S | 0..* | BackboneElement | Population criteria | ||||
id | S | 1..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 | S | 1..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible) | ||||
description | 0..1 | string | The human readable description of this population criteria | |||||
criteria | SI | 1..1 | Expression | The criteria that defines this population cqm-4: Group population criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. | ||||
stratifier | S | 0..* | BackboneElement | Stratifier criteria for the measure | ||||
id | S | 1..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 | |||||
description | 0..1 | string | The human readable description of this stratifier | |||||
criteria | SI | 0..1 | Expression | How the measure should be stratified cqm-5: Group stratifier criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. | ||||
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 | |||||
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 | SI | 0..* | BackboneElement | What other data should be reported with the measure cqm-6: Supplemental data SHALL use either criteria or path | ||||
id | S | 1..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 | S | 0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureDataUsage (extensible) | ||||
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 |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Measure.meta.security | extensible | All Security Labels |
Measure.meta.tag | example | CommonTags |
Measure.language | preferred | CommonLanguages Max Binding: AllLanguages |
Measure.status | required | PublicationStatus |
Measure.subject[x] | extensible | SubjectType |
Measure.jurisdiction | extensible | Jurisdiction ValueSet (missing link) |
Measure.topic | example | DefinitionTopic (missing link) |
Measure.scoring | extensible | MeasureScoring |
Measure.compositeScoring | extensible | CompositeMeasureScoring |
Measure.type | extensible | MeasureType |
Measure.improvementNotation | required | MeasureImprovementNotation |
Measure.group.population.code | extensible | MeasurePopulationType |
Measure.supplementalData.code | extensible | MeasureDataUsage |
Measure.supplementalData.usage | extensible | MeasureDataUsage |
Id | Grade | Path | Details | Requirements |
dom-2 | error | Measure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Measure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Measure | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Measure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Best Practice | Measure | A resource should have narrative for robust management : text.`div`.exists() | |
mea-0 | warning | Measure | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
mea-1 | error | Measure | Stratifier SHALL be either a single criteria or a set of criteria components : group.stratifier.all((code | description | criteria).exists() xor component.exists()) | |
ele-1 | error | Measure.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.meta.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.meta.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.meta.versionId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.meta.lastUpdated | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.meta.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.meta.profile | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.meta.security | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.meta.tag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.extension:comment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.extension:comment | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.extension:allocation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.extension:allocation | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.extension:softwaresystem | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.extension:softwaresystem | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.subtitle | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.experimental | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.subject[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.publisher | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.useContext | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.jurisdiction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.purpose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.usage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.copyright | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.approvalDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.lastReviewDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.effectivePeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.topic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.editor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.reviewer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.endorser | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.relatedArtifact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.library | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
cqm-2 | warning | Measure.library | Measures utilizing CQL SHALL reference one and only one CQL library (and that referenced library MUST be the primary library for the measure) : exists() | |
ele-1 | error | Measure.disclaimer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.scoring | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.compositeScoring | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.riskAdjustment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.rateAggregation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.rationale | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.clinicalRecommendationStatement | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.improvementNotation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.definition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.guidance | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
cqm-3 | warning | Measure.group.id | Group identifiers SHOULD use the convention: "group-[group number]", where [group number] corresponds with the group naming convention for the criteria within the group : value.startsWith('group-') | |
ele-1 | error | Measure.group.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.group.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.group.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.group.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.group.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.population | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.population.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.group.population.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.group.population.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.group.population.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.group.population.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.population.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.population.criteria | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
cqm-4 | warning | Measure.group.population.criteria | Group population criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. : value.startsWith(library).not() | |
ele-1 | error | Measure.group.stratifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.stratifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.group.stratifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.group.stratifier.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.group.stratifier.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.group.stratifier.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.stratifier.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.stratifier.criteria | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
cqm-5 | warning | Measure.group.stratifier.criteria | Group stratifier criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. : value.startsWith(library).not() | |
ele-1 | error | Measure.group.stratifier.component | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.stratifier.component.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.group.stratifier.component.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.group.stratifier.component.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.group.stratifier.component.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.group.stratifier.component.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.stratifier.component.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.group.stratifier.component.criteria | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.supplementalData | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
cqm-6 | warning | Measure.supplementalData | Supplemental data SHALL use either criteria or path : criteria.exists() or path.exists() | |
ele-1 | error | Measure.supplementalData.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.supplementalData.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.supplementalData.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Measure.supplementalData.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Measure.supplementalData.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.supplementalData.usage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.supplementalData.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Measure.supplementalData.criteria | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |