Quality Measure Implementation Guide (STU3)
3.0.0 - ballot United States of America flag

Quality Measure Implementation Guide (STU3), published by Clinical Quality Information WG. This is not an authorized publication; it is the continuous build for version 3.0.0). This version is based on the current content of https://github.com/HL7/cqf-measures/ and changes regularly. See the Directory of published versions

Resource Profile: CQFM Computable Library

Official URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/computable-library-cqfm Version: 3.0.0
Active as of 2021-11-27 Computable Name: CQFMComputableLibrary

The CQFM Computable Library profile defines the must support elements for a computable library used to support eCQM logic

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CQFMLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CQFMLibraryRepresents a library of quality improvement components
... directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... cqfm-cqlOptions S0..1Reference(Parameters)What options
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
... subject[x] S0..1CodeableConcept, Reference(Group)Type of individual the library content is focused on
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
.... fhirQueryPattern 0..*stringWhat FHIR query?
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
... Slices for content 0..*AttachmentContents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:cqlContent S1..1AttachmentContents of the library, either embedded or referenced
..... contentType S1..1codeMime type of the content, with charset etc.
Fixed Value: text/cql
..... data S1..1base64BinaryData inline, base64ed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CQFMLibraryRepresents a library of quality improvement components
... meta Σ1..1MetaMetadata about the resource
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... comment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... cqfm-cqlOptions S0..1Reference(Parameters)What options
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ0..1stringName for this library (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... subject[x] S0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the library
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... relatedArtifact S0..*RelatedArtifactDependencies used by the artifact
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
.... fhirQueryPattern 0..*stringWhat FHIR query?
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
.... type Σ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

... Slices for content Σ0..*AttachmentContents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:cqlContent SΣ1..1AttachmentContents of the library, either embedded or referenced
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: text/cql
..... data S1..1base64BinaryData inline, base64ed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.dataRequirement.typerequiredFHIRAllTypes
Library.content:cqlContent.contentTyperequiredFixed Value: text/cql

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf 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-4errorLibraryIf 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-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lib-0warningLibraryName 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}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CQFMLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... comment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... cqfm-cqlOptions S0..1Reference(Parameters)What options
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ0..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... subject[x] S0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the library
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactDependencies used by the artifact
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... fhirQueryPattern 0..*stringWhat FHIR query?
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
.... type Σ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

.... profile Σ0..*canonical(StructureDefinition)The profile of the required data
.... subject[x] Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... mustSupport Σ0..*stringIndicates specific structure elements that are referenced by the knowledge module
.... codeFilter ΣC0..*ElementWhat codes are expected
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ0..1stringA code-valued attribute to filter on
..... searchParam Σ0..1stringA coded (token) parameter to search on
..... valueSet Σ0..1canonical(ValueSet)Valueset for the filter
..... code Σ0..*CodingWhat code is expected
.... dateFilter ΣC0..*ElementWhat dates/date ranges are expected
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ0..1stringA date-valued attribute to filter on
..... searchParam Σ0..1stringA date valued parameter to search on
..... value[x] Σ0..1The value of the filter, as a Period, DateTime, or Duration value
...... valueDateTimedateTime
...... valuePeriodPeriod
...... valueDurationDuration
.... limit Σ0..1positiveIntNumber of results
.... sort Σ0..*ElementOrder of the results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ1..1stringThe name of the attribute to perform the sort
..... direction Σ1..1codeascending | descending
Binding: SortDirection (required): The possible sort directions, ascending or descending.

... Slices for content Σ0..*AttachmentContents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:cqlContent SΣ1..1AttachmentContents of the library, either embedded or referenced
..... id 0..1stringUnique id for inter-element referencing
..... 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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: text/cql
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... data S1..1base64BinaryData inline, base64ed
..... url Σ0..1urlUri 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

Terminology Bindings

PathConformanceValueSet / Code
Library.meta.securityextensibleAll Security Labels
Library.meta.tagexampleCommonTags
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.dataRequirement.typerequiredFHIRAllTypes
Library.dataRequirement.subject[x]extensibleSubjectType
Library.dataRequirement.sort.directionrequiredSortDirection
Library.content:cqlContent.contentTyperequiredFixed Value: text/cql
Library.content:cqlContent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
drq-1errorLibrary.dataRequirement.codeFilterEither a path or a searchParam must be provided, but not both
: path.exists() xor searchParam.exists()
drq-2errorLibrary.dataRequirement.dateFilterEither a path or a searchParam must be provided, but not both
: path.exists() xor searchParam.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CQFMLibrary

