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.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/Library/[id] |
| Vread | GET | /fhir/R4/Library/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/Library/[id] |
| Patch | PATCH | /fhir/R4/Library/[id] |
| Delete | DELETE | /fhir/R4/Library/[id] |
| Create | POST | /fhir/R4/Library |
| Search | GET | /fhir/R4/Library |
| History | GET | /fhir/R4/Library/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
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 |
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 | active | retired | unknown |
experimental | boolean | 0..1 | For testing purposes, not real usage |
type | CodeableConcept | 1..1 | logic-library | model-definition | asset-collection | module-definition |
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 (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 | string | 0..1 | Describes the clinical usage of the library |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
approvalDate | date | 0..1 | When the library was approved by publisher |
lastReviewDate | date | 0..1 | When the library was last reviewed |
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 library |
context-quantity | quantity | A quantity- or range-valued use context assigned to the library |
context-type | token | A type of use context assigned to the library |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the library |
context-type-value | composite | A use context type and value assigned to the library |
date | date | The library publication date |
depends-on | reference | What resource is being referenced |
derived-from | reference | What resource is being referenced |
description | string | The description of the library |
effective | date | The time during which the library is intended to be in use |
identifier | token | External identifier for the library |
jurisdiction | token | Intended jurisdiction for the library |
name | string | Computationally friendly name of the library |
predecessor | reference | What resource is being referenced |
publisher | string | Name of the publisher of the library |
status | token | The current status of the library |
successor | reference | What resource is being referenced |
title | string | The human-friendly name of the library |
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 library |
version | token | The business version of the library |
Reference
Official FHIR R4 spec: Library.
Maturity: Trial Use 2 (FMM 2).