Quality Measure Implementation Guide
1.0.0-ballot - ballot
Quality Measure Implementation Guide
1.0.0-ballot - ballot
This page is part of the Quality Measure Implementation Guide (v1.0.0-ballot: STU1 (v1.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-publishablemeasure | Version: 1.0.0 | |||
| Active as of 2024-12-16 | Computable Name: CQMPublishableMeasure | |||
The cqm Publishable Measure profile defines the minimum expectations to enable appropriate content management, discovery, and utilization of published Quality Measures (QMs). For more information on the usage of this profile, refer to the Profiles and Packaging pages in this implementation guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CRMIPublishableMeasure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Measure |
1..1 | CRMIPublishableMeasure | A quality measure definition | |
  text |
S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
  Slices for extension |
Content/Rules for all slices | |||
   supplementalDataGuidance |
S | 0..* | (Complex) | Supplemental data guidance URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-supplementalDataGuidance |
| comment |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| softwaresystem |
S | 0..* | Reference(CRMI Software System Device) | Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem |
 improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance |
| Slices for identifier |
S | 3..* | Identifier | Additional identifier for the measure Slice: Unordered, Open by value:type |
 identifier:versionIndependentIdentifier |
S | 1..1 | Identifier | Measure guid |
   use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official |
  type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
   coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-independent | |
| system |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 |
 value |
S | 1..1 | string | The value that is unique |
| identifier:versionSpecificIdentifier |
S | 1..1 | Identifier | Measure version guid |
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-specific | |
| system |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 |
| value |
S | 1..1 | string | The value that is unique |
| identifier:shortName |
S | 1..1 | Identifier | Short name |
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: usual |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: short-name | |
| value |
S | 1..1 | string | The value that is unique |
| identifier:endorserIdentifier |
S | 0..* | Identifier | Endorser identifier |
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: endorser | |
| system |
S | 0..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| assigner |
S | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
 identifier:publisherIdentifier |
S | 0..* | Identifier | Publisher identifier |
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: publisher | |
| system |
S | 0..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| assigner |
S | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| title |
S | 1..1 | string | Name for this measure (human friendly) |
| status |
1..1 | code | draft | active | retired | unknown | |
| date |
S | 1..1 | dateTime | Date last changed |
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |
| contact |
S | 1..* | ContactDetail | Contact details for the publisher |
| Slices for useContext |
S | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
| useContext:intendedVenue |
S | 0..* | UsageContext | What venue? |
| code |
S | 1..1 | Coding | Type of context being specified Required Pattern: At least the following |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: venue | |
| value[x] |
S | 1..1 | CodeableConcept | Value that defines the context Binding: Intended Venue (extensible) |
| purpose |
S | 0..1 | markdown | Why this measure is defined |
| usage |
S | 0..1 | string | Allows measure developers to provide additional guidance so that implementers can more easily interpret and implement components of the measure. |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions |
| approvalDate |
S | 0..1 | date | When the measure was approved by publisher |
| lastReviewDate |
S | 0..1 | date | When the measure was last reviewed |
| effectivePeriod |
S | 0..1 | Period | When the measure is expected to be used |
| Slices for extension |
Content/Rules for all slices | |||
| anchor |
S | 0..1 | dateTime | Date of first effective use URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodAnchor |
| duration |
S | 0..1 | Duration | What reporting period is used URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodDuration |
| topic |
S | 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc. |
| author |
S | 0..* | ContactDetail | Who authored the content |
| editor |
S | 0..* | ContactDetail | Who edited the content |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the content |
| endorser |
S | 0..* | ContactDetail | Who endorsed the content |
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
| relatedArtifact:predecessor |
S | 0..1 | RelatedArtifact | Previous measure? |
| type |
S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: predecessor |
| resource |
S | 1..1 | canonical(Measure) | What resource is being referenced |
| relatedArtifact:citation |
S | 0..* | RelatedArtifact | Reference/citation |
| Slices for extension |
Content/Rules for all slices | |||
| isPrimaryCitation |
0..1 | boolean | Primary reference URL: http://hl7.org/fhir/StructureDefinition/cqf-isPrimaryCitation | |
| publicationStatus |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |
| publicationDate |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |
| type |
S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: citation |
| relatedArtifact:derived-from |
S | 0..* | RelatedArtifact | URL or canonical reference to other resources that a measure is derived from |
| type |
S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: derived-from |
| label |
0..1 | string | Short label | |
| display |
0..1 | string | Brief description of the related artifact | |
| url |
0..1 | url | Should be permalink otherwise include an "accessed date" | |
| resource |
0..1 | canonical(Measure) | Should be permalink otherwise include an "accessed date" | |
| disclaimer |
S | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
| type |
SΣ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) |
| rationale |
S | 0..1 | markdown | Justification for the measure in terms of impact, gap in care, and evidence. |
| definition |
0..* | markdown | Defined terms used in the measure documentation | |
| Slices for extension |
Content/Rules for all slices | |||
| definitionTerm |
1..1 | (Complex) | Defined term URL: http://hl7.org/fhir/StructureDefinition/cqf-definitionTerm | |
| guidance |
0..0 | |||
| group |
||||
| Slices for extension |
Content/Rules for all slices | |||
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance |
| supplementalData |
S | 0..* | BackboneElement | What other data should be reported with the measure |
| Slices for extension |
Content/Rules for all slices | |||
| includeInReportType |
S | 0..* | code | The type of report the element should be included in URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-includeInReportType Binding: MeasureReportType (required): The type of report the element should be included in |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Measure.useContext:intendedVenue.value[x] | extensible | IntendedVenue (a valid code from Intended Venue Codes)http://hl7.org/fhir/uv/cqm/ValueSet/intended-venuefrom this IG | |
| Measure.type | extensible | MeasureTypehttp://terminology.hl7.org/ValueSet/measure-type |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Measure |
C | 1..1 | CRMIPublishableMeasure | A quality measure definition dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management mea-0: Name should be usable as an identifier for the module by machine processing applications such as code generation mea-1: Stratifier SHALL be either a single criteria or a set of criteria components |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| text |
S | 1..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| supplementalDataGuidance |
S | 0..* | (Complex) | Supplemental data guidance URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-supplementalDataGuidance ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| comment |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| softwaresystem |
S | 0..* | Reference(CRMI Software System Device) | Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
SΣ | 3..* | Identifier | Additional identifier for the measure Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children |
| identifier:versionIndependentIdentifier |
SΣ | 1..1 | Identifier | Measure guid ele-1: All FHIR elements must have a @value or children |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-independent | |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: urn:ietf:rfc:3986 |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| identifier:versionSpecificIdentifier |
SΣ | 1..1 | Identifier | Measure version guid ele-1: All FHIR elements must have a @value or children |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-specific | |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: urn:ietf:rfc:3986 |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| identifier:shortName |
SΣ | 1..1 | Identifier | Short name ele-1: All FHIR elements must have a @value or children |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: usual |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: short-name | |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| identifier:endorserIdentifier |
SΣ | 0..* | Identifier | Endorser identifier ele-1: All FHIR elements must have a @value or children |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: endorser | |
| system |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
 assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| identifier:publisherIdentifier |
SΣ | 0..* | Identifier | Publisher identifier ele-1: All FHIR elements must have a @value or children |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: publisher | |
| system |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 1..1 | string | Name for this measure (human friendly) ele-1: All FHIR elements must have a @value or children |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 1..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
| publisher |
Σ | 1..1 | string | Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children |
| contact |
SΣ | 1..* | ContactDetail | Contact details for the publisher ele-1: All FHIR elements must have a @value or children |
| Slices for useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code ele-1: All FHIR elements must have a @value or children |
| useContext:intendedVenue |
SΣ | 0..* | UsageContext | What venue? ele-1: All FHIR elements must have a @value or children |
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: venue | |
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Intended Venue (extensible) ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| purpose |
S | 0..1 | markdown | Why this measure is defined ele-1: All FHIR elements must have a @value or children |
| usage |
S | 0..1 | string | Allows measure developers to provide additional guidance so that implementers can more easily interpret and implement components of the measure. ele-1: All FHIR elements must have a @value or children |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions ele-1: All FHIR elements must have a @value or children |
| approvalDate |
S | 0..1 | date | When the measure was approved by publisher ele-1: All FHIR elements must have a @value or children |
| lastReviewDate |
S | 0..1 | date | When the measure was last reviewed ele-1: All FHIR elements must have a @value or children |
| effectivePeriod |
SΣ | 0..1 | Period | When the measure is expected to be used ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| anchor |
S | 0..1 | dateTime | Date of first effective use URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodAnchor ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| duration |
S | 0..1 | Duration | What reporting period is used URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodDuration ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| topic |
S | 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. ele-1: All FHIR elements must have a @value or children |
| author |
S | 0..* | ContactDetail | Who authored the content ele-1: All FHIR elements must have a @value or children |
| editor |
S | 0..* | ContactDetail | Who edited the content ele-1: All FHIR elements must have a @value or children |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the content ele-1: All FHIR elements must have a @value or children |
| endorser |
S | 0..* | ContactDetail | Who endorsed the content ele-1: All FHIR elements must have a @value or children |
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children |
| relatedArtifact:All Slices |
Content/Rules for all slices | |||
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. ele-1: All FHIR elements must have a @value or children |
| display |
SΣ | 0..1 | string | Brief description of the related artifact ele-1: All FHIR elements must have a @value or children |
| document |
SΣ | 0..1 | Attachment | What document is being referenced ele-1: All FHIR elements must have a @value or children |
| resource |
SΣ | 0..1 | canonical(Resource) | What resource is being referenced ele-1: All FHIR elements must have a @value or children |
| relatedArtifact:predecessor |
S | 0..1 | RelatedArtifact | Previous measure? ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. ele-1: All FHIR elements must have a @value or children Fixed Value: predecessor |
| display |
SΣ | 0..1 | string | Brief description of the related artifact ele-1: All FHIR elements must have a @value or children |
| document |
SΣ | 0..1 | Attachment | What document is being referenced ele-1: All FHIR elements must have a @value or children |
| resource |
SΣ | 1..1 | canonical(Measure) | What resource is being referenced ele-1: All FHIR elements must have a @value or children |
| relatedArtifact:citation |
S | 0..* | RelatedArtifact | Reference/citation ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| isPrimaryCitation |
0..1 | boolean | Primary reference URL: http://hl7.org/fhir/StructureDefinition/cqf-isPrimaryCitation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| publicationStatus |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| publicationDate |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. ele-1: All FHIR elements must have a @value or children Fixed Value: citation |
| display |
SΣ | 0..1 | string | Brief description of the related artifact ele-1: All FHIR elements must have a @value or children |
| document |
SΣ | 0..1 | Attachment | What document is being referenced ele-1: All FHIR elements must have a @value or children |
| resource |
SΣ | 0..1 | canonical(Resource) | What resource is being referenced ele-1: All FHIR elements must have a @value or children |
| relatedArtifact:derived-from |
S | 0..* | RelatedArtifact | URL or canonical reference to other resources that a measure is derived from ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. ele-1: All FHIR elements must have a @value or children Fixed Value: derived-from |
| label |
Σ | 0..1 | string | Short label ele-1: All FHIR elements must have a @value or children |
| display |
SΣ | 0..1 | string | Brief description of the related artifact ele-1: All FHIR elements must have a @value or children |
| url |
Σ | 0..1 | url | Should be permalink otherwise include an "accessed date" ele-1: All FHIR elements must have a @value or children |
| document |
SΣ | 0..1 | Attachment | What document is being referenced ele-1: All FHIR elements must have a @value or children |
| resource |
SΣ | 0..1 | canonical(Measure) | Should be permalink otherwise include an "accessed date" ele-1: All FHIR elements must have a @value or children |
| disclaimer |
SΣ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) ele-1: All FHIR elements must have a @value or children |
| rationale |
SΣ | 0..1 | markdown | Justification for the measure in terms of impact, gap in care, and evidence. ele-1: All FHIR elements must have a @value or children |
| definition |
Σ | 0..* | markdown | Defined terms used in the measure documentation ele-1: All FHIR elements must have a @value or children |
 Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| definitionTerm |
