Library

Introduction

Scope and Usage

The Library resource is a general purpose knowledge artifact that can fulfill a variety of use cases, including managing collections of artifacts, providing a FHIR wrapper for non-FHIR knowledge artifacts, and describing logic and interaction capabilities of knowledge modules. For example, a Library may be used to wrap a non-FHIR representation, such as a shareable library of clinical logic, written in Clinical Quality Language (CQL). In addition, a Library may be used to refer to artifacts defined using FHIR resources such as the description of a protocol represented by a PlanDefinition resource.

As a CanonicalResource and MetadataResource, a Library has all the typical metadata such as url, identifier, version, and title. In addition, the resource has elements for tracking dependencies, as well as for representing the parameters and data requirements for any expression functionality provided by the library.

For non-FHIR assets, the actual content of the library is represented using the Attachment data type, and may either be referenced with a URL, or the content may be embedded as a base-64 encoded string. Either way, the contentType element of the attachment is used to indicate the representation of the library content.

Note that because the library content may be embedded as well as be retrievable from an external repository via the attachment URL, the possibility exists for the embedded content to be different from the content on the repository. With proper versioning and governance, this should never occur, but to minimize the potential impact of this possibility, implementers SHALL give precedence to the embedded content of a library when it is present.

A common use case for the Library resource is to establish the release dependencies of a collection of artifacts. A library with a type of asset-collection can be used to define the collection of artifacts, as well as the required dependencies, especially when the artifacts in the collection have version-independent canonical references, as is often the case with CodeSystem and ValueSet references. This usage is known as an artifact manifest, and is described more fully in the Artifact Manifest topic of the Canonical Resource Management Infrastructure implementation guide.

Boundaries and Relationships

The Library resource is definitional in nature, meaning it is intended to represent shareable knowledge independent of any particular patient. This is in contrast to the DocumentReference resource, which captures non-FHIR content related to a specific patient, multimedia content, or other raw binary content.

Background and Context

Provides additional detail on exactly how the resource is to be used

StructureDefinition

Elements (Simplified)

• Library [0..*]: - Represents a library of quality improvement components
• Library.url [0..1]: uri Canonical identifier for this library, represented as a URI (globally unique)
• Library.identifier [0..*]: Identifier Additional identifier for the library
• Library.version [0..1]: string Business version of the library
• Library.versionAlgorithm[x] [0..1]: string, Coding extensible:version-algorithm How to compare versions
• Library.name [0..1]: string Name for this library (computer friendly)
• Library.title [0..1]: string Name for this library (human friendly)
• Library.subtitle [0..1]: string Subordinate title of the library
• Library.status [1..1]: code required:publication-status draft | active | retired | unknown
• Library.experimental [0..1]: boolean For testing only - never for real usage
• Library.type [1..1]: CodeableConcept extensible:library-type logic-library | model-definition | asset-collection | module-definition | etc.
• Library.subject[x] [0..1]: CodeableConcept, Reference(Group) extensible:participant-resource-types Type of individual the library content is focused on
• Library.date [0..1]: dateTime Date last changed
• Library.publisher [0..1]: string Name of the publisher/steward (organization or individual)
• Library.contact [0..*]: ContactDetail Contact details for the publisher
• Library.description [0..1]: markdown Natural language description of the library
• Library.useContext [0..*]: UsageContext The context that the content is intended to support
• Library.jurisdiction [0..*]: CodeableConcept extensible:jurisdiction Jurisdiction of the authority that maintains the library (if applicable)
• Library.purpose [0..1]: markdown Why this library is defined
• Library.usage [0..1]: markdown Describes the clinical usage of the library
• Library.copyright [0..1]: markdown Notice about intellectual property ownership, can include restrictions on use
• Library.copyrightLabel [0..1]: string Copyright holder and year(s)
• Library.approvalDate [0..1]: date When the library was approved by publisher
• Library.lastReviewDate [0..1]: date When the library was last reviewed by the publisher
• Library.effectivePeriod [0..1]: Period When the library is expected to be used
• Library.topic [0..*]: CodeableConcept example:definition-topic E.g. Education, Treatment, Assessment, etc
• Library.author [0..*]: ContactDetail Who authored the content
• Library.editor [0..*]: ContactDetail Who edited the content
• Library.reviewer [0..*]: ContactDetail Who reviewed the content
• Library.endorser [0..*]: ContactDetail Who endorsed the content
• Library.relatedArtifact [0..*]: RelatedArtifact Additional documentation, citations, etc
• Library.parameter [0..*]: ParameterDefinition Parameters defined by the library
• Library.dataRequirement [0..*]: DataRequirement What data is referenced by this library
• Library.content [0..*]: Attachment Contents of the library, either embedded or referenced

