Using CQL with FHIR, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cql-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: CQL Library

The CQL Library profile defines conformance expectations for the use of a FHIR Library resource as a wrapper for a Clinical Quality Language (CQL) library

Usage:

• Examples for this Resource Profile: CQLExample, FHIRCommon, FHIRHelpers and FHIRHelpersTests

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 Library

Name	Flags	Card.	Type	Description & Constraints
Library	C	0..*	Library	Represents a library of quality improvement components clb-1: CQL libraries must one (and only one) content element that starts with 'text/cql' clb-3: CQL library names SHALL be 64 characters or less clb-4: CQL library names SHOULD be 30 characters or less
Slices for extension				Content/Rules for all slices
cqlOptions	S	0..1	(Complex)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
value[x]		1..1	Reference(CQL Options)	Value of extension
name	C	1..1	string	Name for this library (computer friendly)
subject[x]	S	0..1	CodeableConcept, Reference(Group)	Type of individual the library content is focused on
content	SC	1..*	Attachment	Contents of the library, either embedded or referenced clb-2: CQL libraries must have a content element with data or a url (or both)
contentType	SC	1..1	code	Mime type of the content, with charset etc.
data	SC	0..1	base64Binary	Data inline, base64ed
url	SC	0..1	url	Uri where the data can be found
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
clb-1	error	Library	CQL libraries must one (and only one) content element that starts with 'text/cql' : content.where(contentType.startsWith('text/cql')).count() = 1
clb-2	error	Library.content	CQL libraries must have a content element with data or a url (or both) : data.exists() or url.exists()
clb-3	error	Library	CQL library names SHALL be 64 characters or less : name.length() <= 64
clb-4	warning	Library	CQL library names SHOULD be 30 characters or less : name.length() <= 30

Name	Flags	Card.	Type	Description & Constraints
Library	C	0..*	Library	Represents a library of quality improvement components dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation clb-1: CQL libraries must one (and only one) content element that starts with 'text/cql' clb-3: CQL library names SHALL be 64 characters or less clb-4: CQL library names SHOULD be 30 characters or less
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
cqlOptions	S	0..1	(Complex)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions"
value[x]		1..1	Reference(CQL Options)	Value of extension ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	ΣC	1..1	string	Name for this library (computer friendly) ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. ele-1: All FHIR elements must have a @value or children
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.). ele-1: All FHIR elements must have a @value or children
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
content	SΣC	1..*	Attachment	Contents of the library, either embedded or referenced ele-1: All FHIR elements must have a @value or children clb-2: CQL libraries must have a content element with data or a url (or both)
contentType	SΣC	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. ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png
data	SC	0..1	base64Binary	Data inline, base64ed ele-1: All FHIR elements must have a @value or children
url	SΣC	0..1	url	Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Library.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
Library.type	extensible	LibraryType http://hl7.org/fhir/ValueSet/library-type from the FHIR Standard
Library.subject[x]	extensible	SubjectType http://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard
Library.content.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
clb-1	error	Library	CQL libraries must one (and only one) content element that starts with 'text/cql' : content.where(contentType.startsWith('text/cql')).count() = 1
clb-2	error	Library.content	CQL libraries must have a content element with data or a url (or both) : data.exists() or url.exists()
clb-3	error	Library	CQL library names SHALL be 64 characters or less : name.length() <= 64
clb-4	warning	Library	CQL library names SHOULD be 30 characters or less : name.length() <= 30
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	0..*	Library	Represents a library of quality improvement components lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation clb-1: CQL libraries must one (and only one) content element that starts with 'text/cql' clb-3: CQL library names SHALL be 64 characters or less clb-4: CQL library names SHOULD be 30 characters or less
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
cqlOptions	S	0..1	(Complex)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions"
value[x]		1..1	Reference(CQL Options)	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	0..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
identifier	Σ	0..*	Identifier	Additional identifier for the library
version	Σ	0..1	string	Business version of the library
name	ΣC	1..1	string	Name for this library (computer friendly)
title	Σ	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	Σ	0..1	boolean	For testing purposes, not real usage
type	Σ	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	Σ	0..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	Σ	0..1	markdown	Natural language description of the library
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	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		0..*	RelatedArtifact	Additional documentation, citations, etc.
parameter		0..*	ParameterDefinition	Parameters defined by the library
dataRequirement		0..*	DataRequirement	What data is referenced by this library
content	SΣC	1..*	Attachment	Contents of the library, either embedded or referenced clb-2: CQL libraries must have a content element with data or a url (or both)
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ΣC	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. Example General: text/plain; charset=UTF-8, image/png
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	SC	0..1	base64Binary	Data inline, base64ed
url	SΣC	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	URI
Library.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Library.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
Library.type	extensible	LibraryType http://hl7.org/fhir/ValueSet/library-type from the FHIR Standard
Library.subject[x]	extensible	SubjectType http://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard
Library.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
Library.topic	example	DefinitionTopic http://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard
Library.content.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
clb-1	error	Library	CQL libraries must one (and only one) content element that starts with 'text/cql' : content.where(contentType.startsWith('text/cql')).count() = 1
clb-2	error	Library.content	CQL libraries must have a content element with data or a url (or both) : data.exists() or url.exists()
clb-3	error	Library	CQL library names SHALL be 64 characters or less : name.length() <= 64
clb-4	warning	Library	CQL library names SHOULD be 30 characters or less : name.length() <= 30
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}')

This structure is derived from Library

Summary

Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 6 elements

Structures

