Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: CRMI Manifest Library

Defines and supports the definition of a manifest used to establish specific versions of dependencies used in a collection of knowledge artifacts

Knowledge artifacts must be able to specify versioning information for all the dependencies used in a particular release to enable stable expansion of value sets and consistent resolution of dependencies. For example, the versions of code systems used in value sets referenced by the artifacts must be identified so that terminology servers performing expansions can unambiguously select the version of each code system used to perform the expansion.

Usage:

• Examples for this Resource Profile: ANCMDangerSignsPackage

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	0..*	Library	Represents a library of quality improvement components dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
directReferenceCode	S	0..*	Coding	A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
logicDefinition	S	0..*	(Complex)	A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
expansionParameters	S	0..1	Reference(Parameters)	What expansion rules URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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	SΣ	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 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/library-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: asset-collection
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children
relatedArtifact:component	SC	0..*	RelatedArtifact	What components are in the manifest ele-1: All FHIR elements must have a @value or children mnf-1: Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
Slices for extension				Content/Rules for all slices
isOwned	S	0..1	boolean	Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
resourceReference	SC	0..1	Reference(Resource)	A reference to the component artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	SΣ	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 Fixed Value: composed-of
display	SΣ	0..1	string	Brief description of the related artifact ele-1: All FHIR elements must have a @value or children
resource	SΣC	0..1	canonical(Resource)	A reference to the component artifact (for canonical resources) ele-1: All FHIR elements must have a @value or children
relatedArtifact:dependency	SC	0..*	RelatedArtifact	What dependencies are referenced ele-1: All FHIR elements must have a @value or children mnf-2: Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
Slices for extension				Content/Rules for all slices
resourceReference	SC	0..1	Reference(Resource)	A reference to the dependency artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	SΣ	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 Fixed Value: depends-on
display	SΣ	0..1	string	Brief description of the related artifact ele-1: All FHIR elements must have a @value or children
resource	SΣC	0..1	canonical(Resource)	A reference to the dependency artifact (for canonical resources) 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	Pattern: asset-collection http://hl7.org/fhir/ValueSet/library-type from the FHIR Standard
Library.relatedArtifact:component.type	required	Fixed Value: composed-of http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard
Library.relatedArtifact:dependency.type	required	Fixed Value: depends-on http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Library	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Library	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Library	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
lib-0	warning	Library	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
mnf-1	error	Library.relatedArtifact:component	Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()
mnf-2	error	Library.relatedArtifact:dependency	Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()

This structure is derived from Library

Name	Flags	Card.	Type	Description & Constraints
Library		0..*	Library	Represents a library of quality improvement components
Slices for extension				Content/Rules for all slices
directReferenceCode	S	0..*	Coding	A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
logicDefinition	S	0..*	(Complex)	A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
expansionParameters	S	0..1	Reference(Parameters)	What expansion rules URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
type	S	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition 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/library-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: asset-collection
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:component	SC	0..*	RelatedArtifact	What components are in the manifest mnf-1: Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
Slices for extension				Content/Rules for all slices
isOwned	S	0..1	boolean	Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned
resourceReference	SC	0..1	Reference(Resource)	A reference to the component artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference
type	S	1..1	code	documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: composed-of
display	S	0..1	string	Brief description of the related artifact
resource	SC	0..1	canonical(Resource)	A reference to the component artifact (for canonical resources)
relatedArtifact:dependency	SC	0..*	RelatedArtifact	What dependencies are referenced mnf-2: Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
Slices for extension				Content/Rules for all slices
resourceReference	SC	0..1	Reference(Resource)	A reference to the dependency artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference
type	S	1..1	code	documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: depends-on
display	S	0..1	string	Brief description of the related artifact
resource	SC	0..1	canonical(Resource)	A reference to the dependency artifact (for canonical resources)
content		0..0
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
mnf-1	error	Library.relatedArtifact:component	Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()
mnf-2	error	Library.relatedArtifact:dependency	Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()

Name	Flags	Card.	Type	Description & Constraints
Library	C	0..*	Library	Represents a library of quality improvement components lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
directReferenceCode	S	0..*	Coding	A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
logicDefinition	S	0..*	(Complex)	A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
expansionParameters	S	0..1	Reference(Parameters)	What expansion rules URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
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	SΣ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. 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/library-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: asset-collection
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
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	Σ	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
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:component	SC	0..*	RelatedArtifact	What components are in the manifest mnf-1: Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
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
isOwned	S	0..1	boolean	Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned
resourceReference	SC	0..1	Reference(Resource)	A reference to the component artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference
type	SΣ	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. Fixed Value: composed-of
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	Σ	0..1	Attachment	What document is being referenced
resource	SΣC	0..1	canonical(Resource)	A reference to the component artifact (for canonical resources)
relatedArtifact:dependency	SC	0..*	RelatedArtifact	What dependencies are referenced mnf-2: Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
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
resourceReference	SC	0..1	Reference(Resource)	A reference to the dependency artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference
type	SΣ	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. Fixed Value: depends-on
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	Σ	0..1	Attachment	What document is being referenced
resource	SΣC	0..1	canonical(Resource)	A reference to the dependency artifact (for canonical resources)
parameter		0..*	ParameterDefinition	Parameters defined by the library
dataRequirement		0..*	DataRequirement	What data is referenced by this library
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	Pattern: asset-collection 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:component.type	required	Fixed Value: composed-of http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard
Library.relatedArtifact:dependency.type	required	Fixed Value: depends-on http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Library	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Library	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Library	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
lib-0	warning	Library	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
mnf-1	error	Library.relatedArtifact:component	Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()
mnf-2	error	Library.relatedArtifact:dependency	Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()

