Quality Measure Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-cqm/ and changes regularly. See the Directory of published versions

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

Resource Profile: CQM Publishable Library

The CQM Publishable Library profile defines the minimum expectations to enable appropriate content management, discovery, and utilization of the library resources used for published Quality Measures (QMs). For more information on the usage of this profile, refer to the Profiles and Packaging pages in this implementation guide.

Usages:

• Examples for this Profile: BCSComponent, CCSComponent, EXM124, HBPComponent... Show 2 more, PVSComponent and TSCComponent

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Library	C	1..1	CRMIPublishableLibrary	Represents a library of quality improvement components Constraints: lib-0, pub-1
meta	Σ	0..1	Meta	Metadata about the resource
Slices for extension				Content/Rules for all slices
extension:packageSource	S	0..1	(Complex)	What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text	S	1..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for extension				Content/Rules for all slices
extension:knowledgeCapability	SC	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
extension:logicDefinition	S	0..*	(Complex)	A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
extension:copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:artifactComment		0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
extension:authoritativeSource	S	0..1	uri	Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
extension:softwaresystem	S	0..*	Reference(CRMI Software System Device)	Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	Additional identifier for the library Slice: Unordered, Open by value:type
identifier:versionIndependentIdentifier	SΣ	0..1	Identifier	Library guid
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-independent
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:versionSpecificIdentifier	SΣ	0..1	Identifier	Library version guid
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-specific
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:shortName	SΣ	0..1	Identifier	Short name
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: short-name
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:endorserIdentifier	SΣ	0..*	Identifier	Endorser identifier
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: endorser
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
assigner	SΣ	1..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣ	1..1	string	Text alternative for the resource
identifier:publisherIdentifier	SΣ	0..*	Identifier	Publisher identifier
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: publisher
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
assigner	SΣ	1..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣ	1..1	string	Text alternative for the resource
title	SΣ	1..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.
type	SΣ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains.
date	SΣ	1..1	dateTime	Date last changed
publisher	SΣ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	1..*	ContactDetail	Contact details for the publisher
Slices for useContext	SΣ	0..*	UsageContext	The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:intendedVenue	SΣ	0..*	UsageContext	What venue?
code	SΣ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: venue
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	SΣ	1..1	CodeableConcept	Value that defines the context Binding: Intended Venue (extensible)
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	S	0..1	markdown	Why this library is defined
usage	S	0..1	string	Describes the clinical usage of the library
copyright	S	0..1	markdown	Use and/or publishing restrictions
approvalDate	S	0..1	date	When the library was approved by publisher
lastReviewDate	S	0..1	date	When the library was last reviewed
effectivePeriod	SΣ	0..1	Period	When the library is expected to be used
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author	S	0..*	ContactDetail	Who authored the content
editor	S	0..*	ContactDetail	Who edited the content
reviewer	S	0..*	ContactDetail	Who reviewed the content
endorser	S	0..*	ContactDetail	Who endorsed the content
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc.
Slices for extension				Content/Rules for all slices
extension:publicationDate		0..1	date	Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
extension:publicationStatus		0..1	code	Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact
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.
display	SΣ	0..1	string	Brief description of the related artifact
document	SΣ	0..1	Attachment	What document is being referenced
resource	SΣ	0..1	canonical(Resource)	What resource is being referenced
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Library.identifier:versionIndependentIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:versionIndependentIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:versionSpecificIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:versionSpecificIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:shortName.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:shortName.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:endorserIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:endorserIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:publisherIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:publisherIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.status	Base	required	PublicationStatus	📍4.0.1	FHIR Std.
Library.type	Base	extensible	LibraryType	📍4.0.1	FHIR Std.
Library.useContext:intendedVenue.​code	Base	extensible	UsageContextType	📍4.0.1	FHIR Std.
Library.useContext:intendedVenue.​value[x]	Base	extensible	Intended Venue	📦4.0.0	This IG
Library.jurisdiction	Base	extensible	Jurisdiction	📍4.0.1	FHIR Std.
Library.topic	Base	example	DefinitionTopic	📍4.0.1	FHIR Std.
Library.relatedArtifact.​type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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}')
pub-1	error	Library	If knowledge capabilities are stated, they SHALL include publishable	extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Library		1..1	CRMIPublishableLibrary	Represents a library of quality improvement components
text	S	1..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension				Content/Rules for all slices
extension:softwaresystem	S	0..*	Reference(CRMI Software System Device)	Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
Slices for identifier	S	0..*	Identifier	Additional identifier for the library Slice: Unordered, Open by value:type
identifier:versionIndependentIdentifier	S	0..1	Identifier	Library guid
use	S	1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type	S	1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-independent
system	S	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	S	1..1	string	The value that is unique
identifier:versionSpecificIdentifier	S	0..1	Identifier	Library version guid
use	S	1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type	S	1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-specific
system	S	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	S	1..1	string	The value that is unique
identifier:shortName	S	0..1	Identifier	Short name
use	S	0..1	code	usual | official | temp | secondary | old (If known) Fixed Value: usual
type	S	1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: short-name
value	S	1..1	string	The value that is unique
identifier:endorserIdentifier	S	0..*	Identifier	Endorser identifier
use	S	1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type	S	1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: endorser
system	S	0..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
assigner	S	1..1	Reference(Organization)	Organization that issued id (may be just text)
display	S	1..1	string	Text alternative for the resource
identifier:publisherIdentifier	S	0..*	Identifier	Publisher identifier
use	S	1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type	S	1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: publisher
system	S	0..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
assigner	S	1..1	Reference(Organization)	Organization that issued id (may be just text)
display	S	1..1	string	Text alternative for the resource
title	S	1..1	string	Name for this library (human friendly)
publisher	S	1..1	string	Name of the publisher (organization or individual)
contact	S	1..*	ContactDetail	Contact details for the publisher
Slices for useContext	S	0..*	UsageContext	The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:intendedVenue	S	0..*	UsageContext	What venue?
code	S	1..1	Coding	Type of context being specified Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: venue
value[x]	S	1..1	CodeableConcept	Value that defines the context Binding: Intended Venue (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Library.useContext:intendedVenue.​value[x]	Base	extensible	Intended Venue	📦4.0.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Library	C	1..1	CRMIPublishableLibrary	Represents a library of quality improvement components Constraints: lib-0, pub-1
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
extension:packageSource	S	0..1	(Complex)	What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source
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	Σ	0..*	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	S	1..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:knowledgeCapability	SC	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
extension:logicDefinition	S	0..*	(Complex)	A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
extension:copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:artifactComment		0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
extension:authoritativeSource	S	0..1	uri	Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
extension:softwaresystem	S	0..*	Reference(CRMI Software System Device)	Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	0..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
Slices for identifier	SΣ	0..*	Identifier	Additional identifier for the library Slice: Unordered, Open by value:type
identifier:versionIndependentIdentifier	SΣ	0..1	Identifier	Library guid
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-independent
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:versionSpecificIdentifier	SΣ	0..1	Identifier	Library version guid
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-specific
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:shortName	SΣ	0..1	Identifier	Short name
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: short-name
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:endorserIdentifier	SΣ	0..*	Identifier	Endorser identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: endorser
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	1..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	1..1	string	Text alternative for the resource
identifier:publisherIdentifier	SΣ	0..*	Identifier	Publisher identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: publisher
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	1..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	1..1	string	Text alternative for the resource
version	Σ	0..1	string	Business version of the library
name	ΣC	0..1	string	Name for this library (computer friendly)
title	SΣ	1..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	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]		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Σ	1..1	dateTime	Date last changed
publisher	SΣ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	1..*	ContactDetail	Contact details for the publisher
description	Σ	0..1	markdown	Natural language description of the library
Slices for useContext	SΣ	0..*	UsageContext	The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:intendedVenue	SΣ	0..*	UsageContext	What venue?
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	SΣ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: venue
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	SΣ	1..1	CodeableConcept	Value that defines the context Binding: Intended Venue (extensible)
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	S	0..1	markdown	Why this library is defined
usage	S	0..1	string	Describes the clinical usage of the library
copyright	S	0..1	markdown	Use and/or publishing restrictions
approvalDate	S	0..1	date	When the library was approved by publisher
lastReviewDate	S	0..1	date	When the library was last reviewed
effectivePeriod	SΣ	0..1	Period	When the library is expected to be used
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author	S	0..*	ContactDetail	Who authored the content
editor	S	0..*	ContactDetail	Who edited the content
reviewer	S	0..*	ContactDetail	Who reviewed the content
endorser	S	0..*	ContactDetail	Who endorsed the content
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc.
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
extension:publicationDate		0..1	date	Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
extension:publicationStatus		0..1	code	Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact
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Σ	0..1	string	Brief description of the related artifact
citation	Σ	0..1	markdown	Bibliographic citation for the artifact
url	Σ	0..1	url	Where the artifact can be accessed
document	SΣ	0..1	Attachment	What document is being referenced
resource	SΣ	0..1	canonical(Resource)	What resource is being referenced
parameter		0..*	ParameterDefinition	Parameters defined by the library
dataRequirement		0..*	DataRequirement	What data is referenced by this library
content	Σ	0..*	Attachment	Contents of the library, either embedded or referenced
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Library.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Library.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Library.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Library.identifier:versionIndependentIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:versionIndependentIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:versionSpecificIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:versionSpecificIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:shortName.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:shortName.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:endorserIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:endorserIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:endorserIdentifier.​assigner.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Library.identifier:publisherIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:publisherIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:publisherIdentifier.​assigner.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Library.status	Base	required	PublicationStatus	📍4.0.1	FHIR Std.
Library.type	Base	extensible	LibraryType	📍4.0.1	FHIR Std.
Library.subject[x]	Base	extensible	Subject type	📍4.0.1	FHIR Std.
Library.useContext:intendedVenue.​code	Base	extensible	UsageContextType	📍4.0.1	FHIR Std.
Library.useContext:intendedVenue.​value[x]	Base	extensible	Intended Venue	📦4.0.0	This IG
Library.jurisdiction	Base	extensible	Jurisdiction	📍4.0.1	FHIR Std.
Library.topic	Base	example	DefinitionTopic	📍4.0.1	FHIR Std.
Library.relatedArtifact.​type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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}')
pub-1	error	Library	If knowledge capabilities are stated, they SHALL include publishable	extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Summary