Mappings

• Library Mappings — 54 mapping entries

Operations

• data-requirements — Data Requirements — The data-requirements operation aggregates and returns the parameters and data requirements for a resource and all its dependencies as a single module definition

Full Operations

Resource Packs

list-Library-packs.xml

<?xml version="1.0" encoding="UTF-8"?>

<List xmlns="http://hl7.org/fhir">
  <id value="Library-packs"/>
  <status value="current"/>
  <mode value="working"/>
</List>

Search Parameters

• 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 — Jurisdiction of the authority that maintains the 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
• subject-code — token — The subject of the Library when expressed as a code — Library.subject as CodeableConcept
• subject-reference — reference — The subject of the Library when expressed as a reference — Library.subject as Reference
• subject-canonical — reference — The subject of the Library when expressed as a canonical — Library.subject as canonical
• 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
• experimental — token — Whether the Library is experimental — Library.experimental

Full Search Parameters

Examples

• composition-example — library-composition-example — Zika Virus Management Library
• example — library-example — Chlamydia Screening Common Library
• ExampleEventDefinitionLogic — library-ExampleEventDefinitionLogic — Example EventDefinition Logic
• hiv-indicators — library-hiv-indicators — HIV Indicators Reporting Example
• library-cms146-example — library-cms146-example — CMS146 Measure Logic
• library-example — library-example
• library-examples-header — library-examples-header
• library-exclusive-breastfeeding-cds-logic — library-exclusive-breastfeeding-cds-logic — Exclusive Breastfeeding Intervention Logic
• library-exclusive-breastfeeding-cqm-logic — library-exclusive-breastfeeding-cqm-logic — Exclusive Breastfeeding Measurement Logic
• library-fhir-helpers — library-fhir-helpers — FHIR Helpers
• library-fhir-helpers-predecessor — library-predecessor-example — Predecessor library example
• library-fhir-model-definition — library-fhir-model-definition — FHIR Model Definition
• library-quick-model-definition — library-quick-model-definition — QUICK Model Definition
• omtk-logic — library-omtk-logic — OMTK Logic
• omtk-modelinfo — library-omtk-modelinfo — OMTK Model
• opioidcds-common — library-opioidcds-common — Opioid CDS Common Library
• opioidcds-recommendation-04 — library-opioidcds-recommendation-04 — Opioid CDS Recommendation 4 Logic
• opioidcds-recommendation-05 — library-opioidcds-recommendation-05 — Opioid CDS Recommendation 5 Logic
• opioidcds-recommendation-07 — library-opioidcds-recommendation-07 — Opioid CDS Recommendation 7 Logic
• opioidcds-recommendation-08 — library-opioidcds-recommendation-08 — Opioid CDS Recommendation 8 Logic
• opioidcds-recommendation-10 — library-opioidcds-recommendation-10 — Opioid CDS Recommendation 10 Logic
• opioidcds-recommendation-11 — library-opioidcds-recommendation-11 — Opioid CDS Recommendation 11 Logic
• suiciderisk-orderset-logic — library-mmi-suiciderisk-orderset-logic — Suicide Risk Order Set Logic
• zika-virus-intervention-logic — library-zika-virus-intervention-logic — Zika Virus Management Intervention Logic

Full Examples

Mapping Exceptions

library-definition-mapping-exceptions.xml

Divergent Elements

• Definition.version → Library.version
  • commentsUnmatched | reason=Unknown | pattern=There may be different librarys that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format. The version SHOULD NOT contain a '#' - see Business Version. | resource=There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.
• Definition.copyright → Library.copyright
  • requirementsUnmatched | reason=Unknown | pattern=Consumers of the library must be able to determine any legal restrictions on the use of the artifact and/or its content. | resource=Consumers must be able to determine any legal restrictions on the use of the library and/or its content.

Unmapped Elements

• Definition — Unknown
• Definition.subject — Unknown
• Definition.versionAlgorithm — Unknown

library-fivews-mapping-exceptions.xml

Unmapped Elements

• FiveWs.author — Unknown
• FiveWs.actor — Unknown
• FiveWs.cause — Unknown
• FiveWs.where — Unknown
• FiveWs.context — Unknown
• FiveWs.init — Unknown
• FiveWs.source — Unknown
• FiveWs.who — Unknown
• FiveWs.grade — Unknown
• FiveWs.planned — Unknown
• FiveWs.done — Unknown
• FiveWs.subject — Unknown