STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

14.3.6 Resource Library - Detailed Descriptions

Detailed Descriptions for the elements in the Library resource.

Library
Definition

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.

Control1..1
Library.url
Definition

An absolute URL that is used to identify this library when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published.

Control0..1
Typeuri
Requirements

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

Summarytrue
Library.identifier
Definition

A logical identifier for the library such as the CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows external business identifiers to be easily associated with the library.

Summarytrue
To DoAdd constraint to require an identifier for non-experimental active artifacts.
Library.version
Definition

The version of the library, if any. 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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Requirements

Allows for versioning of the content of the library.

Summarytrue
To DoAdd constraint to require a version for non-experimental active artifacts.
Library.name
Definition

A machine-friendly name for the library. This name should be usable as an identifier for the library by machine processing applications such as code generation.

Control0..1
Typestring
Requirements

Simplifies machine-processing tasks related to the library such as code-generation or logging.

Summarytrue
Comments

This identifier for the library should be unique within the intended scope of use, and should conform to the traditional syntactic definition of an identifier within most programming languages. regex: ([A-Za-z][A-Za-z0-9]*).

Library.title
Definition

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

Control0..1
Typestring
Summarytrue
Library.type
Definition

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

Control1..1
BindingLibraryType: The type of knowledge asset this library contains (Extensible)
TypeCodeableConcept
Is Modifiertrue
Summarytrue
Library.status
Definition

The status of the library.

Control1..1
BindingLibraryStatus: The status of the knowledge asset (Required)
Typecode
Is Modifiertrue
Requirements

Enables tracking the life-cycle of the content of the library.

Summarytrue
Library.experimental
Definition

Determines whether the library was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.

Control0..1
Typeboolean
Is Modifiertrue
Requirements

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

Summarytrue
Library.description
Definition

A free text natural language description of the library from the consumer's perspective.

Control0..1
Typestring
Comments

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.

Library.purpose
Definition

A brief description of the purpose of the library.

Control0..1
Typestring
Comments

This description should address the question of why this library was built, though not necessarily in as much detail as the justification, rationale, or clinical recommendation statement of a measure would. That information would typically be provided in the related resource element.

Library.usage
Definition

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

Control0..1
Typestring
Library.publicationDate
Definition

The date on which the library was published.

Control0..1
Typedate
Library.lastReviewDate
Definition

The date on which the library content was last reviewed.

Control0..1
Typedate
Library.effectivePeriod
Definition

The period during which the library content is effective.

Control0..1
TypePeriod
Comments

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.

Library.coverage
Definition

Specifies various attributes of the patient population for whom and/or environment of care in which, the library is applicable.

Control0..*
TypeUsageContext
Requirements

Consumers of the library must be able to determine the intended applicability for the library. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed.

Library.topic
Definition

Clinical topics related to the content of the library.

Control0..*
TypeCodeableConcept
Requirements

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

Library.contributor
Definition

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

Control0..*
TypeContributor
Requirements

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

Library.publisher
Definition

The name of the individual or organization that published the library (also known as the steward for the library). This information is required for non-experimental active artifacts.

Control0..1
Typestring
Requirements

Consumers of the library must be able to determine where to obtain support in the use of this library, as well as where to direct questions and concerns about the content.

Comments

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 organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library.

To DoAdd constraint to require a publisher for non-experimental active artifacts.
Library.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactDetail
Library.copyright
Definition

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.

Control0..1
Typestring
Requirements

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

Library.relatedResource
Definition

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

Control0..*
TypeRelatedResource
Requirements

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.

Comments

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

Library.parameter
Definition

The parameter element defines parameters used by the library.

Control0..*
TypeParameterDefinition
Library.dataRequirement
Definition

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

Control0..*
TypeDataRequirement
Library.content
Definition

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.

Control1..1
TypeAttachment