The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose exist knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

An absolute URL that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see Technical and Business Versions.

Allows the library to be referenced by a single globally unique identifier.

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.

A 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.

Allows externally provided and/or useable business identifiers to be easily associated with the module.

Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this library outside of FHIR, where the logical URL is not possible to use.

The 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 are orderable. 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 multiple different instances of a library that have the same identifier but different versions.

A 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.

Support human navigation & code generation.

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.

A short, descriptive, user-friendly title for the library.

Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

The status of this library. Enables tracking the life-cycle of the content.

Allows filtering of library that are appropriate for use vs. not.

A flag to indicate that this library is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Enables experimental content to be developed following the same life-cycle as a production-level library would.

Allows filtering of library that are appropriate for use vs. not.

The date (and optionally time) when the library was published. The date must change when the business version changes, if it does, 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.

A free text natural language description of the library from the 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 module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.

Explains why this library is needed and why it has been designed as it has.

This element does not describe the usage of the library (See, e.g, the comments element, or relatedArtifacts), rather it's for 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.

A detailed description of how the library is used from a clinical perspective.

The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

The date may be more recent than the approval date because of minor changes / editorial corrections.

The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

If specified, this is usually after the approval date.

The period during which the library content was or is planned to be effective.

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 would be published in 2015.

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.

Assist in searching for appropriate content.

When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

A jurisdiction in which the library is intended to be used.

Clinical topics related to the content of the library.

Repositories must be able to determine how to categorize the library so that it can be found by topical searches.

A contributor to the content of the library, including authors, editors, reviewers, and endorsers.

Consumers of the content must be able to quickly determine who contributed to the content of the library.

The name of the individual or organization that published the library.

Helps establish the "authority/credibility" of the library. May also allow for contact.

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 details to assist a user in finding and communicating with the publisher.

May be a web site, an email address, a telephone number, etc.

A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

Consumers of the library must be able to determine any legal restrictions on the use of the library and/or its content.

Related artifacts such as additional documentation, justification, or bibliographic references.

Libraries must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Each related artifact is either an attachment, or a reference to another resource, but not both.

The parameter element defines parameters used by the library.

Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

The 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.