Quality Measure Implementation Guide (STU3 Ballot)
2.1.0 - ballot

This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v2.1.0: STU3 Ballot 1) 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

Resource Profile: CQFMModuleDefinitionLibrary

Defining URL:http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/module-definition-library-cqfm
Version:2.1.0
Name:CQFMModuleDefinitionLibrary
Status:Active as of 2021-04-13T15:56:35+00:00
Definition:

The CQFM Module Definition Library profile defines the must support elements for a library that communicates the effective data requirements and dependencies of an artifact (or set of artifacts). This is most commonly used as the result of a $data-requirements operation, but could also be persisted statically as a way to persist the calculation of effective data requirements for a specific artifact and input parameters

Publisher:Clinical Quality Information WG
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/module-definition-library-cqfm

Formal Views of Profile Content

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

This structure is derived from CQFMLibrary

Summary

Mandatory: 1 element
Must-Support: 7 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

This structure is derived from CQFMLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CQFMLibraryRepresents a library of quality improvement components
... cqfm-directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... cqfm-inputParameters S0..1Reference(Parameters)Input
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-inputParameters
... type S1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: module-definition
... relatedArtifact S0..*RelatedArtifactDependencies used by the artifact
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1CQFMLibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqfm-artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... cqfm-directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... cqfm-inputParameters S0..1Reference(Parameters)Input
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-inputParameters
... 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 ΣI1..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.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: module-definition
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1CQFMLibraryRepresents a library of quality improvement components
... meta Σ1..1MetaMetadata about the resource
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... cqfm-artifactComment 0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... cqfm-directReferenceCode 0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... identifier Σ0..*IdentifierAdditional identifier for the library
... title Σ0..1stringName for this library (human friendly)
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: module-definition
... subject[x] 0..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 Σ0..1dateTimeDate last changed
... contact Σ0..*ContactDetailContact details for the publisher
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... relatedArtifact 0..*RelatedArtifactDependencies used by the artifact
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library

doco Documentation for this format

This structure is derived from CQFMLibrary

Summary

Mandatory: 1 element
Must-Support: 7 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from CQFMLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CQFMLibraryRepresents a library of quality improvement components
... cqfm-directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... cqfm-inputParameters S0..1Reference(Parameters)Input
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-inputParameters
... type S1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: module-definition
... relatedArtifact S0..*RelatedArtifactDependencies used by the artifact
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1CQFMLibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqfm-artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... cqfm-directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... cqfm-inputParameters S0..1Reference(Parameters)Input
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-inputParameters
... 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 ΣI1..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.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: module-definition
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... 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

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Library.meta.securityextensibleAll Security Labels
Library.meta.tagexampleCommonTags
Library.languagepreferredCommonLanguages
Max Binding: AllLanguages
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: module-definition
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic

Constraints

IdPathDetailsRequirements
dom-2LibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3LibraryIf 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-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-5LibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6LibraryA resource should have narrative for robust management
: text.`div`.exists()
lib-0LibraryName 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-1Library.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.meta.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.meta.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.meta.versionIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.meta.lastUpdatedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.meta.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.meta.profileAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.meta.securityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.meta.tagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.extension:commentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.extension:commentMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.extension:directReferenceCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.extension:directReferenceCodeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.extension:inputParametersAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.extension:inputParametersMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.subtitleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.usageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.copyrightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.approvalDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.lastReviewDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.effectivePeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.editorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.reviewerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.endorserAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.dataRequirementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())