Quality Measure Implementation Guide (STU4)
4.0.0 - STU4 United States of America flag

This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v4.0.0: STU4 (v4.0.0)) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: CQFM Quality Program

Official URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/quality-program-cqfm Version: 4.0.0
Active as of 2021-11-27 Computable Name: CQFMQualityProgram

Defines and supports the definition of Quality Programs

Quality programs must be able to specify the set of measures they use, as well as provide versioning information for all the dependencies used in a particular release to enable stable expansion of value sets. Specifically, the versions of code systems used to construct value sets referenced by the measures must be identified so that terminology servers performing expansions can unambiguously select the version of each code system used to perform the expansion.

Usage:

Formal Views of Profile Content

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

This structure is derived from Shareable Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1Shareable LibraryRepresents a library of quality improvement components
... text S1..1NarrativeText summary of the resource, for human interpretation
... partOf S0..1canonical()What program this is part of
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf
... directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... expansionParameters S0..1Reference(Parameters)What expansion rules
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters
... identifier S1..*IdentifierAdditional identifier for the library
... title S1..1stringName for this library (human friendly)
... 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: asset-collection
... date S1..1dateTimeDate last changed
... Slices for useContext S0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:qualityProgram S0..1UsageContextThe context that the content is intended to support
..... code S1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
..... value[x] S1..1CodeableConceptValue that defines the context
Binding: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs

... effectivePeriod S0..1PeriodWhen the library is expected to be used
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:measure S0..*RelatedArtifactMeasure (and version)
..... programIdentifier S0..1IdentifierMeasure number within the program
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier
..... qualityDomain S0..*CodeableConceptWhat domain
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain
..... meaningfulMeasureArea S0..*CodeableConceptWhat measure area
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea
..... type S1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: composed-of
..... display S0..1stringBrief description of the related artifact
..... resource S1..1canonical(Measure | Library | ValueSet)What resource is being referenced
.... relatedArtifact:dependency S0..*RelatedArtifactLibrary, CodeSystem, or ValueSet (and version)
..... type S1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: depends-on
..... display S0..1stringBrief description of the related artifact
..... resource S1..1canonical(CodeSystem | Library | ValueSet)What resource is being referenced
... content 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Library.useContext:qualityProgram.value[x]exampleQualityPrograms (a valid code from Quality Programs Codes)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1Shareable LibraryRepresents a library of quality improvement components
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text S1..1NarrativeText summary of the resource, for human interpretation
... partOf S0..1canonical()What program this is part of
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf
... cqlOptions S0..1Reference(Parameters)What options
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
... expansionParameters S0..1Reference(Parameters)What expansion rules
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ1..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ1..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.


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: asset-collection
... date SΣ1..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
... Slices for useContext SΣ0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:qualityProgram SΣ0..1UsageContextThe context that the content is intended to support
..... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
..... value[x] SΣ1..1CodeableConceptValue that defines the context
Binding: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs

... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... effectivePeriod SΣ0..1PeriodWhen the library is expected to be used
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:measure S0..*RelatedArtifactMeasure (and version)
..... programIdentifier S0..1IdentifierMeasure number within the program
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier
..... qualityDomain S0..*CodeableConceptWhat domain
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain
..... meaningfulMeasureArea S0..*CodeableConceptWhat measure area
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: composed-of
..... display SΣ0..1stringBrief description of the related artifact
..... resource SΣ1..1canonical(Measure | Library | ValueSet)What resource is being referenced
.... relatedArtifact:dependency S0..*RelatedArtifactLibrary, CodeSystem, or ValueSet (and version)
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: depends-on
..... display SΣ0..1stringBrief description of the related artifact
..... resource SΣ1..1canonical(CodeSystem | Library | ValueSet)What resource is being referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: asset-collection
Library.useContext:qualityProgram.codeextensiblePattern: program
Library.useContext:qualityProgram.value[x]exampleQualityPrograms (a valid code from Quality Programs Codes)
Library.jurisdictionextensibleJurisdiction ValueSet
Library.relatedArtifact:measure.typerequiredFixed Value: composed-of
Library.relatedArtifact:dependency.typerequiredFixed Value: depends-on

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..1Shareable LibraryRepresents 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text S1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... partOf S0..1canonical()What program this is part of
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf
... directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... cqlOptions S0..1Reference(Parameters)What options
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
... expansionParameters S0..1Reference(Parameters)What expansion rules
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ1..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ1..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: asset-collection
..... 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] 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 SΣ1..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
... Slices for useContext SΣ0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:qualityProgram SΣ0..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... 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/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] SΣ1..1CodeableConceptValue that defines the context
Binding: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs

... 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 SΣ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
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:measure S0..*RelatedArtifactMeasure (and version)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... programIdentifier S0..1IdentifierMeasure number within the program
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier
..... qualityDomain S0..*CodeableConceptWhat domain
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain
..... meaningfulMeasureArea S0..*CodeableConceptWhat measure area
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: composed-of
..... label Σ0..1stringShort label
..... display SΣ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(Measure | Library | ValueSet)What resource is being referenced
.... relatedArtifact:dependency S0..*RelatedArtifactLibrary, CodeSystem, or ValueSet (and version)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: depends-on
..... label Σ0..1stringShort label
..... display SΣ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(CodeSystem | Library | ValueSet)What resource is being referenced
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: asset-collection
Library.subject[x]extensibleSubjectType
Library.useContext:qualityProgram.codeextensiblePattern: program
Library.useContext:qualityProgram.value[x]exampleQualityPrograms (a valid code from Quality Programs Codes)
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact:measure.typerequiredFixed Value: composed-of
Library.relatedArtifact:dependency.typerequiredFixed Value: depends-on

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}')

