Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.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/sdc/ and changes regularly. See the Directory of published versions

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

Resource Profile: SDC Library

Defines how a Library is used as a logic computable library within the ONC's Structured Data Capture standard.

Usage:

• Examples for this Resource Profile: CHF

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	CQL 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
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
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
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 Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: logic-library
display		1..1	string	Representation defined by the system Fixed Value: Logic Library
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
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)
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. ele-1: All FHIR elements must have a @value or children
display	SΣ	1..1	string	Brief description of the related artifact ele-1: All FHIR elements must have a @value or children
url	SΣ	1..1	url	Where the artifact can be accessed ele-1: All FHIR elements must have a @value or children
parameter	S	0..*	ParameterDefinition	Parameters defined by the library ele-1: All FHIR elements must have a @value or children
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library ele-1: All FHIR elements must have a @value or children
Slices for content	SΣ	0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType ele-1: All FHIR elements must have a @value or children
content:cqlContent	Σ	0..1	Attachment	CQL Content ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children Required Pattern: text/cql
data		1..1	base64Binary	Data inline, base64ed ele-1: All FHIR elements must have a @value or children
content:fhirpathContent	Σ	0..1	Attachment	FHIRPath Content ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children Required Pattern: text/fhirpath
data		1..1	base64Binary	Data inline, base64ed ele-1: All FHIR elements must have a @value or children
content:queryContent	Σ	0..1	Attachment	Query Content ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children Required Pattern: application/x-fhir-query
data		1..1	base64Binary	Data inline, base64ed ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Library.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
Library.type	extensible	Fixed Value: logic-library("Logic Library") 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.relatedArtifact.type	required	RelatedArtifactType http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard
Library.content:cqlContent.contentType	required	Pattern: text/cql http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content:fhirpathContent.contentType	required	Pattern: text/fhirpath http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content:queryContent.contentType	required	Pattern: application/x-fhir-query http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

This structure is derived from CQL Library

Name	Flags	Card.	Type	Description & Constraints
Library		1..1	CQL Library	Represents a library of quality improvement components
subject[x]	S	0..1	CodeableConcept, Reference(Group)	Type of individual the library content is focused on
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc.
display	S	1..1	string	Brief description of the related artifact
url	S	1..1	url	Where the artifact can be accessed
Slices for content	S	0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent		0..1	Attachment	CQL Content
contentType	S	1..1	code	Mime type of the content, with charset etc. Required Pattern: text/cql
data		1..1	base64Binary	Data inline, base64ed
content:fhirpathContent		0..1	Attachment	FHIRPath Content
contentType	S	1..1	code	Mime type of the content, with charset etc. Required Pattern: text/fhirpath
data		1..1	base64Binary	Data inline, base64ed
content:queryContent		0..1	Attachment	Query Content
contentType	S	1..1	code	Mime type of the content, with charset etc. Required Pattern: application/x-fhir-query
data		1..1	base64Binary	Data inline, base64ed
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	CQL 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
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
extension		0..*	Extension	Additional content defined by implementations
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	0..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. Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: logic-library
display		1..1	string	Representation defined by the system Fixed Value: Logic Library
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
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	S	0..*	RelatedArtifact	Additional documentation, citations, etc.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	1..1	code	documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
label	Σ	0..1	string	Short label
display	SΣ	1..1	string	Brief description of the related artifact
citation	Σ	0..1	markdown	Bibliographic citation for the artifact
url	SΣ	1..1	url	Where the artifact can be accessed
document	Σ	0..1	Attachment	What document is being referenced
resource	Σ	0..1	canonical(Resource)	What resource is being referenced
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
Slices for content	SΣ	0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	Σ	0..1	Attachment	CQL Content
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. Required Pattern: 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		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
content:fhirpathContent	Σ	0..1	Attachment	FHIRPath Content
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. Required Pattern: text/fhirpath
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		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
content:queryContent	Σ	0..1	Attachment	Query Content
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. Required Pattern: application/x-fhir-query
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		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	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	Fixed Value: logic-library("Logic Library") 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.relatedArtifact.type	required	RelatedArtifactType http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard
Library.content:cqlContent.contentType	required	Pattern: text/cql http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content:cqlContent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Library.content:fhirpathContent.contentType	required	Pattern: text/fhirpath http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content:fhirpathContent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Library.content:queryContent.contentType	required	Pattern: application/x-fhir-query http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content:queryContent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

This structure is derived from CQL Library

Summary

Mandatory: 0 element(8 nested mandatory elements)
Must-Support: 8 elements