1..1 | (Complex) | Defined term URL: http://hl7.org/fhir/StructureDefinition/cqf-definitionTerm ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| group |
0..* | BackboneElement | Population criteria group ele-1: All FHIR elements must have a @value or children | |
| Slices for extension |
Content/Rules for all slices | |||
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| supplementalData |
S | 0..* | BackboneElement | What other data should be reported with the measure ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| includeInReportType |
S | 0..* | code | The type of report the element should be included in URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-includeInReportType Binding: MeasureReportType (required): The type of report the element should be included in ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| criteria |
1..1 | Expression | Expression describing additional data to be reported ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Measure.identifier:versionIndependentIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Measure.identifier:versionIndependentIdentifier.type | extensible | Pattern: version-independenthttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Measure.identifier:versionSpecificIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Measure.identifier:versionSpecificIdentifier.type | extensible | Pattern: version-specifichttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Measure.identifier:shortName.use | required | Fixed Value: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Measure.identifier:shortName.type | extensible | Pattern: short-namehttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Measure.identifier:endorserIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Measure.identifier:endorserIdentifier.type | extensible | Pattern: endorserhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Measure.identifier:publisherIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Measure.identifier:publisherIdentifier.type | extensible | Pattern: publisherhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Measure.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| Measure.useContext:intendedVenue.code | extensible | Pattern: venuehttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | |
| Measure.useContext:intendedVenue.value[x] | extensible | IntendedVenue (a valid code from Intended Venue Codes)http://hl7.org/fhir/uv/cqm/ValueSet/intended-venuefrom this IG | |
| Measure.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| Measure.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | |
| Measure.relatedArtifact.type | required | RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | |
| Measure.relatedArtifact:predecessor.type | required | Fixed Value: predecessorhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | |
| Measure.relatedArtifact:citation.type | required | Fixed Value: citationhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | |
| Measure.relatedArtifact:derived-from.type | required | Fixed Value: derived-fromhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | |
| Measure.type | extensible | MeasureTypehttp://terminology.hl7.org/ValueSet/measure-type |
| Id | Grade | Path(s) | 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() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.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()) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Measure |
C | 1..1 | CRMIPublishableMeasure | A quality measure definition mea-0: Name should be usable as an identifier for the module by machine processing applications such as code generation mea-1: Stratifier SHALL be either a single criteria or a set of criteria components | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
S | 1..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 | |||||
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| supplementalDataGuidance |
S | 0..* | (Complex) | Supplemental data guidance URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-supplementalDataGuidance | ||||
| comment |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
| softwaresystem |
S | 0..* | Reference(CRMI Software System Device) | Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem | ||||
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | ||||
| Slices for identifier |
SΣ | 3..* | Identifier | Additional identifier for the measure Slice: Unordered, Open by value:type | ||||
| identifier:versionIndependentIdentifier |
SΣ | 1..1 | Identifier | Measure guid | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-independent | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:versionSpecificIdentifier |
SΣ | 1..1 | Identifier | Measure version guid | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-specific | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:shortName |
SΣ | 1..1 | Identifier | Short name | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: short-name | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:endorserIdentifier |
SΣ | 0..* | Identifier | Endorser identifier | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: endorser | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:publisherIdentifier |
SΣ | 0..* | Identifier | Publisher identifier | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: publisher | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| version |
Σ | 0..1 | string | Business version of the measure | ||||
| name |
Σ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 |
Σ | 0..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Σ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 1..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
SΣ | 1..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the measure | ||||
| Slices for useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code | ||||
| useContext:intendedVenue |
SΣ | 0..* | UsageContext | What venue? | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: venue | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Intended Venue (extensible) | ||||
| 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 |
S | 0..1 | markdown | Why this measure is defined | ||||
| usage |
S | 0..1 | string | Allows measure developers to provide additional guidance so that implementers can more easily interpret and implement components of the measure. | ||||
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions | ||||
| approvalDate |
S | 0..1 | date | When the measure was approved by publisher | ||||
| lastReviewDate |
S | 0..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 | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| anchor |
S | 0..1 | dateTime | Date of first effective use URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodAnchor | ||||
| duration |
S | 0..1 | Duration | What reporting period is used URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodDuration | ||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| topic |
S | 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 |
S | 0..* | ContactDetail | Who authored the content | ||||
| editor |
S | 0..* | ContactDetail | Who edited the content | ||||
| reviewer |
S | 0..* | ContactDetail | Who reviewed the content | ||||
| endorser |
S | 0..* | ContactDetail | Who endorsed the content | ||||
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type | ||||
| relatedArtifact:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
SΣ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
| relatedArtifact:predecessor |
S | 0..1 | RelatedArtifact | Previous measure? | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: predecessor | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
SΣ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 1..1 | canonical(Measure) | What resource is being referenced | ||||
| relatedArtifact:citation |
S | 0..* | RelatedArtifact | Reference/citation | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| isPrimaryCitation |
0..1 | boolean | Primary reference URL: http://hl7.org/fhir/StructureDefinition/cqf-isPrimaryCitation | |||||
| publicationStatus |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |||||
| publicationDate |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |||||
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: citation | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
SΣ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
| relatedArtifact:derived-from |
S | 0..* | RelatedArtifact | URL or canonical reference to other resources that a measure is derived from | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: derived-from | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Should be permalink otherwise include an "accessed date" | ||||
| document |
SΣ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 0..1 | canonical(Measure) | Should be permalink otherwise include an "accessed date" | ||||
| library |
0..* | canonical(Library) | Logic used by the measure | |||||
| disclaimer |
SΣ | 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 |
SΣ | 0..1 | markdown | Justification for the measure in terms of impact, gap in care, and evidence. | ||||
| 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 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| definitionTerm |
1..1 | (Complex) | Defined term URL: http://hl7.org/fhir/StructureDefinition/cqf-definitionTerm | |||||
| value |
0..1 | string | Primitive value for markdown | |||||
| group |
0..* | BackboneElement | Population criteria group | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance | ||||
| 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 |
0..* | BackboneElement | Population criteria | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible): The type of population. | |||||
| description |
0..1 | string | The human readable description of this population criteria | |||||
| criteria |
1..1 | Expression | The criteria that defines this population | |||||
| stratifier |
0..* | BackboneElement | Stratifier criteria for the measure | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | Meaning of the stratifier | |||||
| description |
0..1 | string | The human readable description of this stratifier | |||||
| criteria |
0..1 | Expression | How the measure should be stratified | |||||
| component |
0..* | BackboneElement | Stratifier criteria component for the measure | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | Meaning of the stratifier component | |||||
| 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 |
S | 0..* | BackboneElement | What other data should be reported with the measure | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| includeInReportType |
S | 0..* | code | The type of report the element should be included in URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-includeInReportType Binding: MeasureReportType (required): The type of report the element should be included in | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | Meaning of the supplemental data | |||||
| usage |
0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure. | |||||
| description |
0..1 | string | The human readable description of this supplemental data | |||||
| criteria |
1..1 | Expression | Expression describing additional data to be reported | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Measure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Measure.identifier:versionIndependentIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Measure.identifier:versionIndependentIdentifier.type | extensible | Pattern: version-independenthttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Measure.identifier:versionSpecificIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Measure.identifier:versionSpecificIdentifier.type | extensible | Pattern: version-specifichttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Measure.identifier:shortName.use | required | Fixed Value: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Measure.identifier:shortName.type | extensible | Pattern: short-namehttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Measure.identifier:endorserIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Measure.identifier:endorserIdentifier.type | extensible | Pattern: endorserhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Measure.identifier:publisherIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Measure.identifier:publisherIdentifier.type | extensible | Pattern: publisherhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Measure.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| Measure.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| Measure.useContext:intendedVenue.code | extensible | Pattern: venuehttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | ||||
| Measure.useContext:intendedVenue.value[x] | extensible | IntendedVenue (a valid code from Intended Venue Codes)http://hl7.org/fhir/uv/cqm/ValueSet/intended-venuefrom this IG | ||||
| Measure.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| Measure.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | ||||
| Measure.relatedArtifact.type | required | RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | ||||
| Measure.relatedArtifact:predecessor.type | required | Fixed Value: predecessorhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | ||||
| Measure.relatedArtifact:citation.type | required | Fixed Value: citationhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | ||||
| Measure.relatedArtifact:derived-from.type | required | Fixed Value: derived-fromhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | ||||
| Measure.scoring | extensible | MeasureScoringhttp://hl7.org/fhir/ValueSet/measure-scoringfrom the FHIR Standard | ||||
| Measure.compositeScoring | extensible | CompositeMeasureScoringhttp://hl7.org/fhir/ValueSet/composite-measure-scoringfrom the FHIR Standard | ||||
| Measure.type | extensible | MeasureTypehttp://terminology.hl7.org/ValueSet/measure-type | ||||
| Measure.improvementNotation | required | MeasureImprovementNotationhttp://hl7.org/fhir/ValueSet/measure-improvement-notation|4.0.1from the FHIR Standard | ||||
| Measure.group.population.code | extensible | MeasurePopulationTypehttp://hl7.org/fhir/ValueSet/measure-populationfrom the FHIR Standard | ||||
| Measure.supplementalData.usage | extensible | MeasureDataUsagehttp://hl7.org/fhir/ValueSet/measure-data-usagefrom the FHIR Standard |
| Id | Grade | Path(s) | 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() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.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()) |
This structure is derived from CRMIPublishableMeasure
Summary
Mandatory: 20 elements(15 nested mandatory elements)
Must-Support: 66 elements
Fixed: 10 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CRMIPublishableMeasure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Measure |
1..1 | CRMIPublishableMeasure | A quality measure definition | |
| text |
S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| Slices for extension |
Content/Rules for all slices | |||
| supplementalDataGuidance |
S | 0..* | (Complex) | Supplemental data guidance URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-supplementalDataGuidance |
| comment |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| softwaresystem |
S | 0..* | Reference(CRMI Software System Device) | Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem |
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance |
| Slices for identifier |
S | 3..* | Identifier | Additional identifier for the measure Slice: Unordered, Open by value:type |
| identifier:versionIndependentIdentifier |
S | 1..1 | Identifier | Measure guid |
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-independent | |
| system |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 |
| value |
S | 1..1 | string | The value that is unique |
| identifier:versionSpecificIdentifier |
S | 1..1 | Identifier | Measure version guid |
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-specific | |
| system |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 |
| value |
S | 1..1 | string | The value that is unique |
| identifier:shortName |
S | 1..1 | Identifier | Short name |
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: usual |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: short-name | |
| value |
S | 1..1 | string | The value that is unique |
| identifier:endorserIdentifier |
S | 0..* | Identifier | Endorser identifier |
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: endorser | |
| system |
S | 0..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| assigner |
S | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:publisherIdentifier |
S | 0..* | Identifier | Publisher identifier |
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: publisher | |
| system |
S | 0..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| assigner |
S | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| title |
S | 1..1 | string | Name for this measure (human friendly) |
| status |
1..1 | code | draft | active | retired | unknown | |
| date |
S | 1..1 | dateTime | Date last changed |
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |
| contact |
S | 1..* | ContactDetail | Contact details for the publisher |
| Slices for useContext |
S | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
| useContext:intendedVenue |
S | 0..* | UsageContext | What venue? |
| code |
S | 1..1 | Coding | Type of context being specified Required Pattern: At least the following |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: venue | |
| value[x] |
S | 1..1 | CodeableConcept | Value that defines the context Binding: Intended Venue (extensible) |
| purpose |
S | 0..1 | markdown | Why this measure is defined |
| usage |
S | 0..1 | string | Allows measure developers to provide additional guidance so that implementers can more easily interpret and implement components of the measure. |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions |
| approvalDate |
S | 0..1 | date | When the measure was approved by publisher |
| lastReviewDate |
S | 0..1 | date | When the measure was last reviewed |
| effectivePeriod |
S | 0..1 | Period | When the measure is expected to be used |
| Slices for extension |
Content/Rules for all slices | |||
| anchor |
S | 0..1 | dateTime | Date of first effective use URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodAnchor |
| duration |
S | 0..1 | Duration | What reporting period is used URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodDuration |
| topic |
S | 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc. |
| author |
S | 0..* | ContactDetail | Who authored the content |
| editor |
S | 0..* | ContactDetail | Who edited the content |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the content |
| endorser |
S | 0..* | ContactDetail | Who endorsed the content |
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
| relatedArtifact:predecessor |
S | 0..1 | RelatedArtifact | Previous measure? |
| type |
S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: predecessor |
| resource |
S | 1..1 | canonical(Measure) | What resource is being referenced |
| relatedArtifact:citation |
S | 0..* | RelatedArtifact | Reference/citation |
| Slices for extension |
Content/Rules for all slices | |||
| isPrimaryCitation |
0..1 | boolean | Primary reference URL: http://hl7.org/fhir/StructureDefinition/cqf-isPrimaryCitation | |
| publicationStatus |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |
| publicationDate |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |
| type |
S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: citation |
| relatedArtifact:derived-from |
S | 0..* | RelatedArtifact | URL or canonical reference to other resources that a measure is derived from |
| type |
S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: derived-from |
| label |
0..1 | string | Short label | |
| display |
0..1 | string | Brief description of the related artifact | |
| url |
0..1 | url | Should be permalink otherwise include an "accessed date" | |
| resource |
0..1 | canonical(Measure) | Should be permalink otherwise include an "accessed date" | |
| disclaimer |
S | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
| type |
SΣ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) |
| rationale |
S | 0..1 | markdown | Justification for the measure in terms of impact, gap in care, and evidence. |
| definition |
0..* | markdown | Defined terms used in the measure documentation | |
| Slices for extension |
Content/Rules for all slices | |||
| definitionTerm |
1..1 | (Complex) | Defined term URL: http://hl7.org/fhir/StructureDefinition/cqf-definitionTerm | |
| guidance |
0..0 | |||
| group |
||||
| Slices for extension |
Content/Rules for all slices | |||
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance |
| supplementalData |
S | 0..* | BackboneElement | What other data should be reported with the measure |
| Slices for extension |
Content/Rules for all slices | |||
| includeInReportType |
S | 0..* | code | The type of report the element should be included in URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-includeInReportType Binding: MeasureReportType (required): The type of report the element should be included in |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Measure.useContext:intendedVenue.value[x] | extensible | IntendedVenue (a valid code from Intended Venue Codes)http://hl7.org/fhir/uv/cqm/ValueSet/intended-venuefrom this IG | |
| Measure.type | extensible | MeasureTypehttp://terminology.hl7.org/ValueSet/measure-type |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Measure |
C | 1..1 | CRMIPublishableMeasure | A quality measure definition dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management mea-0: Name should be usable as an identifier for the module by machine processing applications such as code generation mea-1: Stratifier SHALL be either a single criteria or a set of criteria components |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| text |
S | 1..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| supplementalDataGuidance |
S | 0..* | (Complex) | Supplemental data guidance URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-supplementalDataGuidance ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| comment |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| softwaresystem |
S | 0..* | Reference(CRMI Software System Device) | Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
SΣ | 3..* | Identifier | Additional identifier for the measure Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children |
| identifier:versionIndependentIdentifier |
SΣ | 1..1 | Identifier | Measure guid ele-1: All FHIR elements must have a @value or children |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-independent | |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: urn:ietf:rfc:3986 |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| identifier:versionSpecificIdentifier |
SΣ | 1..1 | Identifier | Measure version guid ele-1: All FHIR elements must have a @value or children |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-specific | |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: urn:ietf:rfc:3986 |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| identifier:shortName |
SΣ | 1..1 | Identifier | Short name ele-1: All FHIR elements must have a @value or children |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: usual |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: short-name | |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| identifier:endorserIdentifier |
SΣ | 0..* | Identifier | Endorser identifier ele-1: All FHIR elements must have a @value or children |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: endorser | |
| system |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| identifier:publisherIdentifier |
SΣ | 0..* | Identifier | Publisher identifier ele-1: All FHIR elements must have a @value or children |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: publisher | |
| system |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 1..1 | string | Name for this measure (human friendly) ele-1: All FHIR elements must have a @value or children |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 1..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
| publisher |
Σ | 1..1 | string | Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children |
| contact |
SΣ | 1..* | ContactDetail | Contact details for the publisher ele-1: All FHIR elements must have a @value or children |
| Slices for useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code ele-1: All FHIR elements must have a @value or children |
| useContext:intendedVenue |
SΣ | 0..* | UsageContext | What venue? ele-1: All FHIR elements must have a @value or children |
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: venue | |
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Intended Venue (extensible) ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| purpose |
S | 0..1 | markdown | Why this measure is defined ele-1: All FHIR elements must have a @value or children |
| usage |
S | 0..1 | string | Allows measure developers to provide additional guidance so that implementers can more easily interpret and implement components of the measure. ele-1: All FHIR elements must have a @value or children |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions ele-1: All FHIR elements must have a @value or children |
| approvalDate |
S | 0..1 | date | When the measure was approved by publisher ele-1: All FHIR elements must have a @value or children |
| lastReviewDate |
S | 0..1 | date | When the measure was last reviewed ele-1: All FHIR elements must have a @value or children |
| effectivePeriod |
SΣ | 0..1 | Period | When the measure is expected to be used ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| anchor |
S | 0..1 | dateTime | Date of first effective use URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodAnchor ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| duration |
S | 0..1 | Duration | What reporting period is used URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodDuration ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| topic |
S | 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. ele-1: All FHIR elements must have a @value or children |
| author |
S | 0..* | ContactDetail | Who authored the content ele-1: All FHIR elements must have a @value or children |
| editor |
S | 0..* | ContactDetail | Who edited the content ele-1: All FHIR elements must have a @value or children |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the content ele-1: All FHIR elements must have a @value or children |
| endorser |
S | 0..* | ContactDetail | Who endorsed the content ele-1: All FHIR elements must have a @value or children |
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children |
| relatedArtifact:All Slices |
Content/Rules for all slices | |||
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. ele-1: All FHIR elements must have a @value or children |
| display |
SΣ | 0..1 | string | Brief description of the related artifact ele-1: All FHIR elements must have a @value or children |
| document |
SΣ | 0..1 | Attachment | What document is being referenced ele-1: All FHIR elements must have a @value or children |
| resource |
SΣ | 0..1 | canonical(Resource) | What resource is being referenced ele-1: All FHIR elements must have a @value or children |
| relatedArtifact:predecessor |
S | 0..1 | RelatedArtifact | Previous measure? ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. ele-1: All FHIR elements must have a @value or children Fixed Value: predecessor |
| display |
SΣ | 0..1 | string | Brief description of the related artifact ele-1: All FHIR elements must have a @value or children |
| document |
SΣ | 0..1 | Attachment | What document is being referenced ele-1: All FHIR elements must have a @value or children |
| resource |
SΣ | 1..1 | canonical(Measure) | What resource is being referenced ele-1: All FHIR elements must have a @value or children |
| relatedArtifact:citation |
S | 0..* | RelatedArtifact | Reference/citation ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| isPrimaryCitation |
0..1 | boolean | Primary reference URL: http://hl7.org/fhir/StructureDefinition/cqf-isPrimaryCitation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| publicationStatus |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| publicationDate |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. ele-1: All FHIR elements must have a @value or children Fixed Value: citation |
| display |
SΣ | 0..1 | string | Brief description of the related artifact ele-1: All FHIR elements must have a @value or children |
| document |
SΣ | 0..1 | Attachment | What document is being referenced ele-1: All FHIR elements must have a @value or children |
| resource |
SΣ | 0..1 | canonical(Resource) | What resource is being referenced ele-1: All FHIR elements must have a @value or children |
| relatedArtifact:derived-from |
S | 0..* | RelatedArtifact | URL or canonical reference to other resources that a measure is derived from ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. ele-1: All FHIR elements must have a @value or children Fixed Value: derived-from |
| label |
Σ | 0..1 | string | Short label ele-1: All FHIR elements must have a @value or children |
| display |
SΣ | 0..1 | string | Brief description of the related artifact ele-1: All FHIR elements must have a @value or children |
| url |
Σ | 0..1 | url | Should be permalink otherwise include an "accessed date" ele-1: All FHIR elements must have a @value or children |
| document |
SΣ | 0..1 | Attachment | What document is being referenced ele-1: All FHIR elements must have a @value or children |
| resource |
SΣ | 0..1 | canonical(Measure) | Should be permalink otherwise include an "accessed date" ele-1: All FHIR elements must have a @value or children |
| disclaimer |
SΣ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) ele-1: All FHIR elements must have a @value or children |
| rationale |
SΣ | 0..1 | markdown | Justification for the measure in terms of impact, gap in care, and evidence. ele-1: All FHIR elements must have a @value or children |
| definition |
Σ | 0..* | markdown | Defined terms used in the measure documentation ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| definitionTerm |
1..1 | (Complex) | Defined term URL: http://hl7.org/fhir/StructureDefinition/cqf-definitionTerm ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| group |
0..* | BackboneElement | Population criteria group ele-1: All FHIR elements must have a @value or children | |
| Slices for extension |
Content/Rules for all slices | |||
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| supplementalData |
S | 0..* | BackboneElement | What other data should be reported with the measure ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| includeInReportType |
S | 0..* | code | The type of report the element should be included in URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-includeInReportType Binding: MeasureReportType (required): The type of report the element should be included in ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| criteria |
1..1 | Expression | Expression describing additional data to be reported ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Measure.identifier:versionIndependentIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Measure.identifier:versionIndependentIdentifier.type | extensible | Pattern: version-independenthttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Measure.identifier:versionSpecificIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Measure.identifier:versionSpecificIdentifier.type | extensible | Pattern: version-specifichttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Measure.identifier:shortName.use | required | Fixed Value: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Measure.identifier:shortName.type | extensible | Pattern: short-namehttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Measure.identifier:endorserIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Measure.identifier:endorserIdentifier.type | extensible | Pattern: endorserhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Measure.identifier:publisherIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Measure.identifier:publisherIdentifier.type | extensible | Pattern: publisherhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Measure.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| Measure.useContext:intendedVenue.code | extensible | Pattern: venuehttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | |
| Measure.useContext:intendedVenue.value[x] | extensible | IntendedVenue (a valid code from Intended Venue Codes)http://hl7.org/fhir/uv/cqm/ValueSet/intended-venuefrom this IG | |
| Measure.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| Measure.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | |
| Measure.relatedArtifact.type | required | RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | |
| Measure.relatedArtifact:predecessor.type | required | Fixed Value: predecessorhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | |
| Measure.relatedArtifact:citation.type | required | Fixed Value: citationhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | |
| Measure.relatedArtifact:derived-from.type | required | Fixed Value: derived-fromhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | |
| Measure.type | extensible | MeasureTypehttp://terminology.hl7.org/ValueSet/measure-type |
| Id | Grade | Path(s) | 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() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.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()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Measure |
C | 1..1 | CRMIPublishableMeasure | A quality measure definition mea-0: Name should be usable as an identifier for the module by machine processing applications such as code generation mea-1: Stratifier SHALL be either a single criteria or a set of criteria components | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
S | 1..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 | |||||
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| supplementalDataGuidance |
S | 0..* | (Complex) | Supplemental data guidance URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-supplementalDataGuidance | ||||
| comment |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
| softwaresystem |
S | 0..* | Reference(CRMI Software System Device) | Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem | ||||
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | ||||
| Slices for identifier |
SΣ | 3..* | Identifier | Additional identifier for the measure Slice: Unordered, Open by value:type | ||||
| identifier:versionIndependentIdentifier |
SΣ | 1..1 | Identifier | Measure guid | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-independent | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:versionSpecificIdentifier |
SΣ | 1..1 | Identifier | Measure version guid | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: version-specific | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:shortName |
SΣ | 1..1 | Identifier | Short name | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: short-name | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:endorserIdentifier |
SΣ | 0..* | Identifier | Endorser identifier | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: endorser | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:publisherIdentifier |
SΣ | 0..* | Identifier | Publisher identifier | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: publisher | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| version |
Σ | 0..1 | string | Business version of the measure | ||||
| name |
Σ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 |
Σ | 0..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Σ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 1..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
SΣ | 1..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the measure | ||||
| Slices for useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code | ||||
| useContext:intendedVenue |
SΣ | 0..* | UsageContext | What venue? | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code |
SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: venue | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| value[x] |
SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Intended Venue (extensible) | ||||
| 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 |
S | 0..1 | markdown | Why this measure is defined | ||||
| usage |
S | 0..1 | string | Allows measure developers to provide additional guidance so that implementers can more easily interpret and implement components of the measure. | ||||
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions | ||||
| approvalDate |
S | 0..1 | date | When the measure was approved by publisher | ||||
| lastReviewDate |
S | 0..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 | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| anchor |
S | 0..1 | dateTime | Date of first effective use URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodAnchor | ||||
| duration |
S | 0..1 | Duration | What reporting period is used URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-effectivePeriodDuration | ||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| topic |
S | 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 |
S | 0..* | ContactDetail | Who authored the content | ||||
| editor |
S | 0..* | ContactDetail | Who edited the content | ||||
| reviewer |
S | 0..* | ContactDetail | Who reviewed the content | ||||
| endorser |
S | 0..* | ContactDetail | Who endorsed the content | ||||
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type | ||||
| relatedArtifact:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
SΣ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
| relatedArtifact:predecessor |
S | 0..1 | RelatedArtifact | Previous measure? | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: predecessor | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
SΣ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 1..1 | canonical(Measure) | What resource is being referenced | ||||
| relatedArtifact:citation |
S | 0..* | RelatedArtifact | Reference/citation | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| isPrimaryCitation |
0..1 | boolean | Primary reference URL: http://hl7.org/fhir/StructureDefinition/cqf-isPrimaryCitation | |||||
| publicationStatus |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |||||
| publicationDate |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |||||
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: citation | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
SΣ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
| relatedArtifact:derived-from |
S | 0..* | RelatedArtifact | URL or canonical reference to other resources that a measure is derived from | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: derived-from | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Should be permalink otherwise include an "accessed date" | ||||
| document |
SΣ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 0..1 | canonical(Measure) | Should be permalink otherwise include an "accessed date" | ||||
| library |
0..* | canonical(Library) | Logic used by the measure | |||||
| disclaimer |
SΣ | 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 |
SΣ | 0..1 | markdown | Justification for the measure in terms of impact, gap in care, and evidence. | ||||
| 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 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| definitionTerm |
1..1 | (Complex) | Defined term URL: http://hl7.org/fhir/StructureDefinition/cqf-definitionTerm | |||||
| value |
0..1 | string | Primitive value for markdown | |||||
| group |
0..* | BackboneElement | Population criteria group | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| improvementNotationGuidance |
S | 0..1 | markdown | Explanation of improvement notation URL: http://hl7.org/fhir/StructureDefinition/cqf-improvementNotationGuidance | ||||
| 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 |
0..* | BackboneElement | Population criteria | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible): The type of population. | |||||
| description |
0..1 | string | The human readable description of this population criteria | |||||
| criteria |
1..1 | Expression | The criteria that defines this population | |||||
| stratifier |
0..* | BackboneElement | Stratifier criteria for the measure | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | Meaning of the stratifier | |||||
| description |
0..1 | string | The human readable description of this stratifier | |||||
| criteria |
0..1 | Expression | How the measure should be stratified | |||||
| component |
0..* | BackboneElement | Stratifier criteria component for the measure | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | Meaning of the stratifier component | |||||
| 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 |
S | 0..* | BackboneElement | What other data should be reported with the measure | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| includeInReportType |
S | 0..* | code | The type of report the element should be included in URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-includeInReportType Binding: MeasureReportType (required): The type of report the element should be included in | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | Meaning of the supplemental data | |||||
| usage |
0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure. | |||||
| description |
0..1 | string | The human readable description of this supplemental data | |||||
| criteria |
1..1 | Expression | Expression describing additional data to be reported | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Measure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Measure.identifier:versionIndependentIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Measure.identifier:versionIndependentIdentifier.type | extensible | Pattern: version-independenthttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Measure.identifier:versionSpecificIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Measure.identifier:versionSpecificIdentifier.type | extensible | Pattern: version-specifichttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Measure.identifier:shortName.use | required | Fixed Value: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Measure.identifier:shortName.type | extensible | Pattern: short-namehttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Measure.identifier:endorserIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Measure.identifier:endorserIdentifier.type | extensible | Pattern: endorserhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Measure.identifier:publisherIdentifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Measure.identifier:publisherIdentifier.type | extensible | Pattern: publisherhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Measure.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| Measure.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| Measure.useContext:intendedVenue.code | extensible | Pattern: venuehttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | ||||
| Measure.useContext:intendedVenue.value[x] | extensible | IntendedVenue (a valid code from Intended Venue Codes)http://hl7.org/fhir/uv/cqm/ValueSet/intended-venuefrom this IG | ||||
| Measure.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| Measure.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | ||||
| Measure.relatedArtifact.type | required | RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | ||||
| Measure.relatedArtifact:predecessor.type | required | Fixed Value: predecessorhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | ||||
| Measure.relatedArtifact:citation.type | required | Fixed Value: citationhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | ||||
| Measure.relatedArtifact:derived-from.type | required | Fixed Value: derived-fromhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1from the FHIR Standard | ||||
| Measure.scoring | extensible | MeasureScoringhttp://hl7.org/fhir/ValueSet/measure-scoringfrom the FHIR Standard | ||||
| Measure.compositeScoring | extensible | CompositeMeasureScoringhttp://hl7.org/fhir/ValueSet/composite-measure-scoringfrom the FHIR Standard | ||||
| Measure.type | extensible | MeasureTypehttp://terminology.hl7.org/ValueSet/measure-type | ||||
| Measure.improvementNotation | required | MeasureImprovementNotationhttp://hl7.org/fhir/ValueSet/measure-improvement-notation|4.0.1from the FHIR Standard | ||||
| Measure.group.population.code | extensible | MeasurePopulationTypehttp://hl7.org/fhir/ValueSet/measure-populationfrom the FHIR Standard | ||||
| Measure.supplementalData.usage | extensible | MeasureDataUsagehttp://hl7.org/fhir/ValueSet/measure-data-usagefrom the FHIR Standard |
| Id | Grade | Path(s) | 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() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.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()) |
This structure is derived from CRMIPublishableMeasure
Summary
Mandatory: 20 elements(15 nested mandatory elements)
Must-Support: 66 elements
Fixed: 10 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Clinical Quality Information. Package hl7.fhir.uv.cqm#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-12-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change