Resources
Library
Resources
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
| Name | Required | Type | Description |
|---|---|---|---|
| url | No | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| identifier | No | Identifier[] | Additional identifier for the library |
| version | No | string | Business version of the library |
| name | No | string | Name for this library (computer friendly) |
| title | No | string | Name for this library (human friendly) |
| subtitle | No | string | Subordinate title of the library |
| status | Yes | code | draft / active / retired / unknown |
| experimental | No | boolean | For testing purposes, not real usage |
| type | Yes | CodeableConcept | logic-library / model-definition / asset-collection / module-definition |
| subject[x] | No | CodeableConcept, Reference<Group> | Type of individual the library content is focused on |
| date | No | dateTime | Date last changed |
| publisher | No | string | Name of the publisher (organization or individual) |
| contact | No | ContactDetail[] | Contact details for the publisher |
| description | No | markdown | Natural language description of the library |
| useContext | No | UsageContext[] | The context that the content is intended to support |
| jurisdiction | No | CodeableConcept[] | Intended jurisdiction for library (if applicable) |
| purpose | No | markdown | Why this library is defined |
| usage | No | string | Describes the clinical usage of the library |
| copyright | No | markdown | Use and/or publishing restrictions |
| approvalDate | No | date | When the library was approved by publisher |
| lastReviewDate | No | date | When the library was last reviewed |
| effectivePeriod | No | Period | When the library is expected to be used |
| topic | No | CodeableConcept[] | E.g. Education, Treatment, Assessment, etc. |
| author | No | ContactDetail[] | Who authored the content |
| editor | No | ContactDetail[] | Who edited the content |
| reviewer | No | ContactDetail[] | Who reviewed the content |
| endorser | No | ContactDetail[] | Who endorsed the content |
| relatedArtifact | No | RelatedArtifact[] | Additional documentation, citations, etc. |
| parameter | No | ParameterDefinition[] | Parameters defined by the library |
| dataRequirement | No | DataRequirement[] | What data is referenced by this library |
| content | No | Attachment[] | Contents of the library, either embedded or referenced |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| composed-of | reference | What resource is being referenced | Library.relatedArtifact |
| 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 |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the library | Library.useContext.value |
| context-type | token | A type of use context assigned to the library | Library.useContext.code |
| date | date | The library publication date | Library.date |
| depends-on | reference | What resource is being referenced | Library.relatedArtifact |
| derived-from | reference | What resource is being referenced | Library.relatedArtifact |
| 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 |
| 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 |
| 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 |
| 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 |
Inherited Properties
| Name | Required | Type | Description |
|---|---|---|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
To view the FHIR specification for this resource, see Library.