Quality Measure STU2 for FHIR R4 Implementation Guide
This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v2.0.0: STU 2) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/library-cqfm
The CQFM Library profile defines the minimum expectations for a library used to distribute eCQM logic
This profile builds on Shareable Library.
This profile was published on Wed Feb 13 00:00:00 UTC 2019 as a active by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Library | 1..1 | Shareable Library | Represents a library of quality improvement components | |
  meta | 1..1 | Meta | Metadata about the resource | |
  profile | S | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
 cqfm-artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment |
| type | S | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | I | 1..1 | Shareable Library | Represents a library of quality improvement components |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
 extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| versionId | ΣI | 0..1 | id | Version specific identifier |
| lastUpdated | ΣI | 0..1 | instant | When the resource version last changed |
| source | ΣI | 0..1 | uri | Identifies where the resource comes from |
| profile | SΣI | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | ΣI | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | ΣI | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| cqfm-artifactComment | SI | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| url | ΣI | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| identifier | SΣI | 0..* | Identifier | Additional identifier for the library |
| version | ΣI | 1..1 | string | Business version of the library |
| name | ΣI | 1..1 | string | Name for this library (computer friendly) |
| title | SΣI | 0..1 | string | Name for this library (human friendly) |
| subtitle | I | 0..1 | string | Subordinate title of the library |
| status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
| experimental | ΣI | 1..1 | boolean | For testing purposes, not real usage |
| type | SΣI | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible) |
 subject[x] | I | 0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible) | |
| subjectCodeableConcept | CodeableConcept | |||
 subjectReference | Reference(Group) | |||
| date | SΣI | 0..1 | dateTime | Date last changed |
| publisher | ΣI | 1..1 | string | Name of the publisher (organization or individual) |
| contact | SΣI | 0..* | ContactDetail | Contact details for the publisher |
| description | ΣI | 1..1 | markdown | Natural language description of the library |
| useContext | SΣI | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | SΣI | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| purpose | I | 0..1 | markdown | Why this library is defined |
| usage | I | 0..1 | string | Describes the clinical usage of the library |
| copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
| approvalDate | I | 0..1 | date | When the library was approved by publisher |
| lastReviewDate | I | 0..1 | date | When the library was last reviewed |
| effectivePeriod | ΣI | 0..1 | Period | When the library is expected to be used |
| topic | I | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example) |
| author | I | 0..* | ContactDetail | Who authored the content |
| editor | I | 0..* | ContactDetail | Who edited the content |
| reviewer | I | 0..* | ContactDetail | Who reviewed the content |
| endorser | I | 0..* | ContactDetail | Who endorsed the content |
| relatedArtifact | I | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
| parameter | I | 0..* | ParameterDefinition | Parameters defined by the library |
| dataRequirement | I | 0..* | DataRequirement | What data is referenced by this library |
| content | ΣI | 0..* | Attachment | Contents of the library, either embedded or referenced |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | 1..1 | Shareable Library | Represents a library of quality improvement components | |
| meta | 1..1 | Meta | Metadata about the resource | |
| profile | S | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| cqfm-artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment |
| type | S | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | I | 1..1 | Shareable Library | Represents a library of quality improvement components |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| versionId | ΣI | 0..1 | id | Version specific identifier |
| lastUpdated | ΣI | 0..1 | instant | When the resource version last changed |
| source | ΣI | 0..1 | uri | Identifies where the resource comes from |
| profile | SΣI | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | ΣI | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | ΣI | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| cqfm-artifactComment | SI | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| url | ΣI | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| identifier | SΣI | 0..* | Identifier | Additional identifier for the library |
| version | ΣI | 1..1 | string | Business version of the library |
| name | ΣI | 1..1 | string | Name for this library (computer friendly) |
| title | SΣI | 0..1 | string | Name for this library (human friendly) |
| subtitle | I | 0..1 | string | Subordinate title of the library |
| status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
| experimental | ΣI | 1..1 | boolean | For testing purposes, not real usage |
| type | SΣI | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible) |
| subject[x] | I | 0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible) | |
| subjectCodeableConcept | CodeableConcept | |||
| subjectReference | Reference(Group) | |||
| date | SΣI | 0..1 | dateTime | Date last changed |
| publisher | ΣI | 1..1 | string | Name of the publisher (organization or individual) |
| contact | SΣI | 0..* | ContactDetail | Contact details for the publisher |
| description | ΣI | 1..1 | markdown | Natural language description of the library |
| useContext | SΣI | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | SΣI | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| purpose | I | 0..1 | markdown | Why this library is defined |
| usage | I | 0..1 | string | Describes the clinical usage of the library |
| copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
| approvalDate | I | 0..1 | date | When the library was approved by publisher |
| lastReviewDate | I | 0..1 | date | When the library was last reviewed |
| effectivePeriod | ΣI | 0..1 | Period | When the library is expected to be used |
| topic | I | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example) |
| author | I | 0..* | ContactDetail | Who authored the content |
| editor | I | 0..* | ContactDetail | Who edited the content |
| reviewer | I | 0..* | ContactDetail | Who reviewed the content |
| endorser | I | 0..* | ContactDetail | Who endorsed the content |
| relatedArtifact | I | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
| parameter | I | 0..* | ParameterDefinition | Parameters defined by the library |
| dataRequirement | I | 0..* | DataRequirement | What data is referenced by this library |
| content | ΣI | 0..* | Attachment | Contents of the library, either embedded or referenced |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Library.meta.security | extensible | All Security Labels |
| Library.meta.tag | example | CommonTags |
| Library.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Library.status | required | PublicationStatus |
| Library.type | extensible | LibraryType |
| Library.subject[x] | extensible | SubjectType |
| Library.jurisdiction | extensible | Jurisdiction ValueSet |
| Library.topic | example | DefinitionTopic |
| Id | Path | Details | Requirements |
| dom-2 | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Library | A resource should have narrative for robust management : text.`div`.exists() | |
| lib-0 | 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}') | |
| ele-1 | Library.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.meta.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Library.meta.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Library.meta.versionId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.meta.lastUpdated | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.meta.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.meta.profile | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.meta.security | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.meta.tag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Library.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Library.extension:comment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Library.extension:comment | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Library.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Library.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Library.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.subtitle | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.experimental | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.subject[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.publisher | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.useContext | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.jurisdiction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.purpose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.usage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.copyright | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.approvalDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.lastReviewDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.effectivePeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.topic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.editor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.reviewer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.endorser | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.relatedArtifact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.dataRequirement | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Library.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org 2019+ (Clinical Quality Information WG). hl7.fhir.us.cqfmeasures#2.0.0 based on FHIR v4.0.1. Generated 2020-07-23.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change