Library

ResourceBase · ManagementTrial useMaturity 2

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

22 of 24 parameters tested

Structure

Show inherited elements (8)

Element	Card.	Type	Description
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Σ	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
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
experimentalΣ	0..1	boolean	For testing purposes, not real usage
typeRequiredΣ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definitionBinding (extensible): library-type
subject[x]	0..1	CodeableConcept | Reference(Group)	Type of individual the library content is focused onBinding (extensible): subject-type
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 (extensible): jurisdiction
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 (example): definition-topic
author	0..*	ContactDetail	Who authored the content
editor	0..*	ContactDetail	Who edited the content
reviewer	0..*	ContactDetail	Who reviewed the content
endorser	0..*	ContactDetail	Who endorsed the content
relatedArtifact	0..*	RelatedArtifact	Additional documentation, citations, etc.
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

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Library?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

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

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition