This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v5.0.0-ballot: STU5 (v5.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.0.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: CQFM Computable Library

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

Usage:

• Refer to this Resource Profile: CQFM Computable Measure
• Examples for this Resource Profile: EXMComputableLibrary, HBPComponent, PVSComponent and TSCComponent

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from CQFMLibrary

Name	Flags	Card.	Type	Description & Constraints
Library		1..1	CQFMLibrary	Represents a library of quality improvement components
directReferenceCode	S	0..*	Coding	A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
cqfm-cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
subject[x]	S	0..1	CodeableConcept, Reference(Group)	Type of individual the library content is focused on
relatedArtifact	S	0..*	RelatedArtifact	Dependencies used by the artifact
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
fhirQueryPattern		0..*	string	What FHIR query? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
Slices for content		0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	S	1..1	Attachment	Contents of the library, either embedded or referenced
contentType	S	1..1	code	Mime type of the content, with charset etc. Fixed Value: text/cql
data	S	1..1	base64Binary	Data inline, base64ed
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	CQFMLibrary	Represents a library of quality improvement components
meta	Σ	1..1	Meta	Metadata about the resource
profile	SΣ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
comment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
directReferenceCode	S	0..*	Coding	A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
cqfm-cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the library
version	Σ	1..1	string	Business version of the library
name	ΣC	1..1	string	Name for this library (computer friendly)
title	SΣ	0..1	string	Name for this library (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	1..1	boolean	For testing purposes, not real usage
type	SΣ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains.
subject[x]	S	0..1		Type 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.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
date	SΣ	0..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description	Σ	1..1	markdown	Natural language description of the library
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
relatedArtifact	S	0..*	RelatedArtifact	Dependencies used by the artifact
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
fhirQueryPattern		0..*	string	What FHIR query? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
type	Σ	1..1	code	The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Slices for content	Σ	0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	SΣ	1..1	Attachment	Contents of the library, either embedded or referenced
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: text/cql
data	S	1..1	base64Binary	Data inline, base64ed
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Library.status	required	PublicationStatus
Library.type	extensible	LibraryType
Library.subject[x]	extensible	SubjectType
Library.jurisdiction	extensible	Jurisdiction ValueSet
Library.dataRequirement.type	required	FHIRAllTypes
Library.content:cqlContent.contentType	required	Fixed Value: text/cql

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Library	If 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-4	error	Library	If 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-5	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Library	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
lib-0	warning	Library	Name 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}')

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	CQFMLibrary	Represents a library of quality improvement components
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags 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..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
comment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
directReferenceCode	S	0..*	Coding	A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
cqfm-cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the library
version	Σ	1..1	string	Business version of the library
name	ΣC	1..1	string	Name for this library (computer friendly)
title	SΣ	0..1	string	Name for this library (human friendly)
subtitle		0..1	string	Subordinate title of the library
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	1..1	boolean	For testing purposes, not real usage
type	SΣ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains.
subject[x]	S	0..1		Type 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.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
date	SΣ	0..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description	Σ	1..1	markdown	Natural language description of the library
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this library is defined
usage		0..1	string	Describes the clinical usage of the library
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	date	When the library was approved by publisher
lastReviewDate		0..1	date	When the library was last reviewed
effectivePeriod	Σ	0..1	Period	When the library is expected to be used
topic		0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author		0..*	ContactDetail	Who authored the content
editor		0..*	ContactDetail	Who edited the content
reviewer		0..*	ContactDetail	Who reviewed the content
endorser		0..*	ContactDetail	Who endorsed the content
relatedArtifact	S	0..*	RelatedArtifact	Dependencies used by the artifact
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
fhirQueryPattern		0..*	string	What FHIR query? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
type	Σ	1..1	code	The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile	Σ	0..*	canonical(StructureDefinition)	The profile of the required data
subject[x]	Σ	0..1		E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
mustSupport	Σ	0..*	string	Indicates specific structure elements that are referenced by the knowledge module
codeFilter	ΣC	0..*	Element	What codes are expected
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	0..1	string	A code-valued attribute to filter on
searchParam	Σ	0..1	string	A coded (token) parameter to search on
valueSet	Σ	0..1	canonical(ValueSet)	Valueset for the filter
code	Σ	0..*	Coding	What code is expected
dateFilter	ΣC	0..*	Element	What dates/date ranges are expected
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	0..1	string	A date-valued attribute to filter on
searchParam	Σ	0..1	string	A date valued parameter to search on
value[x]	Σ	0..1		The value of the filter, as a Period, DateTime, or Duration value
valueDateTime			dateTime
valuePeriod			Period
valueDuration			Duration
limit	Σ	0..1	positiveInt	Number of results
sort	Σ	0..*	Element	Order of the results
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	1..1	string	The name of the attribute to perform the sort
direction	Σ	1..1	code	ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
Slices for content	Σ	0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	SΣ	1..1	Attachment	Contents of the library, either embedded or referenced
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: text/cql
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data	S	1..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Library.meta.security	extensible	All Security Labels
Library.meta.tag	example	CommonTags
Library.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Library.status	required	PublicationStatus
Library.type	extensible	LibraryType
Library.subject[x]	extensible	SubjectType
Library.jurisdiction	extensible	Jurisdiction ValueSet
Library.topic	example	DefinitionTopic
Library.dataRequirement.type	required	FHIRAllTypes
Library.dataRequirement.subject[x]	extensible	SubjectType
Library.dataRequirement.sort.direction	required	SortDirection
Library.content:cqlContent.contentType	required	Fixed Value: text/cql
Library.content:cqlContent.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Library	If 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-4	error	Library	If 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-5	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Library	A resource should have narrative for robust management : text.`div`.exists()
drq-1	error	Library.dataRequirement.codeFilter	Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists()
drq-2	error	Library.dataRequirement.dateFilter	Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
lib-0	warning	Library	Name 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
Must-Support: 9 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
• http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
• http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern

Slices

This structure defines the following Slices:

• The element Library.content is sliced based on the value of value:contentType

Differential View

This structure is derived from CQFMLibrary

Name	Flags	Card.	Type	Description & Constraints
Library		1..1	CQFMLibrary	Represents a library of quality improvement components
directReferenceCode	S	0..*	Coding	A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
cqfm-cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
subject[x]	S	0..1	CodeableConcept, Reference(Group)	Type of individual the library content is focused on
relatedArtifact	S	0..*	RelatedArtifact	Dependencies used by the artifact
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
fhirQueryPattern		0..*	string	What FHIR query? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
Slices for content		0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	S	1..1	Attachment	Contents of the library, either embedded or referenced
contentType	S	1..1	code	Mime type of the content, with charset etc. Fixed Value: text/cql
data	S	1..1	base64Binary	Data inline, base64ed
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	CQFMLibrary	Represents a library of quality improvement components
meta	Σ	1..1	Meta	Metadata about the resource
profile	SΣ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
comment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
directReferenceCode	S	0..*	Coding	A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
cqfm-cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the library
version	Σ	1..1	string	Business version of the library
name	ΣC	1..1	string	Name for this library (computer friendly)
title	SΣ	0..1	string	Name for this library (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	1..1	boolean	For testing purposes, not real usage
type	SΣ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains.
subject[x]	S	0..1		Type 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.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
date	SΣ	0..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description	Σ	1..1	markdown	Natural language description of the library
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
relatedArtifact	S	0..*	RelatedArtifact	Dependencies used by the artifact
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
fhirQueryPattern		0..*	string	What FHIR query? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
type	Σ	1..1	code	The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Slices for content	Σ	0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	SΣ	1..1	Attachment	Contents of the library, either embedded or referenced
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: text/cql
data	S	1..1	base64Binary	Data inline, base64ed
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Library.status	required	PublicationStatus
Library.type	extensible	LibraryType
Library.subject[x]	extensible	SubjectType
Library.jurisdiction	extensible	Jurisdiction ValueSet
Library.dataRequirement.type	required	FHIRAllTypes
Library.content:cqlContent.contentType	required	Fixed Value: text/cql

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Library	If 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-4	error	Library	If 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-5	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Library	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
lib-0	warning	Library	Name 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

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	CQFMLibrary	Represents a library of quality improvement components
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags 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..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
comment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
directReferenceCode	S	0..*	Coding	A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
cqfm-cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the library
version	Σ	1..1	string	Business version of the library
name	ΣC	1..1	string	Name for this library (computer friendly)
title	SΣ	0..1	string	Name for this library (human friendly)
subtitle		0..1	string	Subordinate title of the library
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	1..1	boolean	For testing purposes, not real usage
type	SΣ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains.
subject[x]	S	0..1		Type 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.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
date	SΣ	0..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description	Σ	1..1	markdown	Natural language description of the library
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this library is defined
usage		0..1	string	Describes the clinical usage of the library
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	date	When the library was approved by publisher
lastReviewDate		0..1	date	When the library was last reviewed
effectivePeriod	Σ	0..1	Period	When the library is expected to be used
topic		0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author		0..*	ContactDetail	Who authored the content
editor		0..*	ContactDetail	Who edited the content
reviewer		0..*	ContactDetail	Who reviewed the content
endorser		0..*	ContactDetail	Who endorsed the content
relatedArtifact	S	0..*	RelatedArtifact	Dependencies used by the artifact
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
fhirQueryPattern		0..*	string	What FHIR query? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern
type	Σ	1..1	code	The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile	Σ	0..*	canonical(StructureDefinition)	The profile of the required data
subject[x]	Σ	0..1		E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
mustSupport	Σ	0..*	string	Indicates specific structure elements that are referenced by the knowledge module
codeFilter	ΣC	0..*	Element	What codes are expected
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	0..1	string	A code-valued attribute to filter on
searchParam	Σ	0..1	string	A coded (token) parameter to search on
valueSet	Σ	0..1	canonical(ValueSet)	Valueset for the filter
code	Σ	0..*	Coding	What code is expected
dateFilter	ΣC	0..*	Element	What dates/date ranges are expected
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	0..1	string	A date-valued attribute to filter on
searchParam	Σ	0..1	string	A date valued parameter to search on
value[x]	Σ	0..1		The value of the filter, as a Period, DateTime, or Duration value
valueDateTime			dateTime
valuePeriod			Period
valueDuration			Duration
limit	Σ	0..1	positiveInt	Number of results
sort	Σ	0..*	Element	Order of the results
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	1..1	string	The name of the attribute to perform the sort
direction	Σ	1..1	code	ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
Slices for content	Σ	0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	SΣ	1..1	Attachment	Contents of the library, either embedded or referenced
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: text/cql
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data	S	1..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Library.meta.security	extensible	All Security Labels
Library.meta.tag	example	CommonTags
Library.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Library.status	required	PublicationStatus
Library.type	extensible	LibraryType
Library.subject[x]	extensible	SubjectType
Library.jurisdiction	extensible	Jurisdiction ValueSet
Library.topic	example	DefinitionTopic
Library.dataRequirement.type	required	FHIRAllTypes
Library.dataRequirement.subject[x]	extensible	SubjectType
Library.dataRequirement.sort.direction	required	SortDirection
Library.content:cqlContent.contentType	required	Fixed Value: text/cql
Library.content:cqlContent.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Library	If 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-4	error	Library	If 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-5	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Library	A resource should have narrative for robust management : text.`div`.exists()
drq-1	error	Library.dataRequirement.codeFilter	Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists()
drq-2	error	Library.dataRequirement.dateFilter	Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
lib-0	warning	Library	Name 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
Must-Support: 9 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode
• http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-cqlOptions
• http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-fhirQueryPattern

Slices

This structure defines the following Slices:

• The element Library.content is sliced based on the value of value:contentType

Other representations of profile: CSV, Excel, Schematron