This structure refers to these other structures:

• CQL Options (http://hl7.org/fhir/uv/cql/StructureDefinition/cql-options)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions

Maturity: 3

Differential View

This structure is derived from Library

Name	Flags	Card.	Type	Description & Constraints
Library	C	0..*	Library	Represents a library of quality improvement components clb-1: CQL libraries must one (and only one) content element that starts with 'text/cql' clb-3: CQL library names SHALL be 64 characters or less clb-4: CQL library names SHOULD be 30 characters or less
Slices for extension				Content/Rules for all slices
cqlOptions	S	0..1	(Complex)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
value[x]		1..1	Reference(CQL Options)	Value of extension
name	C	1..1	string	Name for this library (computer friendly)
subject[x]	S	0..1	CodeableConcept, Reference(Group)	Type of individual the library content is focused on
content	SC	1..*	Attachment	Contents of the library, either embedded or referenced clb-2: CQL libraries must have a content element with data or a url (or both)
contentType	SC	1..1	code	Mime type of the content, with charset etc.
data	SC	0..1	base64Binary	Data inline, base64ed
url	SC	0..1	url	Uri where the data can be found
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
clb-1	error	Library	CQL libraries must one (and only one) content element that starts with 'text/cql' : content.where(contentType.startsWith('text/cql')).count() = 1
clb-2	error	Library.content	CQL libraries must have a content element with data or a url (or both) : data.exists() or url.exists()
clb-3	error	Library	CQL library names SHALL be 64 characters or less : name.length() <= 64
clb-4	warning	Library	CQL library names SHOULD be 30 characters or less : name.length() <= 30

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Library	C	0..*	Library	Represents a library of quality improvement components dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation clb-1: CQL libraries must one (and only one) content element that starts with 'text/cql' clb-3: CQL library names SHALL be 64 characters or less clb-4: CQL library names SHOULD be 30 characters or less
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
cqlOptions	S	0..1	(Complex)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions"
value[x]		1..1	Reference(CQL Options)	Value of extension ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	ΣC	1..1	string	Name for this library (computer friendly) ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. ele-1: All FHIR elements must have a @value or children
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.). ele-1: All FHIR elements must have a @value or children
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
content	SΣC	1..*	Attachment	Contents of the library, either embedded or referenced ele-1: All FHIR elements must have a @value or children clb-2: CQL libraries must have a content element with data or a url (or both)
contentType	SΣC	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. ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png
data	SC	0..1	base64Binary	Data inline, base64ed ele-1: All FHIR elements must have a @value or children
url	SΣC	0..1	url	Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Library.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
Library.type	extensible	LibraryType http://hl7.org/fhir/ValueSet/library-type from the FHIR Standard
Library.subject[x]	extensible	SubjectType http://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard
Library.content.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
clb-1	error	Library	CQL libraries must one (and only one) content element that starts with 'text/cql' : content.where(contentType.startsWith('text/cql')).count() = 1
clb-2	error	Library.content	CQL libraries must have a content element with data or a url (or both) : data.exists() or url.exists()
clb-3	error	Library	CQL library names SHALL be 64 characters or less : name.length() <= 64
clb-4	warning	Library	CQL library names SHOULD be 30 characters or less : name.length() <= 30
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	0..*	Library	Represents a library of quality improvement components lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation clb-1: CQL libraries must one (and only one) content element that starts with 'text/cql' clb-3: CQL library names SHALL be 64 characters or less clb-4: CQL library names SHOULD be 30 characters or less
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
cqlOptions	S	0..1	(Complex)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions"
value[x]		1..1	Reference(CQL Options)	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	0..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
identifier	Σ	0..*	Identifier	Additional identifier for the library
version	Σ	0..1	string	Business version of the library
name	ΣC	1..1	string	Name for this library (computer friendly)
title	Σ	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	Σ	0..1	boolean	For testing purposes, not real usage
type	Σ	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	Σ	0..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	Σ	0..1	markdown	Natural language description of the library
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	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		0..*	RelatedArtifact	Additional documentation, citations, etc.
parameter		0..*	ParameterDefinition	Parameters defined by the library
dataRequirement		0..*	DataRequirement	What data is referenced by this library
content	SΣC	1..*	Attachment	Contents of the library, either embedded or referenced clb-2: CQL libraries must have a content element with data or a url (or both)
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ΣC	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. Example General: text/plain; charset=UTF-8, image/png
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	SC	0..1	base64Binary	Data inline, base64ed
url	SΣC	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	URI
Library.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Library.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
Library.type	extensible	LibraryType http://hl7.org/fhir/ValueSet/library-type from the FHIR Standard
Library.subject[x]	extensible	SubjectType http://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard
Library.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
Library.topic	example	DefinitionTopic http://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard
Library.content.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
clb-1	error	Library	CQL libraries must one (and only one) content element that starts with 'text/cql' : content.where(contentType.startsWith('text/cql')).count() = 1
clb-2	error	Library.content	CQL libraries must have a content element with data or a url (or both) : data.exists() or url.exists()
clb-3	error	Library	CQL library names SHALL be 64 characters or less : name.length() <= 64
clb-4	warning	Library	CQL library names SHOULD be 30 characters or less : name.length() <= 30
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}')

This structure is derived from Library

Summary

Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 6 elements

Structures

This structure refers to these other structures:

• CQL Options (http://hl7.org/fhir/uv/cql/StructureDefinition/cql-options)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions

Maturity: 3

Other representations of profile: CSV, Excel, Schematron