Skip to main content

Library

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.

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
url0..1uriCanonical identifier for this library, represented as a URI (globally unique)
identifier0..*IdentifierAdditional identifier for the library
version0..1stringBusiness version of the library
name0..1stringName for this library (computer friendly)
title0..1stringName for this library (human friendly)
subtitle0..1stringSubordinate title of the library
status1..1codedraft | active | retired | unknown
experimental0..1booleanFor testing purposes, not real usage
type1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
subject[x]0..1CodeableConceptType of individual the library content is focused on
date0..1dateTimeDate last changed
publisher0..1stringName of the publisher (organization or individual)
contact0..*ContactDetailContact details for the publisher
description0..1markdownNatural language description of the library
useContext0..*UsageContextThe context that the content is intended to support
jurisdiction0..*CodeableConceptIntended jurisdiction for library (if applicable)
purpose0..1markdownWhy this library is defined
usage0..1stringDescribes the clinical usage of the library
copyright0..1markdownUse and/or publishing restrictions
approvalDate0..1dateWhen the library was approved by publisher
lastReviewDate0..1dateWhen the library was last reviewed
effectivePeriod0..1PeriodWhen the library is expected to be used
topic0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
author0..*ContactDetailWho authored the content
editor0..*ContactDetailWho edited the content
reviewer0..*ContactDetailWho reviewed the content
endorser0..*ContactDetailWho endorsed the content
relatedArtifact0..*RelatedArtifactAdditional documentation, citations, etc.
parameter0..*ParameterDefinitionParameters defined by the library
dataRequirement0..*DataRequirementWhat data is referenced by this library
content0..*AttachmentContents of the library, either embedded or referenced

Search Parameters

NameTypeDescriptionExpression
composed-ofreferenceWhat resource is being referencedLibrary.relatedArtifact
content-typetokenThe type of content in the library (e.g. text/cql)Library.content.contentType
contexttokenA use context assigned to the libraryLibrary.useContext.value
context-quantityquantityA quantity- or range-valued use context assigned to the libraryLibrary.useContext.value
context-typetokenA type of use context assigned to the libraryLibrary.useContext.code
datedateThe library publication dateLibrary.date
depends-onreferenceWhat resource is being referencedLibrary.relatedArtifact
derived-fromreferenceWhat resource is being referencedLibrary.relatedArtifact
descriptionstringThe description of the libraryLibrary.description
effectivedateThe time during which the library is intended to be in useLibrary.effectivePeriod
identifiertokenExternal identifier for the libraryLibrary.identifier
jurisdictiontokenIntended jurisdiction for the libraryLibrary.jurisdiction
namestringComputationally friendly name of the libraryLibrary.name
predecessorreferenceWhat resource is being referencedLibrary.relatedArtifact
publisherstringName of the publisher of the libraryLibrary.publisher
statustokenThe current status of the libraryLibrary.status
successorreferenceWhat resource is being referencedLibrary.relatedArtifact
titlestringThe human-friendly name of the libraryLibrary.title
topictokenTopics associated with the moduleLibrary.topic
typetokenThe type of the library (e.g. logic-library, model-definition, asset-collection, module-definition)Library.type
urluriThe uri that identifies the libraryLibrary.url
versiontokenThe business version of the libraryLibrary.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the libraryLibrary.useContext
context-type-valuecompositeA use context type and value assigned to the libraryLibrary.useContext