This structure is derived from Library

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 17 elements
Fixed: 2 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
• http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
• http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
• http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
• http://hl7.org/fhir/StructureDefinition/artifact-isOwned
• http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference

Slices

This structure defines the following Slices:

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

Maturity: 3

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Library	C	0..*	Library	Represents a library of quality improvement components dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
directReferenceCode	S	0..*	Coding	A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
logicDefinition	S	0..*	(Complex)	A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
expansionParameters	S	0..1	Reference(Parameters)	What expansion rules URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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	SΣ	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 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/library-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: asset-collection
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children
relatedArtifact:component	SC	0..*	RelatedArtifact	What components are in the manifest ele-1: All FHIR elements must have a @value or children mnf-1: Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
Slices for extension				Content/Rules for all slices
isOwned	S	0..1	boolean	Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
resourceReference	SC	0..1	Reference(Resource)	A reference to the component artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	SΣ	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 Fixed Value: composed-of
display	SΣ	0..1	string	Brief description of the related artifact ele-1: All FHIR elements must have a @value or children
resource	SΣC	0..1	canonical(Resource)	A reference to the component artifact (for canonical resources) ele-1: All FHIR elements must have a @value or children
relatedArtifact:dependency	SC	0..*	RelatedArtifact	What dependencies are referenced ele-1: All FHIR elements must have a @value or children mnf-2: Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
Slices for extension				Content/Rules for all slices
resourceReference	SC	0..1	Reference(Resource)	A reference to the dependency artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	SΣ	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 Fixed Value: depends-on
display	SΣ	0..1	string	Brief description of the related artifact ele-1: All FHIR elements must have a @value or children
resource	SΣC	0..1	canonical(Resource)	A reference to the dependency artifact (for canonical resources) 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	Pattern: asset-collection http://hl7.org/fhir/ValueSet/library-type from the FHIR Standard
Library.relatedArtifact:component.type	required	Fixed Value: composed-of http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard
Library.relatedArtifact:dependency.type	required	Fixed Value: depends-on http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Library	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Library	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Library	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
lib-0	warning	Library	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
mnf-1	error	Library.relatedArtifact:component	Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()
mnf-2	error	Library.relatedArtifact:dependency	Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()

Differential View

This structure is derived from Library

Name	Flags	Card.	Type	Description & Constraints
Library		0..*	Library	Represents a library of quality improvement components
Slices for extension				Content/Rules for all slices
directReferenceCode	S	0..*	Coding	A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
logicDefinition	S	0..*	(Complex)	A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
expansionParameters	S	0..1	Reference(Parameters)	What expansion rules URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
type	S	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition 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/library-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: asset-collection
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:component	SC	0..*	RelatedArtifact	What components are in the manifest mnf-1: Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
Slices for extension				Content/Rules for all slices
isOwned	S	0..1	boolean	Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned
resourceReference	SC	0..1	Reference(Resource)	A reference to the component artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference
type	S	1..1	code	documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: composed-of
display	S	0..1	string	Brief description of the related artifact
resource	SC	0..1	canonical(Resource)	A reference to the component artifact (for canonical resources)
relatedArtifact:dependency	SC	0..*	RelatedArtifact	What dependencies are referenced mnf-2: Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
Slices for extension				Content/Rules for all slices
resourceReference	SC	0..1	Reference(Resource)	A reference to the dependency artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference
type	S	1..1	code	documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: depends-on
display	S	0..1	string	Brief description of the related artifact
resource	SC	0..1	canonical(Resource)	A reference to the dependency artifact (for canonical resources)
content		0..0
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
mnf-1	error	Library.relatedArtifact:component	Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()
mnf-2	error	Library.relatedArtifact:dependency	Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Library	C	0..*	Library	Represents a library of quality improvement components lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
directReferenceCode	S	0..*	Coding	A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
logicDefinition	S	0..*	(Complex)	A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
cqlOptions	S	0..1	Reference(Parameters)	What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
expansionParameters	S	0..1	Reference(Parameters)	What expansion rules URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
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	SΣ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. 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/library-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: asset-collection
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
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	Σ	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
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:component	SC	0..*	RelatedArtifact	What components are in the manifest mnf-1: Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
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
isOwned	S	0..1	boolean	Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned
resourceReference	SC	0..1	Reference(Resource)	A reference to the component artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference
type	SΣ	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. Fixed Value: composed-of
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	Σ	0..1	Attachment	What document is being referenced
resource	SΣC	0..1	canonical(Resource)	A reference to the component artifact (for canonical resources)
relatedArtifact:dependency	SC	0..*	RelatedArtifact	What dependencies are referenced mnf-2: Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both
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
resourceReference	SC	0..1	Reference(Resource)	A reference to the dependency artifact (for canonical promotions) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference
type	SΣ	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. Fixed Value: depends-on
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	Σ	0..1	Attachment	What document is being referenced
resource	SΣC	0..1	canonical(Resource)	A reference to the dependency artifact (for canonical resources)
parameter		0..*	ParameterDefinition	Parameters defined by the library
dataRequirement		0..*	DataRequirement	What data is referenced by this library
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	Pattern: asset-collection 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:component.type	required	Fixed Value: composed-of http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard
Library.relatedArtifact:dependency.type	required	Fixed Value: depends-on http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Library	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Library	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Library	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
lib-0	warning	Library	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
mnf-1	error	Library.relatedArtifact:component	Component reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()
mnf-2	error	Library.relatedArtifact:dependency	Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both : resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists()

This structure is derived from Library

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 17 elements
Fixed: 2 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
• http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
• http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
• http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
• http://hl7.org/fhir/StructureDefinition/artifact-isOwned
• http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference

Slices

This structure defines the following Slices:

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

Maturity: 3

Other representations of profile: CSV, Excel, Schematron