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 Publishable Library

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

The CQFM Publishable Library profile defines the must support elements in a library used to support eCQM logic

Usage:

Formal Views of Profile Content

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

This structure is derived from CQFMLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CQFMLibraryRepresents a library of quality improvement components
... text S1..1NarrativeText summary of the resource, for human interpretation
... title S1..1stringName for this library (human friendly)
... date S1..1dateTimeDate last changed
.... 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 (extensible): The quality programs

... purpose S0..1markdownWhy this library is defined
... usage S0..1stringDescribes the clinical usage of the library
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed
... effectivePeriod S0..1PeriodWhen the library is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAny referenced CQL libraries or additional documentation, citations, etc.
.... publicationStatus S0..1codePublication status of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact

.... publicationDate S0..1datePublication date of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationDate
.... display S0..1stringBrief description of the related artifact
.... url S0..1urlWhere the artifact can be accessed
.... resource S0..1canonical(Resource)What resource is being referenced

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Library.useContext:qualityProgram.value[x]extensibleQualityPrograms (a valid code from Quality Programs Codes)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CQFMLibraryRepresents a library of quality improvement components
... meta Σ1..1MetaMetadata about the resource
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text S1..1NarrativeText summary of the resource, for human interpretation
... comment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ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.

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


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAny referenced CQL libraries or additional documentation, citations, etc.
.... publicationStatus S0..1codePublication status of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact


.... publicationDate S0..1datePublication date of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationDate
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... display SΣ0..1stringBrief description of the related artifact
.... url SΣ0..1urlWhere the artifact can be accessed
.... resource SΣ0..1canonical(Resource)What resource is being referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.useContext:qualityProgram.codeextensiblePattern: program
Library.useContext:qualityProgram.value[x]extensibleQualityPrograms (a valid code from Quality Programs Codes)
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact.typerequiredRelatedArtifactType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLibraryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lib-0warningLibraryName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CQFMLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


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

Additional BindingsPurpose
AllLanguagesMax Binding
... text 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
... comment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ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.

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


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAny referenced CQL libraries or additional documentation, citations, etc.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... publicationStatus S0..1codePublication status of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact


.... publicationDate S0..1datePublication date of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationDate
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... label Σ0..1stringShort label
.... display SΣ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url SΣ0..1urlWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What resource is being referenced
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.meta.securityextensibleAll Security Labels
Library.meta.tagexampleCommonTags
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.useContext:qualityProgram.codeextensiblePattern: program
Library.useContext:qualityProgram.value[x]extensibleQualityPrograms (a valid code from Quality Programs Codes)
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact.typerequiredRelatedArtifactType

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 CQFMLibrary

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 24 elements

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

Differential View

This structure is derived from CQFMLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CQFMLibraryRepresents a library of quality improvement components
... text S1..1NarrativeText summary of the resource, for human interpretation
... title S1..1stringName for this library (human friendly)
... date S1..1dateTimeDate last changed
.... 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 (extensible): The quality programs

... purpose S0..1markdownWhy this library is defined
... usage S0..1stringDescribes the clinical usage of the library
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed
... effectivePeriod S0..1PeriodWhen the library is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAny referenced CQL libraries or additional documentation, citations, etc.
.... publicationStatus S0..1codePublication status of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact

.... publicationDate S0..1datePublication date of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationDate
.... display S0..1stringBrief description of the related artifact
.... url S0..1urlWhere the artifact can be accessed
.... resource S0..1canonical(Resource)What resource is being referenced

doco Documentation for this format

Terminology Bindings (Differential)

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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CQFMLibraryRepresents a library of quality improvement components
... meta Σ1..1MetaMetadata about the resource
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text S1..1NarrativeText summary of the resource, for human interpretation
... comment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ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.

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


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAny referenced CQL libraries or additional documentation, citations, etc.
.... publicationStatus S0..1codePublication status of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact


.... publicationDate S0..1datePublication date of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationDate
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... display SΣ0..1stringBrief description of the related artifact
.... url SΣ0..1urlWhere the artifact can be accessed
.... resource SΣ0..1canonical(Resource)What resource is being referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.useContext:qualityProgram.codeextensiblePattern: program
Library.useContext:qualityProgram.value[x]extensibleQualityPrograms (a valid code from Quality Programs Codes)
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact.typerequiredRelatedArtifactType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLibraryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lib-0warningLibraryName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Snapshot View

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


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


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

Additional BindingsPurpose
AllLanguagesMax Binding
... text 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
... comment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ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.

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


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAny referenced CQL libraries or additional documentation, citations, etc.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... publicationStatus S0..1codePublication status of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact


.... publicationDate S0..1datePublication date of referenced artifact
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-publicationDate
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... label Σ0..1stringShort label
.... display SΣ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url SΣ0..1urlWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What resource is being referenced
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.meta.securityextensibleAll Security Labels
Library.meta.tagexampleCommonTags
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.useContext:qualityProgram.codeextensiblePattern: program
Library.useContext:qualityProgram.value[x]extensibleQualityPrograms (a valid code from Quality Programs Codes)
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact.typerequiredRelatedArtifactType

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 CQFMLibrary

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 24 elements

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

 

Other representations of profile: CSV, Excel, Schematron