This structure is derived from Shareable Library

Summary

Mandatory: 5 elements (6 nested mandatory elements)
Must-Support: 26 elements
Fixed Value: 2 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Library.useContext is sliced based on the value of value:code
  • The element Library.relatedArtifact is sliced based on the value of value:type

Differential View

This structure is derived from Shareable Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1Shareable LibraryRepresents a library of quality improvement components
... text S1..1NarrativeText summary of the resource, for human interpretation
... partOf S0..1canonical()What program this is part of
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf
... directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... expansionParameters S0..1Reference(Parameters)What expansion rules
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters
... identifier S1..*IdentifierAdditional identifier for the library
... title S1..1stringName for this library (human friendly)
... 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: asset-collection
... date S1..1dateTimeDate last changed
... Slices for useContext S0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:qualityProgram S0..1UsageContextThe context that the content is intended to support
..... code S1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
..... value[x] S1..1CodeableConceptValue that defines the context
Binding: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs

... effectivePeriod S0..1PeriodWhen the library is expected to be used
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:measure S0..*RelatedArtifactMeasure (and version)
..... programIdentifier S0..1IdentifierMeasure number within the program
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier
..... qualityDomain S0..*CodeableConceptWhat domain
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain
..... meaningfulMeasureArea S0..*CodeableConceptWhat measure area
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea
..... type S1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: composed-of
..... display S0..1stringBrief description of the related artifact
..... resource S1..1canonical(Measure | Library | ValueSet)What resource is being referenced
.... relatedArtifact:dependency S0..*RelatedArtifactLibrary, CodeSystem, or ValueSet (and version)
..... type S1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: depends-on
..... display S0..1stringBrief description of the related artifact
..... resource S1..1canonical(CodeSystem | Library | ValueSet)What resource is being referenced
... content 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Library.useContext:qualityProgram.value[x]exampleQualityPrograms (a valid code from Quality Programs Codes)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1Shareable LibraryRepresents a library of quality improvement components
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text S1..1NarrativeText summary of the resource, for human interpretation
... partOf S0..1canonical()What program this is part of
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf
... cqlOptions S0..1Reference(Parameters)What options
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
... expansionParameters S0..1Reference(Parameters)What expansion rules
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ1..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ1..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.


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: asset-collection
... date SΣ1..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
... Slices for useContext SΣ0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:qualityProgram SΣ0..1UsageContextThe context that the content is intended to support
..... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
..... value[x] SΣ1..1CodeableConceptValue that defines the context
Binding: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs

... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... effectivePeriod SΣ0..1PeriodWhen the library is expected to be used
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:measure S0..*RelatedArtifactMeasure (and version)
..... programIdentifier S0..1IdentifierMeasure number within the program
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier
..... qualityDomain S0..*CodeableConceptWhat domain
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain
..... meaningfulMeasureArea S0..*CodeableConceptWhat measure area
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: composed-of
..... display SΣ0..1stringBrief description of the related artifact
..... resource SΣ1..1canonical(Measure | Library | ValueSet)What resource is being referenced
.... relatedArtifact:dependency S0..*RelatedArtifactLibrary, CodeSystem, or ValueSet (and version)
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: depends-on
..... display SΣ0..1stringBrief description of the related artifact
..... resource SΣ1..1canonical(CodeSystem | Library | ValueSet)What resource is being referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: asset-collection
Library.useContext:qualityProgram.codeextensiblePattern: program
Library.useContext:qualityProgram.value[x]exampleQualityPrograms (a valid code from Quality Programs Codes)
Library.jurisdictionextensibleJurisdiction ValueSet
Library.relatedArtifact:measure.typerequiredFixed Value: composed-of
Library.relatedArtifact:dependency.typerequiredFixed Value: depends-on

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..1Shareable LibraryRepresents 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text S1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... partOf S0..1canonical()What program this is part of
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf
... directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
... cqlOptions S0..1Reference(Parameters)What options
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
... expansionParameters S0..1Reference(Parameters)What expansion rules
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionParameters
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ1..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ1..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: asset-collection
..... 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] 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 SΣ1..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
... Slices for useContext SΣ0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:qualityProgram SΣ0..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... 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/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] SΣ1..1CodeableConceptValue that defines the context
Binding: Quality Programs (example): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs

... 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 SΣ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
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:measure S0..*RelatedArtifactMeasure (and version)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... programIdentifier S0..1IdentifierMeasure number within the program
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier
..... qualityDomain S0..*CodeableConceptWhat domain
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain
..... meaningfulMeasureArea S0..*CodeableConceptWhat measure area
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: composed-of
..... label Σ0..1stringShort label
..... display SΣ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(Measure | Library | ValueSet)What resource is being referenced
.... relatedArtifact:dependency S0..*RelatedArtifactLibrary, CodeSystem, or ValueSet (and version)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: depends-on
..... label Σ0..1stringShort label
..... display SΣ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(CodeSystem | Library | ValueSet)What resource is being referenced
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: asset-collection
Library.subject[x]extensibleSubjectType
Library.useContext:qualityProgram.codeextensiblePattern: program
Library.useContext:qualityProgram.value[x]exampleQualityPrograms (a valid code from Quality Programs Codes)
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact:measure.typerequiredFixed Value: composed-of
Library.relatedArtifact:dependency.typerequiredFixed Value: depends-on

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}')

This structure is derived from Shareable Library

Summary

Mandatory: 5 elements (6 nested mandatory elements)
Must-Support: 26 elements
Fixed Value: 2 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Library.useContext is sliced based on the value of value:code
  • The element Library.relatedArtifact is sliced based on the value of value:type

 

Other representations of profile: CSV, Excel, Schematron