Quality Measure Implementation Guide (STU5)
5.0.0-ballot - ballot
Quality Measure Implementation Guide (STU5)
5.0.0-ballot - ballot
This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v5.0.0-ballot: STU5 (v5.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/quality-program-cqfm | Version: 5.0.0-ballot | |||
| Active as of 2023-12-15 | Computable Name: CQFMQualityProgram | |||
Defines and supports the definition of Quality Programs
Quality programs must be able to specify the set of measures they use, as well as provide versioning information for all the dependencies used in a particular release to enable stable expansion of value sets. Specifically, the versions of code systems used to construct value sets referenced by the measures must be identified so that terminology servers performing expansions can unambiguously select the version of each code system used to perform the expansion.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Shareable Library
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Library | 1..1 | Shareable Library | Represents a library of quality improvement components | |
  text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
 partOf | S | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf |
| directReferenceCode | S | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode |
| cqlOptions | S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions |
| expansionParameters | S | 0..1 | Reference(Parameters) | What expansion rules URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters |
| identifier | S | 1..* | Identifier | Additional identifier for the library |
| title | S | 1..1 | string | Name for this library (human friendly) |
  type | S | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition 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/library-type | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
| date | S | 1..1 | dateTime | Date last changed |
 Slices for useContext | S | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
 useContext:qualityProgram | S | 0..1 | UsageContext | The context that the content is intended to support |
 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: program | |
 value[x] | S | 1..1 | CodeableConcept | Value that defines the context Binding: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs |
| effectivePeriod | S | 0..1 | Period | When the library is expected to be used |
| Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
 relatedArtifact:content | S | 0..* | RelatedArtifact | Measure, ValueSet, or Library (and version) |
  programIdentifier | S | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier |
| qualityDomain | S | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain |
| meaningfulMeasureArea | S | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea |
 type | S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: composed-of |
| display | S | 0..1 | string | Brief description of the related artifact |
| resource | S | 1..1 | canonical(Shareable Measure | Shareable ValueSet | Shareable Library) | What resource is being referenced |
| relatedArtifact:dependency | S | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) |
| type | S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: depends-on |
| display | S | 0..1 | string | Brief description of the related artifact |
| resource | S | 1..1 | canonical(CodeSystem | Library | ValueSet) | What resource is being referenced |
| content | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Library.useContext:qualityProgram.value[x] | example | QualityPrograms (a valid code from Quality Programs Codes) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | C | 1..1 | Shareable Library | Represents a library of quality improvement components |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| partOf | S | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf |
| directReferenceCode | S | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode |
| cqlOptions | S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions |
| expansionParameters | S | 0..1 | Reference(Parameters) | What expansion rules URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| identifier | SΣ | 1..* | Identifier | Additional identifier for the library |
| version | Σ | 1..1 | string | Business version of the library |
| name | ΣC | 1..1 | string | Name for this library (computer friendly) |
| title | SΣ | 1..1 | string | Name for this library (human friendly) |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental | Σ | 1..1 | boolean | For testing purposes, not real usage |
| type | SΣ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. 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/library-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
| date | SΣ | 1..1 | dateTime | Date last changed |
| publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | Σ | 1..1 | markdown | Natural language description of the library |
| Slices for useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
| useContext:qualityProgram | SΣ | 0..1 | UsageContext | The context that the content is intended to support |
| 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 |
| 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: program | |
| value[x] | SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used |
| Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
| relatedArtifact:content | S | 0..* | RelatedArtifact | Measure, ValueSet, or Library (and version) |
| programIdentifier | S | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier |
| qualityDomain | S | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain |
| meaningfulMeasureArea | S | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea |
| 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: composed-of |
| display | SΣ | 0..1 | string | Brief description of the related artifact |
| resource | SΣ | 1..1 | canonical(Shareable Measure | Shareable ValueSet | Shareable Library) | What resource is being referenced |
| relatedArtifact:dependency | S | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) |
| 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: depends-on |
| display | SΣ | 0..1 | string | Brief description of the related artifact |
| resource | SΣ | 1..1 | canonical(CodeSystem | Library | ValueSet) | What resource is being referenced |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Library.status | required | PublicationStatus |
| Library.type | extensible | Pattern: asset-collection |
| Library.useContext:qualityProgram.code | extensible | Pattern: program |
| Library.useContext:qualityProgram.value[x] | example | QualityPrograms (a valid code from Quality Programs Codes) |
| Library.jurisdiction | extensible | Jurisdiction ValueSet |
| Library.relatedArtifact:content.type | required | Fixed Value: composed-of |
| Library.relatedArtifact:dependency.type | required | Fixed Value: depends-on |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | 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 | Library | 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 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | 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() | |
| lib-0 | warning | Library | 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}') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Library | C | 1..1 | Shareable Library | Represents a library of quality improvement 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 | |||||
| partOf | S | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf | ||||
| directReferenceCode | S | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode | ||||
| cqlOptions | S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions | ||||
| expansionParameters | S | 0..1 | Reference(Parameters) | What expansion rules URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier | SΣ | 1..* | Identifier | Additional identifier for the library | ||||
| version | Σ | 1..1 | string | Business version of the library | ||||
| name | ΣC | 1..1 | string | Name for this library (computer friendly) | ||||
| title | SΣ | 1..1 | string | Name for this library (human friendly) | ||||
| subtitle | 0..1 | string | Subordinate title of the library | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
| type | SΣ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. 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/library-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |||||
| 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 | |||||
 subject[x] | 0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible): The possible types of subjects for a library (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Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | Σ | 1..1 | markdown | Natural language description of the library | ||||
| Slices for useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code | ||||
| useContext:qualityProgram | SΣ | 0..1 | UsageContext | The context that the content is intended to support | ||||
| 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: program | |||||
| 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: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs | ||||
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this library is defined | |||||
| usage | 0..1 | string | Describes the clinical usage of the library | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate | 0..1 | date | When the library was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the library was last reviewed | |||||
| effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used | ||||
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author | 0..* | ContactDetail | Who authored the content | |||||
| editor | 0..* | ContactDetail | Who edited the content | |||||
| reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
| endorser | 0..* | ContactDetail | Who endorsed the content | |||||
| Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type | ||||
| relatedArtifact:content | S | 0..* | RelatedArtifact | Measure, ValueSet, or Library (and version) | ||||
| 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 | |||||
| programIdentifier | S | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier | ||||
| qualityDomain | S | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain | ||||
| meaningfulMeasureArea | S | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea | ||||
| 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: composed-of | ||||
| 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 | Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource | SΣ | 1..1 | canonical(Shareable Measure | Shareable ValueSet | Shareable Library) | What resource is being referenced | ||||
| relatedArtifact:dependency | S | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) | ||||
| 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: depends-on | ||||
| 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 | Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource | SΣ | 1..1 | canonical(CodeSystem | Library | ValueSet) | What resource is being referenced | ||||
| parameter | 0..* | ParameterDefinition | Parameters defined by the library | |||||
| dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Library.language | preferred | CommonLanguages
| ||||
| Library.status | required | PublicationStatus | ||||
| Library.type | extensible | Pattern: asset-collection | ||||
| Library.subject[x] | extensible | SubjectType | ||||
| Library.useContext:qualityProgram.code | extensible | Pattern: program | ||||
| Library.useContext:qualityProgram.value[x] | example | QualityPrograms (a valid code from Quality Programs Codes) | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| Library.topic | example | DefinitionTopic | ||||
| Library.relatedArtifact:content.type | required | Fixed Value: composed-of | ||||
| Library.relatedArtifact:dependency.type | required | Fixed Value: depends-on |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | 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 | Library | 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 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | 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() | |
| lib-0 | warning | Library | 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}') |
This structure is derived from Shareable Library
Summary
Mandatory: 5 elements (6 nested mandatory elements)
Must-Support: 26 elements
Fixed Value: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Shareable Library
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | 1..1 | Shareable Library | Represents a library of quality improvement components | |
| text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| partOf | S | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf |
| directReferenceCode | S | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode |
| cqlOptions | S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions |
| expansionParameters | S | 0..1 | Reference(Parameters) | What expansion rules URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters |
| identifier | S | 1..* | Identifier | Additional identifier for the library |
| title | S | 1..1 | string | Name for this library (human friendly) |
| type | S | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition 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/library-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
| date | S | 1..1 | dateTime | Date last changed |
| Slices for useContext | S | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
| useContext:qualityProgram | S | 0..1 | UsageContext | The context that the content is intended to support |
| 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: program | |
| value[x] | S | 1..1 | CodeableConcept | Value that defines the context Binding: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs |
| effectivePeriod | S | 0..1 | Period | When the library is expected to be used |
| Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
| relatedArtifact:content | S | 0..* | RelatedArtifact | Measure, ValueSet, or Library (and version) |
| programIdentifier | S | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier |
| qualityDomain | S | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain |
| meaningfulMeasureArea | S | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea |
| type | S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: composed-of |
| display | S | 0..1 | string | Brief description of the related artifact |
| resource | S | 1..1 | canonical(Shareable Measure | Shareable ValueSet | Shareable Library) | What resource is being referenced |
| relatedArtifact:dependency | S | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) |
| type | S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: depends-on |
| display | S | 0..1 | string | Brief description of the related artifact |
| resource | S | 1..1 | canonical(CodeSystem | Library | ValueSet) | What resource is being referenced |
| content | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Library.useContext:qualityProgram.value[x] | example | QualityPrograms (a valid code from Quality Programs Codes) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | C | 1..1 | Shareable Library | Represents a library of quality improvement components |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| partOf | S | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf |
| directReferenceCode | S | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode |
| cqlOptions | S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions |
| expansionParameters | S | 0..1 | Reference(Parameters) | What expansion rules URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| identifier | SΣ | 1..* | Identifier | Additional identifier for the library |
| version | Σ | 1..1 | string | Business version of the library |
| name | ΣC | 1..1 | string | Name for this library (computer friendly) |
| title | SΣ | 1..1 | string | Name for this library (human friendly) |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental | Σ | 1..1 | boolean | For testing purposes, not real usage |
| type | SΣ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. 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/library-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
| date | SΣ | 1..1 | dateTime | Date last changed |
| publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | Σ | 1..1 | markdown | Natural language description of the library |
| Slices for useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
| useContext:qualityProgram | SΣ | 0..1 | UsageContext | The context that the content is intended to support |
| 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 |
| 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: program | |
| value[x] | SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used |
| Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
| relatedArtifact:content | S | 0..* | RelatedArtifact | Measure, ValueSet, or Library (and version) |
| programIdentifier | S | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier |
| qualityDomain | S | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain |
| meaningfulMeasureArea | S | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea |
| 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: composed-of |
| display | SΣ | 0..1 | string | Brief description of the related artifact |
| resource | SΣ | 1..1 | canonical(Shareable Measure | Shareable ValueSet | Shareable Library) | What resource is being referenced |
| relatedArtifact:dependency | S | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) |
| 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: depends-on |
| display | SΣ | 0..1 | string | Brief description of the related artifact |
| resource | SΣ | 1..1 | canonical(CodeSystem | Library | ValueSet) | What resource is being referenced |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Library.status | required | PublicationStatus |
| Library.type | extensible | Pattern: asset-collection |
| Library.useContext:qualityProgram.code | extensible | Pattern: program |
| Library.useContext:qualityProgram.value[x] | example | QualityPrograms (a valid code from Quality Programs Codes) |
| Library.jurisdiction | extensible | Jurisdiction ValueSet |
| Library.relatedArtifact:content.type | required | Fixed Value: composed-of |
| Library.relatedArtifact:dependency.type | required | Fixed Value: depends-on |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | 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 | Library | 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 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | 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() | |
| lib-0 | warning | Library | 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}') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Library | C | 1..1 | Shareable Library | Represents a library of quality improvement 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 | |||||
| partOf | S | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf | ||||
| directReferenceCode | S | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode | ||||
| cqlOptions | S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions | ||||
| expansionParameters | S | 0..1 | Reference(Parameters) | What expansion rules URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier | SΣ | 1..* | Identifier | Additional identifier for the library | ||||
| version | Σ | 1..1 | string | Business version of the library | ||||
| name | ΣC | 1..1 | string | Name for this library (computer friendly) | ||||
| title | SΣ | 1..1 | string | Name for this library (human friendly) | ||||
| subtitle | 0..1 | string | Subordinate title of the library | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
| type | SΣ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. 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/library-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |||||
| 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 | |||||
| subject[x] | 0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible): The possible types of subjects for a library (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Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | Σ | 1..1 | markdown | Natural language description of the library | ||||
| Slices for useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code | ||||
| useContext:qualityProgram | SΣ | 0..1 | UsageContext | The context that the content is intended to support | ||||
| 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: program | |||||
| 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: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs | ||||
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this library is defined | |||||
| usage | 0..1 | string | Describes the clinical usage of the library | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate | 0..1 | date | When the library was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the library was last reviewed | |||||
| effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used | ||||
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author | 0..* | ContactDetail | Who authored the content | |||||
| editor | 0..* | ContactDetail | Who edited the content | |||||
| reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
| endorser | 0..* | ContactDetail | Who endorsed the content | |||||
| Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type | ||||
| relatedArtifact:content | S | 0..* | RelatedArtifact | Measure, ValueSet, or Library (and version) | ||||
| 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 | |||||
| programIdentifier | S | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier | ||||
| qualityDomain | S | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain | ||||
| meaningfulMeasureArea | S | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea | ||||
| 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: composed-of | ||||
| 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 | Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource | SΣ | 1..1 | canonical(Shareable Measure | Shareable ValueSet | Shareable Library) | What resource is being referenced | ||||
| relatedArtifact:dependency | S | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) | ||||
| 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: depends-on | ||||
| 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 | Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource | SΣ | 1..1 | canonical(CodeSystem | Library | ValueSet) | What resource is being referenced | ||||
| parameter | 0..* | ParameterDefinition | Parameters defined by the library | |||||
| dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Library.language | preferred | CommonLanguages
| ||||
| Library.status | required | PublicationStatus | ||||
| Library.type | extensible | Pattern: asset-collection | ||||
| Library.subject[x] | extensible | SubjectType | ||||
| Library.useContext:qualityProgram.code | extensible | Pattern: program | ||||
| Library.useContext:qualityProgram.value[x] | example | QualityPrograms (a valid code from Quality Programs Codes) | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| Library.topic | example | DefinitionTopic | ||||
| Library.relatedArtifact:content.type | required | Fixed Value: composed-of | ||||
| Library.relatedArtifact:dependency.type | required | Fixed Value: depends-on |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | 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 | Library | 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 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | 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() | |
| lib-0 | warning | Library | 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}') |
This structure is derived from Shareable Library
Summary
Mandatory: 5 elements (6 nested mandatory elements)
Must-Support: 26 elements
Fixed Value: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
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.us.cqfmeasures#5.0.0-ballot based on FHIR 4.0.1. Generated 2023-12-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change