This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v1.0.0: STU 1) based on FHIR R3. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-cqfm
The CQFM Measure Profile describes a shareable, published measure resource that can be used to define an electronic clinical quality measure
This profile builds on Measure.
This profile was published on Wed Feb 13 00:00:00 EST 2019 as a active by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
Summary
Mandatory: 20 elements (3 nested mandatory elements)
Must-Support: 40 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | I | 0..* | A quality measure definition | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cqfm-artifactComment | SI | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment |
cqfm-populationBasis | SI | 1..1 | code | What type of population URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-populationBasis Binding: FHIRAllTypes (required) |
cqfm-allocation | I | 0..1 | markdown | Allocation guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-allocation |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | Logical URI to reference this measure (globally unique) |
identifier | SΣ | 1..* | Identifier | Additional identifier for the measure |
version | SΣ | 1..1 | string | Business version of the measure |
name | SΣ | 1..1 | string | Name for this measure (computer friendly) |
title | SΣ | 1..1 | string | Name for this measure (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
date | SΣ | 1..1 | dateTime | Date this was last changed |
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
description | SΣ | 1..1 | markdown | Natural language description of the measure |
purpose | S | 0..1 | markdown | Why this measure is defined |
usage | S | 0..1 | string | Describes the clinical usage of the measure |
approvalDate | S | 1..1 | date | When the measure was approved by publisher |
lastReviewDate | S | 1..1 | date | When the measure was last reviewed |
effectivePeriod | SΣ | 0..1 | Period | When the measure is expected to be used |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
cqfm-effectivePeriodAnchor | S | 0..1 | dateTime | Date of first effective use URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-effectivePeriodAnchor |
cqfm-effectivePeriodDuration | S | 0..1 | Duration | What reporting period is used URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-effectivePeriodDuration |
start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary |
end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
useContext | SΣ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible) |
topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example) |
contributor | S | 0..* | Contributor | A content contributor |
contact | SΣ | 1..* | ContactDetail | Contact details for the publisher |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
cqfm-isPrimaryCitation | 0..1 | boolean | Primary reference URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-isPrimaryCitation | |
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) |
display | Σ | 0..1 | string | Brief description of the related artifact |
citation | Σ | 0..1 | string | Bibliographic citation for the artifact |
url | Σ | 0..1 | uri | Where the artifact can be accessed |
document | Σ | 0..1 | Attachment | What document is being referenced |
resource | Σ | 0..1 | Reference(Resource) | What resource is being referenced |
library | SI | 1..1 | Reference(CQFMLibrary) | Logic used by the measure 1: Measures utilizing CQL SHALL reference one and only one CQL library (and that referenced library MUST be the primary library for the measure) |
disclaimer | SΣ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
scoring | SΣ | 1..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible) |
compositeScoring | Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible) |
type | SΣ | 1..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) |
riskAdjustment | Σ | 0..1 | string | How is risk adjustment applied for this measure |
rateAggregation | Σ | 0..1 | string | How is rate aggregation performed for this measure |
rationale | Σ | 0..1 | markdown | Why does this measure exist |
clinicalRecommendationStatement | Σ | 0..1 | markdown | Summary of clinical guidelines |
improvementNotation | SΣ | 1..1 | string | increase | decrease Binding: MeasureImprovementNotation (required) |
definition | Σ | 0..* | markdown | Defined terms used in the measure documentation |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cqfm-definitionTerm | I | 1..1 | string | Term to define URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-definitionTerm |
value | 0..1 | string | Primitive value for markdown | |
guidance | Σ | 0..1 | markdown | Additional guidance for implementers |
set | Σ | 0..1 | string | The measure set, e.g. Preventive Care and Screening |
group | SI | 1..* | BackboneElement | Population criteria group |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | SI | 1..1 | Identifier | Unique identifier 2: Group identifiers SHOULD use the convention: "group-<group number>", where <group number> corresponds with the group naming convention for the criteria within the group |
name | 0..1 | string | Short name | |
description | 0..1 | string | Summary description | |
population | SI | 1..* | BackboneElement | Population criteria |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..1 | Identifier | Unique identifier |
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) |
name | 0..1 | string | Short name | |
description | 0..1 | string | The human readable description of this population criteria | |
criteria | SI | 1..1 | string | The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria 3: Group population criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. |
stratifier | SI | 0..* | BackboneElement | Stratifier criteria for the measure |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..1 | Identifier | The identifier for the stratifier used to coordinate the reported data back to this stratifier |
criteria | SI | 0..1 | string | How the measure should be stratified 4: Group stratifier criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. |
path | 0..1 | string | Path to the stratifier | |
supplementalData | SI | 0..* | BackboneElement | What other data should be reported with the measure 5: Supplemental data SHALL use either criteria or path |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..1 | Identifier | Identifier, unique within the measure |
usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible) | |
criteria | 0..1 | string | Expression describing additional data to be reported | |
path | 0..1 | string | Path to the supplemental data element | |
Documentation for this format |
Summary
Mandatory: 20 elements (3 nested mandatory elements)
Must-Support: 40 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | I | 0..* | A quality measure definition | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cqfm-artifactComment | SI | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment |
cqfm-populationBasis | SI | 1..1 | code | What type of population URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-populationBasis Binding: FHIRAllTypes (required) |
cqfm-allocation | I | 0..1 | markdown | Allocation guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-allocation |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | Logical URI to reference this measure (globally unique) |
identifier | SΣ | 1..* | Identifier | Additional identifier for the measure |
version | SΣ | 1..1 | string | Business version of the measure |
name | SΣ | 1..1 | string | Name for this measure (computer friendly) |
title | SΣ | 1..1 | string | Name for this measure (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
date | SΣ | 1..1 | dateTime | Date this was last changed |
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
description | SΣ | 1..1 | markdown | Natural language description of the measure |
purpose | S | 0..1 | markdown | Why this measure is defined |
usage | S | 0..1 | string | Describes the clinical usage of the measure |
approvalDate | S | 1..1 | date | When the measure was approved by publisher |
lastReviewDate | S | 1..1 | date | When the measure was last reviewed |
effectivePeriod | SΣ | 0..1 | Period | When the measure is expected to be used |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
cqfm-effectivePeriodAnchor | S | 0..1 | dateTime | Date of first effective use URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-effectivePeriodAnchor |
cqfm-effectivePeriodDuration | S | 0..1 | Duration | What reporting period is used URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-effectivePeriodDuration |
start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary |
end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
useContext | SΣ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible) |
topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example) |
contributor | S | 0..* | Contributor | A content contributor |
contact | SΣ | 1..* | ContactDetail | Contact details for the publisher |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
cqfm-isPrimaryCitation | 0..1 | boolean | Primary reference URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-isPrimaryCitation | |
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) |
display | Σ | 0..1 | string | Brief description of the related artifact |
citation | Σ | 0..1 | string | Bibliographic citation for the artifact |
url | Σ | 0..1 | uri | Where the artifact can be accessed |
document | Σ | 0..1 | Attachment | What document is being referenced |
resource | Σ | 0..1 | Reference(Resource) | What resource is being referenced |
library | SI | 1..1 | Reference(CQFMLibrary) | Logic used by the measure 1: Measures utilizing CQL SHALL reference one and only one CQL library (and that referenced library MUST be the primary library for the measure) |
disclaimer | SΣ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
scoring | SΣ | 1..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible) |
compositeScoring | Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible) |
type | SΣ | 1..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) |
riskAdjustment | Σ | 0..1 | string | How is risk adjustment applied for this measure |
rateAggregation | Σ | 0..1 | string | How is rate aggregation performed for this measure |
rationale | Σ | 0..1 | markdown | Why does this measure exist |
clinicalRecommendationStatement | Σ | 0..1 | markdown | Summary of clinical guidelines |
improvementNotation | SΣ | 1..1 | string | increase | decrease Binding: MeasureImprovementNotation (required) |
definition | Σ | 0..* | markdown | Defined terms used in the measure documentation |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cqfm-definitionTerm | I | 1..1 | string | Term to define URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-definitionTerm |
value | 0..1 | string | Primitive value for markdown | |
guidance | Σ | 0..1 | markdown | Additional guidance for implementers |
set | Σ | 0..1 | string | The measure set, e.g. Preventive Care and Screening |
group | SI | 1..* | BackboneElement | Population criteria group |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | SI | 1..1 | Identifier | Unique identifier 2: Group identifiers SHOULD use the convention: "group-<group number>", where <group number> corresponds with the group naming convention for the criteria within the group |
name | 0..1 | string | Short name | |
description | 0..1 | string | Summary description | |
population | SI | 1..* | BackboneElement | Population criteria |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..1 | Identifier | Unique identifier |
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) |
name | 0..1 | string | Short name | |
description | 0..1 | string | The human readable description of this population criteria | |
criteria | SI | 1..1 | string | The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria 3: Group population criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. |
stratifier | SI | 0..* | BackboneElement | Stratifier criteria for the measure |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..1 | Identifier | The identifier for the stratifier used to coordinate the reported data back to this stratifier |
criteria | SI | 0..1 | string | How the measure should be stratified 4: Group stratifier criteria SHOULD be simple expression names found within the primary library for the measure. The criteria SHOULD NOT include a namespace. |
path | 0..1 | string | Path to the stratifier | |
supplementalData | SI | 0..* | BackboneElement | What other data should be reported with the measure 5: Supplemental data SHALL use either criteria or path |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..1 | Identifier | Identifier, unique within the measure |
usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible) | |
criteria | 0..1 | string | Expression describing additional data to be reported | |
path | 0..1 | string | Path to the supplemental data element | |
Documentation for this format |
Path | Conformance | ValueSet |
Measure.language | extensible | Common Languages Max Binding: All Languages |
Measure.status | required | PublicationStatus |
Measure.jurisdiction | extensible | Jurisdiction ValueSet |
Measure.topic | example | DefinitionTopic |
Measure.relatedArtifact.type | required | RelatedArtifactType |
Measure.scoring | extensible | MeasureScoring |
Measure.compositeScoring | extensible | CompositeMeasureScoring |
Measure.type | extensible | MeasureType |
Measure.improvementNotation | required | MeasureImprovementNotation |
Measure.group.population.code | extensible | MeasurePopulationType |
Measure.supplementalData.usage | extensible | MeasureDataUsage |
Id | Path | Details | Requirements |
dom-2 | Measure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Measure | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | 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-3 | Measure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
ele-1 | Measure.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Measure.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Measure.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Measure.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Measure.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Measure.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Measure.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Measure.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
1 | 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) : library.exists() | |
ele-1 | Measure.definition.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Measure.definition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Measure.definition.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Measure.definition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Measure.group | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
2 | Measure.group.identifier | 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 | Measure.group.population | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
3 | 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 | Measure.group.stratifier | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
4 | 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 | Measure.supplementalData | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
5 | Measure.supplementalData | Supplemental data SHALL use either criteria or path : criteria.exists() or path.exists() |