Quality Measure STU2 for FHIR R4 Implementation Guide

This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v2.0.0: STU 2) 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

D.4.1 StructureDefinition: quality-program-cqfm

Examples:

Quality Program Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/quality-program-cqfm

Defines a quality program

This profile builds on Shareable Library.

This profile was published on Thu Jul 23 20:24:49 UTC 2020 as a active by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 12 elements
Must-Support: 11 elements
Fixed Value: 1 element

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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1Shareable LibraryRepresents a library of quality improvement components
... text S1..1NarrativeText summary of the resource, for human interpretation
... 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
... useContext S0..*(Slice Definition)The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:qualityProgram S1..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: QualityPrograms (extensible)
... effectivePeriod S0..1PeriodWhen the library is expected to be used
... relatedArtifact S0..*(Slice Definition)Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:measure 1..*RelatedArtifactAdditional documentation, citations, etc.
..... type 1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: composed-of
..... display 1..1stringBrief description of the related artifact
..... resource 1..1canonical(Measure)What resource is being referenced

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1Shareable LibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text SI1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣI1..*IdentifierAdditional identifier for the library
... version ΣI1..1stringBusiness version of the library
... name ΣI1..1stringName for this library (computer friendly)
... title SΣI1..1stringName for this library (human friendly)
... subtitle I0..1stringSubordinate title of the library
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI1..1booleanFor testing purposes, not real usage
... type SΣI1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible)
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] I0..1Type of individual the library content is focused on
Binding: SubjectType (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣI1..1dateTimeDate last changed
... publisher ΣI1..1stringName of the publisher (organization or individual)
... contact SΣI0..*ContactDetailContact details for the publisher
... description ΣI1..1markdownNatural language description of the library
... useContext SΣI0..*(Slice Definition)The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:qualityProgram SΣI1..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code SΣI1..1CodingType of context being specified
Binding: UsageContextType (extensible)
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ΣI1..1CodeableConceptValue that defines the context
Binding: QualityPrograms (extensible)
... jurisdiction SΣI0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose I0..1markdownWhy this library is defined
... usage I0..1stringDescribes the clinical usage of the library
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the library was approved by publisher
... lastReviewDate I0..1dateWhen the library was last reviewed
... effectivePeriod SΣI0..1PeriodWhen the library is expected to be used
... topic I0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact SI0..*(Slice Definition)Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:measure I1..*RelatedArtifactAdditional documentation, citations, etc.
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type ΣI1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
Fixed Value: composed-of
..... label ΣI0..1stringShort label
..... display ΣI1..1stringBrief description of the related artifact
..... citation ΣI0..1markdownBibliographic citation for the artifact
..... url ΣI0..1urlWhere the artifact can be accessed
..... document ΣI0..1AttachmentWhat document is being referenced
..... resource ΣI1..1canonical(Measure)What resource is being referenced
... parameter I0..*ParameterDefinitionParameters defined by the library
... dataRequirement I0..*DataRequirementWhat data is referenced by this library
... content ΣI0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Summary

Mandatory: 12 elements
Must-Support: 11 elements
Fixed Value: 1 element

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1Shareable LibraryRepresents a library of quality improvement components
... text S1..1NarrativeText summary of the resource, for human interpretation
... 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
... useContext S0..*(Slice Definition)The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:qualityProgram S1..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: QualityPrograms (extensible)
... effectivePeriod S0..1PeriodWhen the library is expected to be used
... relatedArtifact S0..*(Slice Definition)Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:measure 1..*RelatedArtifactAdditional documentation, citations, etc.
..... type 1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: composed-of
..... display 1..1stringBrief description of the related artifact
..... resource 1..1canonical(Measure)What resource is being referenced

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1Shareable LibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text SI1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣI1..*IdentifierAdditional identifier for the library
... version ΣI1..1stringBusiness version of the library
... name ΣI1..1stringName for this library (computer friendly)
... title SΣI1..1stringName for this library (human friendly)
... subtitle I0..1stringSubordinate title of the library
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI1..1booleanFor testing purposes, not real usage
... type SΣI1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible)
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] I0..1Type of individual the library content is focused on
Binding: SubjectType (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣI1..1dateTimeDate last changed
... publisher ΣI1..1stringName of the publisher (organization or individual)
... contact SΣI0..*ContactDetailContact details for the publisher
... description ΣI1..1markdownNatural language description of the library
... useContext SΣI0..*(Slice Definition)The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:qualityProgram SΣI1..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code SΣI1..1CodingType of context being specified
Binding: UsageContextType (extensible)
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ΣI1..1CodeableConceptValue that defines the context
Binding: QualityPrograms (extensible)
... jurisdiction SΣI0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose I0..1markdownWhy this library is defined
... usage I0..1stringDescribes the clinical usage of the library
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the library was approved by publisher
... lastReviewDate I0..1dateWhen the library was last reviewed
... effectivePeriod SΣI0..1PeriodWhen the library is expected to be used
... topic I0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact SI0..*(Slice Definition)Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:measure I1..*RelatedArtifactAdditional documentation, citations, etc.
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type ΣI1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
Fixed Value: composed-of
..... label ΣI0..1stringShort label
..... display ΣI1..1stringBrief description of the related artifact
..... citation ΣI0..1markdownBibliographic citation for the artifact
..... url ΣI0..1urlWhere the artifact can be accessed
..... document ΣI0..1AttachmentWhat document is being referenced
..... resource ΣI1..1canonical(Measure)What resource is being referenced
... parameter I0..*ParameterDefinitionParameters defined by the library
... dataRequirement I0..*DataRequirementWhat data is referenced by this library
... content ΣI0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Library.languagepreferredCommonLanguages
Max Binding: AllLanguages
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: asset-collection
Library.subject[x]extensibleSubjectType
Library.useContext:qualityProgram.codeextensiblePattern: program
Library.useContext:qualityProgram.value[x]extensibleQualityPrograms
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact:measure.typerequiredFixed Value: composed-of

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2LibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-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.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.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.useContext:qualityProgramAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.useContext:qualityProgram.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.useContext:qualityProgram.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.useContext:qualityProgram.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.useContext:qualityProgram.value[x]All 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.relatedArtifact:measureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:measure.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.relatedArtifact:measure.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.relatedArtifact:measure.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:measure.labelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:measure.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:measure.citationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:measure.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:measure.documentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:measure.resourceAll 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())
ele-1Library.contentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())