Mandatory: 4 elements(22 nested mandatory elements)
Must-Support: 38 elements
Fixed: 7 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem

Slices

This structure defines the following Slices:

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

Maturity: 4

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Library	C	1..1	CRMIPublishableLibrary	Represents a library of quality improvement components Constraints: lib-0, pub-1
meta	Σ	0..1	Meta	Metadata about the resource
Slices for extension				Content/Rules for all slices
extension:packageSource	S	0..1	(Complex)	What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text	S	1..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for extension				Content/Rules for all slices
extension:knowledgeCapability	SC	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
extension:logicDefinition	S	0..*	(Complex)	A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
extension:copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:artifactComment		0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
extension:authoritativeSource	S	0..1	uri	Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
extension:softwaresystem	S	0..*	Reference(CRMI Software System Device)	Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	Additional identifier for the library Slice: Unordered, Open by value:type
identifier:versionIndependentIdentifier	SΣ	0..1	Identifier	Library guid
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-independent
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:versionSpecificIdentifier	SΣ	0..1	Identifier	Library version guid
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-specific
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:shortName	SΣ	0..1	Identifier	Short name
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: short-name
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:endorserIdentifier	SΣ	0..*	Identifier	Endorser identifier
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: endorser
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
assigner	SΣ	1..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣ	1..1	string	Text alternative for the resource
identifier:publisherIdentifier	SΣ	0..*	Identifier	Publisher identifier
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: publisher
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
assigner	SΣ	1..1	Reference(Organization)	Organization that issued id (may be just text)
display	SΣ	1..1	string	Text alternative for the resource
title	SΣ	1..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.
type	SΣ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains.
date	SΣ	1..1	dateTime	Date last changed
publisher	SΣ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	1..*	ContactDetail	Contact details for the publisher
Slices for useContext	SΣ	0..*	UsageContext	The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:intendedVenue	SΣ	0..*	UsageContext	What venue?
code	SΣ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: venue
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	SΣ	1..1	CodeableConcept	Value that defines the context Binding: Intended Venue (extensible)
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	S	0..1	markdown	Why this library is defined
usage	S	0..1	string	Describes the clinical usage of the library
copyright	S	0..1	markdown	Use and/or publishing restrictions
approvalDate	S	0..1	date	When the library was approved by publisher
lastReviewDate	S	0..1	date	When the library was last reviewed
effectivePeriod	SΣ	0..1	Period	When the library is expected to be used
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author	S	0..*	ContactDetail	Who authored the content
editor	S	0..*	ContactDetail	Who edited the content
reviewer	S	0..*	ContactDetail	Who reviewed the content
endorser	S	0..*	ContactDetail	Who endorsed the content
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc.
Slices for extension				Content/Rules for all slices
extension:publicationDate		0..1	date	Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
extension:publicationStatus		0..1	code	Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact
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.
display	SΣ	0..1	string	Brief description of the related artifact
document	SΣ	0..1	Attachment	What document is being referenced
resource	SΣ	0..1	canonical(Resource)	What resource is being referenced
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Library.identifier:versionIndependentIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:versionIndependentIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:versionSpecificIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:versionSpecificIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:shortName.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:shortName.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:endorserIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:endorserIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:publisherIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:publisherIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.status	Base	required	PublicationStatus	📍4.0.1	FHIR Std.
Library.type	Base	extensible	LibraryType	📍4.0.1	FHIR Std.
Library.useContext:intendedVenue.​code	Base	extensible	UsageContextType	📍4.0.1	FHIR Std.
Library.useContext:intendedVenue.​value[x]	Base	extensible	Intended Venue	📦4.0.0	This IG
Library.jurisdiction	Base	extensible	Jurisdiction	📍4.0.1	FHIR Std.
Library.topic	Base	example	DefinitionTopic	📍4.0.1	FHIR Std.
Library.relatedArtifact.​type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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}')
pub-1	error	Library	If knowledge capabilities are stated, they SHALL include publishable	extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Library		1..1	CRMIPublishableLibrary	Represents a library of quality improvement components
text	S	1..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension				Content/Rules for all slices
extension:softwaresystem	S	0..*	Reference(CRMI Software System Device)	Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
Slices for identifier	S	0..*	Identifier	Additional identifier for the library Slice: Unordered, Open by value:type
identifier:versionIndependentIdentifier	S	0..1	Identifier	Library guid
use	S	1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type	S	1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-independent
system	S	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	S	1..1	string	The value that is unique
identifier:versionSpecificIdentifier	S	0..1	Identifier	Library version guid
use	S	1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type	S	1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-specific
system	S	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	S	1..1	string	The value that is unique
identifier:shortName	S	0..1	Identifier	Short name
use	S	0..1	code	usual | official | temp | secondary | old (If known) Fixed Value: usual
type	S	1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: short-name
value	S	1..1	string	The value that is unique
identifier:endorserIdentifier	S	0..*	Identifier	Endorser identifier
use	S	1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type	S	1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: endorser
system	S	0..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
assigner	S	1..1	Reference(Organization)	Organization that issued id (may be just text)
display	S	1..1	string	Text alternative for the resource
identifier:publisherIdentifier	S	0..*	Identifier	Publisher identifier
use	S	1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type	S	1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: publisher
system	S	0..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
assigner	S	1..1	Reference(Organization)	Organization that issued id (may be just text)
display	S	1..1	string	Text alternative for the resource
title	S	1..1	string	Name for this library (human friendly)
publisher	S	1..1	string	Name of the publisher (organization or individual)
contact	S	1..*	ContactDetail	Contact details for the publisher
Slices for useContext	S	0..*	UsageContext	The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:intendedVenue	S	0..*	UsageContext	What venue?
code	S	1..1	Coding	Type of context being specified Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: venue
value[x]	S	1..1	CodeableConcept	Value that defines the context Binding: Intended Venue (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Library.useContext:intendedVenue.​value[x]	Base	extensible	Intended Venue	📦4.0.0	This IG

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Library	C	1..1	CRMIPublishableLibrary	Represents a library of quality improvement components Constraints: lib-0, pub-1
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
extension:packageSource	S	0..1	(Complex)	What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source
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	Σ	0..*	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	S	1..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:knowledgeCapability	SC	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
extension:logicDefinition	S	0..*	(Complex)	A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
extension:copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:artifactComment		0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
extension:authoritativeSource	S	0..1	uri	Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
extension:softwaresystem	S	0..*	Reference(CRMI Software System Device)	Extension URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	0..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
Slices for identifier	SΣ	0..*	Identifier	Additional identifier for the library Slice: Unordered, Open by value:type
identifier:versionIndependentIdentifier	SΣ	0..1	Identifier	Library guid
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-independent
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:versionSpecificIdentifier	SΣ	0..1	Identifier	Library version guid
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: version-specific
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:shortName	SΣ	0..1	Identifier	Short name
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: short-name
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:endorserIdentifier	SΣ	0..*	Identifier	Endorser identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: endorser
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	1..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	1..1	string	Text alternative for the resource
identifier:publisherIdentifier	SΣ	0..*	Identifier	Publisher identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/artifact-identifier-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: publisher
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	1..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	1..1	string	Text alternative for the resource
version	Σ	0..1	string	Business version of the library
name	ΣC	0..1	string	Name for this library (computer friendly)
title	SΣ	1..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	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]		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Σ	1..1	dateTime	Date last changed
publisher	SΣ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	1..*	ContactDetail	Contact details for the publisher
description	Σ	0..1	markdown	Natural language description of the library
Slices for useContext	SΣ	0..*	UsageContext	The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:intendedVenue	SΣ	0..*	UsageContext	What venue?
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	SΣ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: venue
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	SΣ	1..1	CodeableConcept	Value that defines the context Binding: Intended Venue (extensible)
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	S	0..1	markdown	Why this library is defined
usage	S	0..1	string	Describes the clinical usage of the library
copyright	S	0..1	markdown	Use and/or publishing restrictions
approvalDate	S	0..1	date	When the library was approved by publisher
lastReviewDate	S	0..1	date	When the library was last reviewed
effectivePeriod	SΣ	0..1	Period	When the library is expected to be used
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author	S	0..*	ContactDetail	Who authored the content
editor	S	0..*	ContactDetail	Who edited the content
reviewer	S	0..*	ContactDetail	Who reviewed the content
endorser	S	0..*	ContactDetail	Who endorsed the content
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc.
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
extension:publicationDate		0..1	date	Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
extension:publicationStatus		0..1	code	Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact
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Σ	0..1	string	Brief description of the related artifact
citation	Σ	0..1	markdown	Bibliographic citation for the artifact
url	Σ	0..1	url	Where the artifact can be accessed
document	SΣ	0..1	Attachment	What document is being referenced
resource	SΣ	0..1	canonical(Resource)	What resource is being referenced
parameter		0..*	ParameterDefinition	Parameters defined by the library
dataRequirement		0..*	DataRequirement	What data is referenced by this library
content	Σ	0..*	Attachment	Contents of the library, either embedded or referenced
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Library.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Library.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Library.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Library.identifier:versionIndependentIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:versionIndependentIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:versionSpecificIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:versionSpecificIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:shortName.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:shortName.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:endorserIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:endorserIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:endorserIdentifier.​assigner.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Library.identifier:publisherIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Library.identifier:publisherIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Library.identifier:publisherIdentifier.​assigner.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Library.status	Base	required	PublicationStatus	📍4.0.1	FHIR Std.
Library.type	Base	extensible	LibraryType	📍4.0.1	FHIR Std.
Library.subject[x]	Base	extensible	Subject type	📍4.0.1	FHIR Std.
Library.useContext:intendedVenue.​code	Base	extensible	UsageContextType	📍4.0.1	FHIR Std.
Library.useContext:intendedVenue.​value[x]	Base	extensible	Intended Venue	📦4.0.0	This IG
Library.jurisdiction	Base	extensible	Jurisdiction	📍4.0.1	FHIR Std.
Library.topic	Base	example	DefinitionTopic	📍4.0.1	FHIR Std.
Library.relatedArtifact.​type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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}')
pub-1	error	Library	If knowledge capabilities are stated, they SHALL include publishable	extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Summary

Mandatory: 4 elements(22 nested mandatory elements)
Must-Support: 38 elements
Fixed: 7 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem

Slices

This structure defines the following Slices:

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

Maturity: 4