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

D.4.1 StructureDefinition: library-cqfm

Examples:

Example Common Library
Supplemental Data Elements Shared Library
Global Common Functions Shared Library
Adult Outpatient Encounters Shared Library
Hospice Shared Library
Continuous Variable Measure Library
Patient-based Proportion Measure Library
Encounter-based Proportion Measure Library
Risk Adjustment Measure Library
Cohort Measure Library
Hospital Measure Library

D.4.1.1 Formal Views of Profile Content

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:

  • The element Library.content is sliced based on the value of value:contentType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I0..*Represents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqfm-artifactComment SI0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriLogical URI to reference this library (globally unique)
... identifier SΣ1..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... name SΣ1..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible)
... date SΣ1..1dateTimeDate this was last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... description SΣ1..1markdownNatural language description of the library
... purpose S0..1markdownWhy this library is defined
... usage S0..1stringDescribes the clinical usage of the library
... approvalDate S1..1dateWhen the library was approved by publisher
... lastReviewDate S1..1dateWhen the library was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the library is expected to be used
... useContext SΣ0..*UsageContextContext the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... contributor S0..*ContributorA content contributor
... contact SΣ1..*ContactDetailContact details for the publisher
... copyright S0..1markdownUse and/or publishing restrictions
... relatedArtifact S0..*RelatedArtifactAny referenced CQL libraries or additional documentation, citations, etc.
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat 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 S1..*AttachmentContents of the library, either embedded or referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: mimetypes (required)
Fixed Value: text/cql
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible)
Max Binding: All Languages
Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ0..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
.... content:elmXmlContent S0..*AttachmentContents of the library, either embedded or referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: mimetypes (required)
Fixed Value: application/elm+xml
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible)
Max Binding: All Languages
Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ0..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
.... content:elmJsonContent S0..*AttachmentContents of the library, either embedded or referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: mimetypes (required)
Fixed Value: application/elm+json
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible)
Max Binding: All Languages
Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ0..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created

doco 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:

  • The element Library.content is sliced based on the value of value:contentType

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I0..*Represents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqfm-artifactComment SI0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriLogical URI to reference this library (globally unique)
... identifier SΣ1..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... name SΣ1..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible)
... date SΣ1..1dateTimeDate this was last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... description SΣ1..1markdownNatural language description of the library
... purpose S0..1markdownWhy this library is defined
... usage S0..1stringDescribes the clinical usage of the library
... approvalDate S1..1dateWhen the library was approved by publisher
... lastReviewDate S1..1dateWhen the library was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the library is expected to be used
... useContext SΣ0..*UsageContextContext the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... contributor S0..*ContributorA content contributor
... contact SΣ1..*ContactDetailContact details for the publisher
... copyright S0..1markdownUse and/or publishing restrictions
... relatedArtifact S0..*RelatedArtifactAny referenced CQL libraries or additional documentation, citations, etc.
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat 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 S1..*AttachmentContents of the library, either embedded or referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: mimetypes (required)
Fixed Value: text/cql
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible)
Max Binding: All Languages
Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ0..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
.... content:elmXmlContent S0..*AttachmentContents of the library, either embedded or referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: mimetypes (required)
Fixed Value: application/elm+xml
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible)
Max Binding: All Languages
Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ0..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
.... content:elmJsonContent S0..*AttachmentContents of the library, either embedded or referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: mimetypes (required)
Fixed Value: application/elm+json
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible)
Max Binding: All Languages
Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ0..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Library.languageextensibleCommon Languages
Max Binding: All Languages
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.content:cqlContent.contentTyperequiredFixed Value: text/cql
Library.content:cqlContent.languageextensibleCommon Languages
Max Binding: All Languages
Library.content:elmXmlContent.contentTyperequiredFixed Value: application/elm+xml
Library.content:elmXmlContent.languageextensibleCommon Languages
Max Binding: All Languages
Library.content:elmJsonContent.contentTyperequiredFixed Value: application/elm+json
Library.content:elmJsonContent.languageextensibleCommon Languages
Max Binding: All Languages

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2LibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1LibraryIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4LibraryIf 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-3LibraryIf 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-1Library.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Library.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Library.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()