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.
- Schema
- Usage
- Relationships
- Referenced By
Elements
| Name | Required | Type | Description |
|---|---|---|---|
| url | uri | Canonical identifier for this library, represented as a URI (globally unique) DetailsAn absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found. | |
| identifier | Identifier[] | Additional identifier for the library DetailsA formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI. | |
| version | string | Business version of the library DetailsThe identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. 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]. | |
| name | string | Name for this library (computer friendly) DetailsA natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | |
| title | string | Name for this library (human friendly) DetailsA short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | |
| subtitle | string | Subordinate title of the library DetailsAn explanatory or alternate title for the library giving additional information about its content. | |
| status | ✓ | code | draft | active | retired | unknown DetailsThe status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not. |
| experimental | boolean | For testing purposes, not real usage DetailsA Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of librarys that are appropriate for use versus not. | |
| type | ✓ | CodeableConcept | logic-library | model-definition | asset-collection | module-definition DetailsIdentifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. |
| subject[x] | CodeableConcept, Reference<Group> | Type of individual the library content is focused on DetailsA code or group definition that describes the intended subject of the contents of the library. | |
| date | dateTime | Date last changed DetailsThe date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | |
| publisher | string | Name of the publisher (organization or individual) DetailsThe name of the organization or individual that published the library. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context. | |
| contact | ContactDetail[] | Contact details for the publisher DetailsContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. | |
| description | markdown | Natural language description of the library DetailsA free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created). | |
| useContext | UsageContext[] | The context that the content is intended to support DetailsThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | |
| jurisdiction | CodeableConcept[] | Intended jurisdiction for library (if applicable) DetailsA legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended. | |
| purpose | markdown | Why this library is defined DetailsExplanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library. | |
| usage | string | Describes the clinical usage of the library DetailsA detailed description of how the library is used from a clinical perspective. | |
| copyright | markdown | Use and/or publishing restrictions DetailsA copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. | |
| approvalDate | date | When the library was approved by publisher DetailsThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. | |
| lastReviewDate | date | When the library was last reviewed DetailsThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date. | |
| effectivePeriod | Period | When the library is expected to be used DetailsThe period during which the library content was or is planned to be in active use. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. | |
| topic | CodeableConcept[] | E.g. Education, Treatment, Assessment, etc. DetailsDescriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. | |
| author | ContactDetail[] | Who authored the content DetailsAn individiual or organization primarily involved in the creation and maintenance of the content. | |
| editor | ContactDetail[] | Who edited the content DetailsAn individual or organization primarily responsible for internal coherence of the content. | |
| reviewer | ContactDetail[] | Who reviewed the content DetailsAn individual or organization primarily responsible for review of some aspect of the content. | |
| endorser | ContactDetail[] | Who endorsed the content DetailsAn individual or organization responsible for officially endorsing the content for use in some setting. | |
| relatedArtifact | RelatedArtifact[] | Additional documentation, citations, etc. DetailsRelated artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both. | |
| parameter | ParameterDefinition[] | Parameters defined by the library DetailsThe parameter element defines parameters used by the library. | |
| dataRequirement | DataRequirement[] | What data is referenced by this library DetailsDescribes a set of data that must be provided in order to be able to successfully perform the computations defined by the library. | |
| content | Attachment[] | Contents of the library, either embedded or referenced DetailsThe content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| 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 as CodeableConcept |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the library | Library.useContext.value as Quantity | Library.useContext.value as Range |
| 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.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 |
| 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 Elements
| Name | Required | Type | Description |
|---|---|---|---|
| id | string | Logical id of this artifact DetailsThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |
| meta | Meta | Metadata about the resource DetailsThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
| implicitRules | uri | A set of rules under which this content was created DetailsA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | |
| language | code | Language of the resource content DetailsThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | |
| text | Narrative | Text summary of the resource, for human interpretation DetailsA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | |
| contained | Resource[] | Contained, inline Resources DetailsThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | |
| extension | Extension[] | Additional content defined by implementations DetailsMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |
| modifierExtension | Extension[] | Extensions that cannot be ignored DetailsMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
The Library resource is a general purpose container for clinical knowledge assets. These assets may be defined using a non-FHIR representation, such as a shareable library of clinical logic, written in Clinical Quality Language (CQL), or the XML Schema for an information model, or they may be defined using FHIR resources such as the description of a protocol represented by a PlanDefinition resource. In addition to representing the metadata of the library, 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.
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, and the Media and Binary resources which capture multimedia content and raw binary content, respectively.