Library

Trial Use 4 Specialized — Quality & Testing

The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Library

Interaction	Method	Path
Read	GET	/fhir/R5/Library/[id]
Vread	GET	/fhir/R5/Library/[id]/_history/[vid]
Update	PUT	/fhir/R5/Library/[id]
Patch	PATCH	/fhir/R5/Library/[id]
Delete	DELETE	/fhir/R5/Library/[id]
Create	POST	/fhir/R5/Library
Search	GET	/fhir/R5/Library?...
History	GET	/fhir/R5/Library/[id]/_history
Type-history	GET	/fhir/R5/Library/_history

Top-level elements

Element	Type(s)	Cardinality	Description
url	uri	0..1	Canonical identifier for this library, represented as a URI (globally unique)
identifier	Identifier	0..*	Additional identifier for the library
version	string	0..1	Business version of the library
versionAlgorithm[x]	string / Coding	0..1	How to compare versions
name	string	0..1	Name for this library (computer friendly)
title	string	0..1	Name for this library (human friendly)
subtitle	string	0..1	Subordinate title of the library
status	code	1..1	draft
experimental	boolean	0..1	For testing purposes, not real usage
type	CodeableConcept	1..1	logic-library
subject[x]	CodeableConcept / Reference	0..1	Type of individual the library content is focused on
date	dateTime	0..1	Date last changed
publisher	string	0..1	Name of the publisher/steward (organization or individual)
contact	ContactDetail	0..*	Contact details for the publisher
description	markdown	0..1	Natural language description of the library
useContext	UsageContext	0..*	The context that the content is intended to support
jurisdiction	CodeableConcept	0..*	Intended jurisdiction for library (if applicable)
purpose	markdown	0..1	Why this library is defined
usage	markdown	0..1	Describes the clinical usage of the library
copyright	markdown	0..1	Use and/or publishing restrictions
copyrightLabel	string	0..1	Copyright holder and year(s)
approvalDate	date	0..1	When the library was approved by publisher
lastReviewDate	date	0..1	When the library was last reviewed by the publisher
effectivePeriod	Period	0..1	When the library is expected to be used
topic	CodeableConcept	0..*	E.g. Education, Treatment, Assessment, etc
author	ContactDetail	0..*	Who authored the content
editor	ContactDetail	0..*	Who edited the content
reviewer	ContactDetail	0..*	Who reviewed the content
endorser	ContactDetail	0..*	Who endorsed the content
relatedArtifact	RelatedArtifact	0..*	Additional documentation, citations, etc
parameter	ParameterDefinition	0..*	Parameters defined by the library
dataRequirement	DataRequirement	0..*	What data is referenced by this library
content	Attachment	0..*	Contents of the library, either embedded or referenced

Resource-specific search parameters

Parameter	Type	Description
composed-of	reference	What resource is being referenced
content-type	token	The type of content in the library (e.g. text/cql)
context	token	A use context assigned to the activity definition
context-quantity	quantity	A quantity- or range-valued use context assigned to the activity definition
context-type	token	A type of use context assigned to the activity definition
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the activity definition
context-type-value	composite	A use context type and value assigned to the activity definition
date	date	The activity definition publication date
depends-on	reference	What resource is being referenced
derived-from	reference	What resource is being referenced
description	string	The description of the activity definition
effective	date	The time during which the activity definition is intended to be in use
identifier	token	External identifier for the activity definition
jurisdiction	token	Intended jurisdiction for the activity definition
name	string	Computationally friendly name of the activity definition
predecessor	reference	What resource is being referenced
publisher	string	Name of the publisher of the activity definition
status	token	The current status of the activity definition
successor	reference	What resource is being referenced
title	string	The human-friendly name of the activity definition
topic	token	Topics associated with the module
type	token	The type of the library (e.g. logic-library, model-definition, asset-collection, module-definition)
url	uri	The uri that identifies the activity definition
version	token	The business version of the activity definition

Reference

• Official FHIR R5 spec: Library
• Maturity: Trial Use 4 (FMM 4).