Slices

This structure defines the following Slices:

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

Maturity: 4

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	CQL 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
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
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
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 Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: logic-library
display		1..1	string	Representation defined by the system Fixed Value: Logic Library
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
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)
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. ele-1: All FHIR elements must have a @value or children
display	SΣ	1..1	string	Brief description of the related artifact ele-1: All FHIR elements must have a @value or children
url	SΣ	1..1	url	Where the artifact can be accessed ele-1: All FHIR elements must have a @value or children
parameter	S	0..*	ParameterDefinition	Parameters defined by the library ele-1: All FHIR elements must have a @value or children
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library ele-1: All FHIR elements must have a @value or children
Slices for content	SΣ	0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType ele-1: All FHIR elements must have a @value or children
content:cqlContent	Σ	0..1	Attachment	CQL Content ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children Required Pattern: text/cql
data		1..1	base64Binary	Data inline, base64ed ele-1: All FHIR elements must have a @value or children
content:fhirpathContent	Σ	0..1	Attachment	FHIRPath Content ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children Required Pattern: text/fhirpath
data		1..1	base64Binary	Data inline, base64ed ele-1: All FHIR elements must have a @value or children
content:queryContent	Σ	0..1	Attachment	Query Content ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children Required Pattern: application/x-fhir-query
data		1..1	base64Binary	Data inline, base64ed ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Library.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
Library.type	extensible	Fixed Value: logic-library("Logic Library") 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.relatedArtifact.type	required	RelatedArtifactType http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard
Library.content:cqlContent.contentType	required	Pattern: text/cql http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content:fhirpathContent.contentType	required	Pattern: text/fhirpath http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content:queryContent.contentType	required	Pattern: application/x-fhir-query http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

Differential View

This structure is derived from CQL Library

Name	Flags	Card.	Type	Description & Constraints
Library		1..1	CQL Library	Represents a library of quality improvement components
subject[x]	S	0..1	CodeableConcept, Reference(Group)	Type of individual the library content is focused on
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc.
display	S	1..1	string	Brief description of the related artifact
url	S	1..1	url	Where the artifact can be accessed
Slices for content	S	0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent		0..1	Attachment	CQL Content
contentType	S	1..1	code	Mime type of the content, with charset etc. Required Pattern: text/cql
data		1..1	base64Binary	Data inline, base64ed
content:fhirpathContent		0..1	Attachment	FHIRPath Content
contentType	S	1..1	code	Mime type of the content, with charset etc. Required Pattern: text/fhirpath
data		1..1	base64Binary	Data inline, base64ed
content:queryContent		0..1	Attachment	Query Content
contentType	S	1..1	code	Mime type of the content, with charset etc. Required Pattern: application/x-fhir-query
data		1..1	base64Binary	Data inline, base64ed
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	CQL 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
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
extension		0..*	Extension	Additional content defined by implementations
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	0..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. Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: logic-library
display		1..1	string	Representation defined by the system Fixed Value: Logic Library
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
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	S	0..*	RelatedArtifact	Additional documentation, citations, etc.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	1..1	code	documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
label	Σ	0..1	string	Short label
display	SΣ	1..1	string	Brief description of the related artifact
citation	Σ	0..1	markdown	Bibliographic citation for the artifact
url	SΣ	1..1	url	Where the artifact can be accessed
document	Σ	0..1	Attachment	What document is being referenced
resource	Σ	0..1	canonical(Resource)	What resource is being referenced
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
Slices for content	SΣ	0..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	Σ	0..1	Attachment	CQL Content
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. Required Pattern: 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		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
content:fhirpathContent	Σ	0..1	Attachment	FHIRPath Content
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. Required Pattern: text/fhirpath
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		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
content:queryContent	Σ	0..1	Attachment	Query Content
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. Required Pattern: application/x-fhir-query
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		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	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	Fixed Value: logic-library("Logic Library") 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.relatedArtifact.type	required	RelatedArtifactType http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard
Library.content:cqlContent.contentType	required	Pattern: text/cql http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content:cqlContent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Library.content:fhirpathContent.contentType	required	Pattern: text/fhirpath http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content:fhirpathContent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Library.content:queryContent.contentType	required	Pattern: application/x-fhir-query http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Library.content:queryContent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

This structure is derived from CQL Library

Summary

Mandatory: 0 element(8 nested mandatory elements)
Must-Support: 8 elements

Slices

This structure defines the following Slices:

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

Maturity: 4

Other representations of profile: CSV, Excel, Schematron

Notes: