Quality Measure STU1 for FHIR STU3 Implementation Guide
This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v1.0.0: STU 1) based on FHIR R3. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/library-cqfm
The CQFM Library profile defines expectations for a library used to distribute eCQM logic
This profile builds on Library.
This profile was published on Wed Feb 13 00:00:00 EST 2019 as a active by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
Summary
Mandatory: 13 elements (2 nested mandatory elements)
Must-Support: 29 elements
Fixed Value: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Library | I | 0..* | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 cqfm-artifactComment | SI | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Logical URI to reference this library (globally unique) |
| identifier | SΣ | 1..* | Identifier | Additional identifier for the library |
| version | SΣ | 1..1 | string | Business version of the library |
| name | SΣ | 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) |
| experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
| type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible) |
| date | SΣ | 1..1 | dateTime | Date this was last changed |
| publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
| description | SΣ | 1..1 | markdown | Natural language description of the library |
| purpose | S | 0..1 | markdown | Why this library is defined |
| usage | S | 0..1 | string | Describes the clinical usage of the library |
| approvalDate | S | 1..1 | date | When the library was approved by publisher |
| lastReviewDate | S | 1..1 | date | When the library was last reviewed |
| effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used |
| useContext | SΣ | 0..* | UsageContext | Context the content is intended to support |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example) |
| contributor | S | 0..* | Contributor | A content contributor |
| contact | SΣ | 1..* | ContactDetail | Contact details for the publisher |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| relatedArtifact | S | 0..* | RelatedArtifact | Any referenced CQL libraries or additional documentation, citations, etc. |
| parameter | S | 0..* | ParameterDefinition | Parameters defined by the library |
| dataRequirement | S | 0..* | DataRequirement | What data is referenced by this library |
  content | 0..* | (Slice Definition) | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType | |
  content:cqlContent | S | 1..* | Attachment | Contents of the library, either embedded or referenced |
  id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: mimetypes (required) Fixed Value: text/cql |
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: Common Languages (extensible) Max Binding: All Languages Example General: en-AU |
| data | 0..1 | base64Binary | Data inline, base64ed | |
| url | Σ | 0..1 | uri | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
 creation | Σ | 0..1 | dateTime | Date attachment was first created |
| content:elmXmlContent | S | 0..* | Attachment | Contents of the library, either embedded or referenced |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: mimetypes (required) Fixed Value: application/elm+xml |
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: Common Languages (extensible) Max Binding: All Languages Example General: en-AU |
| data | 0..1 | base64Binary | Data inline, base64ed | |
| url | Σ | 0..1 | uri | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
| creation | Σ | 0..1 | dateTime | Date attachment was first created |
 content:elmJsonContent | S | 0..* | Attachment | Contents of the library, either embedded or referenced |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: mimetypes (required) Fixed Value: application/elm+json |
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: Common Languages (extensible) Max Binding: All Languages Example General: en-AU |
| data | 0..1 | base64Binary | Data inline, base64ed | |
| url | Σ | 0..1 | uri | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
| creation | Σ | 0..1 | dateTime | Date attachment was first created |
| Documentation for this format | ||||
Summary
Mandatory: 13 elements (2 nested mandatory elements)
Must-Support: 29 elements
Fixed Value: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | I | 0..* | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| cqfm-artifactComment | SI | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Logical URI to reference this library (globally unique) |
| identifier | SΣ | 1..* | Identifier | Additional identifier for the library |
| version | SΣ | 1..1 | string | Business version of the library |
| name | SΣ | 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) |
| experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
| type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible) |
| date | SΣ | 1..1 | dateTime | Date this was last changed |
| publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
| description | SΣ | 1..1 | markdown | Natural language description of the library |
| purpose | S | 0..1 | markdown | Why this library is defined |
| usage | S | 0..1 | string | Describes the clinical usage of the library |
| approvalDate | S | 1..1 | date | When the library was approved by publisher |
| lastReviewDate | S | 1..1 | date | When the library was last reviewed |
| effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used |
| useContext | SΣ | 0..* | UsageContext | Context the content is intended to support |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example) |
| contributor | S | 0..* | Contributor | A content contributor |
| contact | SΣ | 1..* | ContactDetail | Contact details for the publisher |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| relatedArtifact | S | 0..* | RelatedArtifact | Any referenced CQL libraries or additional documentation, citations, etc. |
| parameter | S | 0..* | ParameterDefinition | Parameters defined by the library |
| dataRequirement | S | 0..* | DataRequirement | What data is referenced by this library |
| content | 0..* | (Slice Definition) | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType | |
| content:cqlContent | S | 1..* | Attachment | Contents of the library, either embedded or referenced |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: mimetypes (required) Fixed Value: text/cql |
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: Common Languages (extensible) Max Binding: All Languages Example General: en-AU |
| data | 0..1 | base64Binary | Data inline, base64ed | |
| url | Σ | 0..1 | uri | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
| creation | Σ | 0..1 | dateTime | Date attachment was first created |
| content:elmXmlContent | S | 0..* | Attachment | Contents of the library, either embedded or referenced |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: mimetypes (required) Fixed Value: application/elm+xml |
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: Common Languages (extensible) Max Binding: All Languages Example General: en-AU |
| data | 0..1 | base64Binary | Data inline, base64ed | |
| url | Σ | 0..1 | uri | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
| creation | Σ | 0..1 | dateTime | Date attachment was first created |
| content:elmJsonContent | S | 0..* | Attachment | Contents of the library, either embedded or referenced |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: mimetypes (required) Fixed Value: application/elm+json |
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: Common Languages (extensible) Max Binding: All Languages Example General: en-AU |
| data | 0..1 | base64Binary | Data inline, base64ed | |
| url | Σ | 0..1 | uri | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
| creation | Σ | 0..1 | dateTime | Date attachment was first created |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Library.language | extensible | Common Languages Max Binding: All Languages |
| Library.status | required | PublicationStatus |
| Library.type | extensible | LibraryType |
| Library.jurisdiction | extensible | Jurisdiction ValueSet |
| Library.topic | example | DefinitionTopic |
| Library.content:cqlContent.contentType | required | Fixed Value: text/cql |
| Library.content:cqlContent.language | extensible | Common Languages Max Binding: All Languages |
| Library.content:elmXmlContent.contentType | required | Fixed Value: application/elm+xml |
| Library.content:elmXmlContent.language | extensible | Common Languages Max Binding: All Languages |
| Library.content:elmJsonContent.contentType | required | Fixed Value: application/elm+json |
| Library.content:elmJsonContent.language | extensible | Common Languages Max Binding: All Languages |
| 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-1 | Library | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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-3 | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | Library.extension | All FHIR elements must have a @value or children : hasValue() | (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 | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Library.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
© HL7.org (Clinical Quality Information WG). hl7.fhir.us.cqfmeasures#1.0.0 based on FHIR v3.0.2 generated 20/11/2019.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change