Library - FHIR v1.4.0

STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

4.18.5 Resource Library - Detailed Descriptions

Detailed Descriptions for the elements in the Library resource.

Library
Definition	The Library resource provides a representation container for knowledge artifact component definitions. It is effectively an exposure of the header information for a CQL/ELM library.
Control	1..1
Summary	true
Library.moduleMetadata
Definition	The metadata for the library, including publishing, life-cycle, version, documentation, and supporting evidence.
Control	0..1
Type	ModuleMetadata
Summary	true
Library.model
Definition	A model element describes the model and version used by the library.
Control	0..*
Summary	true
Library.model.name
Definition	The name element defines the local name of the model as used within the library.
Control	0..1
Type	string
Summary	true
Library.model.identifier
Definition	The identifier element specifies the global, non-version-specific identifier for the model.
Note	This is a business identifer, not a resource identifier (see discussion)
Control	1..1
Type	string
Summary	true
Library.model.version
Definition	The version element, if present, identifies the specific version of the model to be used. If no version is specified, the most recent published version of the model is implied.
Note	This is a business versionId, not a resource version id (see discussion)
Control	0..1
Type	string
Summary	true
Library.library
Definition	A library element describes a library referenced by this library.
Control	0..*
Summary	true
Library.library.name
Definition	The name element defines the local name of the referenced library.
Control	0..1
Type	string
Summary	true
Library.library.identifier
Definition	The identifier element specifies the global, non-version-specific identifier for the library.
Note	This is a business identifer, not a resource identifier (see discussion)
Control	1..1
Type	string
Summary	true
Library.library.version
Definition	The version element, if present, identifies the specific version of the library to be used. If no version is specified, the most recent published version of the library is implied.
Note	This is a business versionId, not a resource version id (see discussion)
Control	0..1
Type	string
Summary	true
Library.library.document[x]
Definition	The content of the referenced library as an Attachment, or a reference to the Library resource. If the document is an attachment, it may be a reference to a url from which the library document may be retrieved, or it may be directly embedded as a base-64 string. Either way, the content is expected to be a CQL or ELM document.
Control	0..1
Type	Attachment\|Reference(ModuleDefinition)
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	true
Library.codeSystem
Definition	A code system definition used within the library.
Control	0..*
Summary	true
Library.codeSystem.name
Definition	The name element specifies the local name of the code system as used within the library. This name is also used when the code system is referenced from a value set element to determine the version of the code system to be used when computed the expansion of the value set definition.
Control	0..1
Type	string
Summary	true
Library.codeSystem.identifier
Definition	The identifier element specifies the global, non-version-specific identifier for the code system.
Note	This is a business identifer, not a resource identifier (see discussion)
Control	1..1
Type	string
Summary	true
Library.codeSystem.version
Definition	The version element, if present, identifies the specific version of the library to be used. If no code system is specified, the most recent published version of the code system is implied.
Note	This is a business versionId, not a resource version id (see discussion)
Control	0..1
Type	string
Summary	true
Library.valueSet
Definition	A value set definition referenced by the library.
Control	0..*
Summary	true
Library.valueSet.name
Definition	The name element specifies the local name of the value set used within the library.
Control	0..1
Type	string
Summary	true
Library.valueSet.identifier
Definition	The identifier element specifies the global, non-version-specific identifier for the value set.
Note	This is a business identifer, not a resource identifier (see discussion)
Control	1..1
Type	string
Summary	true
Library.valueSet.version
Definition	The version element, if present, determines the specific version of the value set definition that is used by the library. If no version is specified, the latest published version of the value set definition is implied.
Note	This is a business versionId, not a resource version id (see discussion)
Control	0..1
Type	string
Summary	true
Library.valueSet.codeSystem
Definition	The codeSystem element determines which code system binding to use to compute the expansion of the value set definition. The codeSystem element specified here will correspond to a code system element, which is used to determine the code system version.
Control	0..*
Type	string
Summary	true
Library.parameter
Definition	The parameter element defines parameters used by the library.
Control	0..*
Type	ParameterDefinition
Summary	true
Library.dataRequirement
Definition	The dataRequirement element specifies a data requirement used by some expression within the library.
Control	0..*
Type	DataRequirement
Summary	true
Library.document
Definition	The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the content is expected to be a CQL or ELM document.
Control	1..1
Type	Attachment
Summary	true