Summary

Mandatory: 3 elements
Must-Support: 9 elements
Fixed Value: 1 element

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

Differential View

This structure is derived from CQFMLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CQFMLibraryRepresents a library of quality improvement components
... directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... cqfm-cqlOptions S0..1Reference(Parameters)What options
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
... subject[x] S0..1CodeableConcept, Reference(Group)Type of individual the library content is focused on
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
.... fhirQueryPattern 0..*stringWhat FHIR query?
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
... Slices for content 0..*AttachmentContents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:cqlContent S1..1AttachmentContents of the library, either embedded or referenced
..... contentType S1..1codeMime type of the content, with charset etc.
Fixed Value: text/cql
..... data S1..1base64BinaryData inline, base64ed

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CQFMLibraryRepresents a library of quality improvement components
... meta Σ1..1MetaMetadata about the resource
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... comment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... cqfm-cqlOptions S0..1Reference(Parameters)What options
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ0..1stringName for this library (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... subject[x] S0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the library
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... relatedArtifact S0..*RelatedArtifactDependencies used by the artifact
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
.... fhirQueryPattern 0..*stringWhat FHIR query?
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
.... type Σ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

... Slices for content Σ0..*AttachmentContents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:cqlContent SΣ1..1AttachmentContents of the library, either embedded or referenced
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: text/cql
..... data S1..1base64BinaryData inline, base64ed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.dataRequirement.typerequiredFHIRAllTypes
Library.content:cqlContent.contentTyperequiredFixed Value: text/cql

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf 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-4errorLibraryIf 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-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lib-0warningLibraryName 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CQFMLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... comment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... cqfm-cqlOptions S0..1Reference(Parameters)What options
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ0..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... subject[x] S0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the library
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactDependencies used by the artifact
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... fhirQueryPattern 0..*stringWhat FHIR query?
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
.... type Σ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

.... profile Σ0..*canonical(StructureDefinition)The profile of the required data
.... subject[x] Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... mustSupport Σ0..*stringIndicates specific structure elements that are referenced by the knowledge module
.... codeFilter ΣC0..*ElementWhat codes are expected
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ0..1stringA code-valued attribute to filter on
..... searchParam Σ0..1stringA coded (token) parameter to search on
..... valueSet Σ0..1canonical(ValueSet)Valueset for the filter
..... code Σ0..*CodingWhat code is expected
.... dateFilter ΣC0..*ElementWhat dates/date ranges are expected
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ0..1stringA date-valued attribute to filter on
..... searchParam Σ0..1stringA date valued parameter to search on
..... value[x] Σ0..1The value of the filter, as a Period, DateTime, or Duration value
...... valueDateTimedateTime
...... valuePeriodPeriod
...... valueDurationDuration
.... limit Σ0..1positiveIntNumber of results
.... sort Σ0..*ElementOrder of the results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ1..1stringThe name of the attribute to perform the sort
..... direction Σ1..1codeascending | descending
Binding: SortDirection (required): The possible sort directions, ascending or descending.

... Slices for content Σ0..*AttachmentContents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:cqlContent SΣ1..1AttachmentContents of the library, either embedded or referenced
..... id 0..1stringUnique id for inter-element referencing
..... 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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: text/cql
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... data S1..1base64BinaryData inline, base64ed
..... url Σ0..1urlUri 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

Terminology Bindings

PathConformanceValueSet / Code
Library.meta.securityextensibleAll Security Labels
Library.meta.tagexampleCommonTags
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.dataRequirement.typerequiredFHIRAllTypes
Library.dataRequirement.subject[x]extensibleSubjectType
Library.dataRequirement.sort.directionrequiredSortDirection
Library.content:cqlContent.contentTyperequiredFixed Value: text/cql
Library.content:cqlContent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
drq-1errorLibrary.dataRequirement.codeFilterEither a path or a searchParam must be provided, but not both
: path.exists() xor searchParam.exists()
drq-2errorLibrary.dataRequirement.dateFilterEither a path or a searchParam must be provided, but not both
: path.exists() xor searchParam.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CQFMLibrary

Summary

Mandatory: 3 elements
Must-Support: 9 elements
Fixed Value: 1 element

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

 

Other representations of profile: CSV, Excel, Schematron