FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 R4 R3

14.1 14.11 Resource Library - Content

Clinical Decision Support Work Group Maturity Level : 2   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

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.

14.1.1 14.11.1 Scope and Usage

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.

14.1.2 14.11.2 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, and the Media and Binary resources which capture multimedia content and raw binary content, respectively.

This resource is referenced by ActivityDefinition , Measure , PlanDefinition , ResearchDefinition and PlanDefinition ResearchElementDefinition

14.1.3 14.11.3 Resource Content

Structure

Logical URI to reference When the library was approved by publisher Σ Σ Intended jurisdiction for library (if applicable) A markdown Use and/or publishing restrictions
Name Flags Card. Type Description & Constraints doco
. . Library I TU DomainResource Represents a library of quality improvement components
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . url Σ 0..1 uri Canonical identifier for this library library, represented as a URI (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the library
. . . version Σ 0..1 string Business version of the library
. . . name Σ I 0..1 string Name for this library (computer friendly)
. . . title Σ 0..1 string Name for this library (human friendly)
. . . subtitle 0..1 string Subordinate title of the library
... status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
LibraryType ( Extensible )
. . date . subject[x] Σ 0..1 Type of individual the library content is focused on
Subject type ( Extensible )
.... subjectCodeableConcept CodeableConcept
.... subjectReference 0..1 Reference ( Group )
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description Σ 0..1 markdown Natural language description of the library
. . . useContext Σ 0..* UsageContext The context that the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Jurisdiction ( Extensible )
... purpose 0..1 markdown Why this library is defined
. . . usage 0..1 string Describes the clinical usage of the library
. . approvalDate . copyright 0..1 date markdown Use and/or publishing restrictions
. . . lastReviewDate approvalDate 0..1 date When the library was last reviewed approved by publisher
. . effectivePeriod . lastReviewDate 0..1 Period date When the library is expected to be used was last reviewed
. . . useContext effectivePeriod Σ 0..* 0..1 UsageContext Period Context When the content library is intended expected to support be used
. . jurisdiction . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Jurisdiction ValueSet DefinitionTopic ( Extensible Example )
. . . topic author 0..* CodeableConcept ContactDetail E.g. Education, Treatment, Assessment, etc DefinitionTopic ( Example ) Who authored the content
. . contributor . editor 0..* Contributor ContactDetail Who edited the content contributor
. . . contact reviewer Σ 0..* ContactDetail Contact details for Who reviewed the publisher content
. . copyright . endorser 0..1 0..* ContactDetail Who endorsed the content
. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
. . . parameter 0..* ParameterDefinition Parameters defined by the library
. . . dataRequirement 0..* DataRequirement What data is referenced by this library
. . . content Σ 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

UML Diagram ( Legend )

Library ( DomainResource ) An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance. instance; also called its canonical identifier. This SHALL be a URL, SHOULD be globally unique, unique and SHOULD be an a literal address at which at which an authoritative instance of this library is (or will be) published. The This URL SHOULD include can be the major version target of a canonical reference. It SHALL remain the library. For more information see [Technical and Business Versions](resource.html#versions) same when the library is stored on different servers url : uri [0..1] 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 identifier : Identifier [0..*] 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 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 version : string [0..1] 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 name : string [0..1] A short, descriptive, user-friendly title for the library title : string [0..1] An explanatory or alternate title for the library giving additional information about its content subtitle : string [0..1] The status of this library. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of a Value Set or Concept Map. an artifact. (Strength=Required) PublicationStatus ! » A boolean Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing), education/evaluation/marketing) and is not intended to be used for genuine usage (this element modifies the meaning of other elements) experimental : boolean [0..1] Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition type : CodeableConcept [1..1] « The type of knowledge asset this library contains contains. (Strength=Extensible) LibraryType + » A code or group definition that describes the intended subject of the contents of the library subject[x] : Type [0..1] « CodeableConcept | Reference ( Group ); The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType + » The date (and optionally time) when the library was published. The date must change if and 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 date : dateTime [0..1] The name of the individual or organization or individual that published the library publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the library from a consumer's perspective description : markdown [0..1] Explaination The 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 useContext : UsageContext [0..*] A legal or geographic region in which the library is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible) Jurisdiction ValueSet + » Explanation of why this library is needed and why it has been designed as it has purpose : markdown [0..1] A detailed description of how the library is used from a clinical perspective usage : string [0..1] 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 copyright : markdown [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval, approval but doesn't does not change the original approval date lastReviewDate : date [0..1] The period during which the library content was or is planned to be in active use effectivePeriod : Period [0..1] 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 for appropriate library instances useContext : UsageContext [0..*] A legal or geographic region in which the library is intended to be used jurisdiction : CodeableConcept [0..*] Countries and regions within which this artifact is targeted for use (Strength=Extensible) Jurisdiction ValueSet + Descriptive 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 topic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering filtering. (Strength=Example) DefinitionTopic ?? » A contributor to An individiual or organization primarily involved in the content creation and maintenance of the library, including authors, editors, reviewers, and endorsers content contributor author : Contributor ContactDetail [0..*] Contact details to assist a user in finding and communicating with An individual or organization primarily responsible for internal coherence of the publisher content contact editor : ContactDetail [0..*] A copyright statement relating to An individual or organization primarily responsible for review of some aspect of the library and/or its contents. Copyright statements are generally legal restrictions on content reviewer : ContactDetail [0..*] An individual or organization responsible for officially endorsing the content for use and publishing of the library in some setting copyright endorser : markdown ContactDetail [0..1] [0..*] Related artifacts such as additional documentation, justification, or bibliographic references relatedArtifact : RelatedArtifact [0..*] The parameter element defines parameters used by the library parameter : ParameterDefinition [0..*] Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library dataRequirement : DataRequirement [0..*] 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 content : Attachment [0..*]

XML Template 

<

<Library xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <

 <url value="[uri]"/><!-- 0..1 Canonical identifier for this library, represented as a URI (globally unique) -->

 <identifier><!-- 0..* Identifier Additional identifier for the library --></identifier>
 <
 <
 <
 <
 <

 <version value="[string]"/><!-- 0..1 Business version of the library -->
 <name value="[string]"/><!-- ?? 0..1 Name for this library (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this library (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the library -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->

 <type><!-- 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type>
 <
 <
 <
 <
 <
 <
 <
 <</effectivePeriod>
 <</useContext>
 <</jurisdiction>
 <</topic>
 <</contributor>

 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->

 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <

 <description value="[markdown]"/><!-- 0..1 Natural language description of the library -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this library is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the library -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the library was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the library was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the library is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>

 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <parameter><!-- 0..* ParameterDefinition Parameters defined by the library --></parameter>
 <dataRequirement><!-- 0..* DataRequirement What data is referenced by this library --></dataRequirement>
 <content><!-- 0..* Attachment Contents of the library, either embedded or referenced --></content>
</Library>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "Library",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "

  "url" : "<uri>", // Canonical identifier for this library, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the library
  "version" : "<string>", // Business version of the library
  "name" : "<string>", // C? Name for this library (computer friendly)
  "title" : "<string>", // Name for this library (human friendly)
  "subtitle" : "<string>", // Subordinate title of the library
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "type" : { CodeableConcept }, // R!  logic-library | model-definition | asset-collection | module-definition
  // subject[x]: Type of individual the library content is focused on. One of these 2:

  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the library
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for library (if applicable)
  "purpose" : "<markdown>", // Why this library is defined
  "usage" : "<string>", // Describes the clinical usage of the library
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the library was approved by publisher
  "lastReviewDate" : "<date>", // When the library was last reviewed
  "effectivePeriod" : { Period }, // When the library is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "parameter" : [{ ParameterDefinition }], // Parameters defined by the library
  "dataRequirement" : [{ DataRequirement }], // What data is referenced by this library
  "content" : [{ Attachment }] // Contents of the library, either embedded or referenced

}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Library;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:

  fhir:Library.url [ uri ]; # 0..1 Canonical identifier for this library, represented as a URI (globally unique)

  fhir:Library.identifier [ Identifier ], ... ; # 0..* Additional identifier for the library
  fhir:Library.version [ string ]; # 0..1 Business version of the library
  fhir:Library.name [ string ]; # 0..1 Name for this library (computer friendly)
  fhir:Library.title [ string ]; # 0..1 Name for this library (human friendly)
  fhir:Library.subtitle [ string ]; # 0..1 Subordinate title of the library

  fhir:Library.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:

  fhir:Library.experimental [ boolean ]; # 0..1 For testing purposes, not real usage

  fhir:Library.type [ CodeableConcept ]; # 1..1 logic-library | model-definition | asset-collection | module-definition
  fhir:
  fhir:

  # Library.subject[x] : 0..1 Type of individual the library content is focused on. One of these 2
    fhir:Library.subjectCodeableConcept [ CodeableConcept ]
    fhir:Library.subjectReference [ Reference(Group) ]
  fhir:Library.date [ dateTime ]; # 0..1 Date last changed
  fhir:Library.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:Library.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher

  fhir:Library.description [ markdown ]; # 0..1 Natural language description of the library
  fhir:

  fhir:Library.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:Library.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for library (if applicable)
  fhir:Library.purpose [ markdown ]; # 0..1 Why this library is defined

  fhir:Library.usage [ string ]; # 0..1 Describes the clinical usage of the library
  fhir:Library.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions

  fhir:Library.approvalDate [ date ]; # 0..1 When the library was approved by publisher
  fhir:

  fhir:Library.lastReviewDate [ date ]; # 0..1 When the library was last reviewed

  fhir:Library.effectivePeriod [ Period ]; # 0..1 When the library is expected to be used
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  fhir:Library.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:Library.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:Library.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:Library.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:Library.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content

  fhir:Library.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:Library.parameter [ ParameterDefinition ], ... ; # 0..* Parameters defined by the library
  fhir:Library.dataRequirement [ DataRequirement ], ... ; # 0..* What data is referenced by this library
  fhir:Library.content [ Attachment ], ... ; # 0..* Contents of the library, either embedded or referenced
]

Changes since DSTU2 R3

Library
Library.subtitle
  • Added Element
Library.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status to http://hl7.org/fhir/ValueSet/publication-status|4.0.1
Library.experimental
  • No longer marked as Modifier
Library.type
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/library-type" to "http://terminology.hl7.org/CodeSystem/library-type"
Library.subject[x]
  • Added Element
Library.author
  • Added Element
Library.editor
  • Added Element
Library.reviewer
  • Added Element
Library.endorser
  • Added Element
Library.contributor
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = 11 tests that all execute ok. All tests pass round-trip testing and 11 r3 resources are invalid (0 errors). )

Structure

Logical URI to reference When the library was approved by publisher Σ Σ Intended jurisdiction for library (if applicable) A markdown Use and/or publishing restrictions
Name Flags Card. Type Description & Constraints doco
. . Library I TU DomainResource Represents a library of quality improvement components
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . url Σ 0..1 uri Canonical identifier for this library library, represented as a URI (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the library
. . . version Σ 0..1 string Business version of the library
. . . name Σ I 0..1 string Name for this library (computer friendly)
. . . title Σ 0..1 string Name for this library (human friendly)
. . . subtitle 0..1 string Subordinate title of the library
... status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
LibraryType ( Extensible )
. . date . subject[x] Σ 0..1 Type of individual the library content is focused on
Subject type ( Extensible )
.... subjectCodeableConcept CodeableConcept
.... subjectReference 0..1 Reference ( Group )
... date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description Σ 0..1 markdown Natural language description of the library
. . . useContext Σ 0..* UsageContext The context that the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Jurisdiction ( Extensible )
... purpose 0..1 markdown Why this library is defined
. . . usage 0..1 string Describes the clinical usage of the library
. . approvalDate . copyright 0..1 date markdown Use and/or publishing restrictions
. . . lastReviewDate approvalDate 0..1 date When the library was last reviewed approved by publisher
. . effectivePeriod . lastReviewDate 0..1 Period date When the library is expected to be used was last reviewed
. . . useContext effectivePeriod Σ 0..* 0..1 UsageContext Period Context When the content library is intended expected to support be used
. . jurisdiction . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Jurisdiction ValueSet DefinitionTopic ( Extensible Example )
. . . topic author 0..* CodeableConcept ContactDetail E.g. Education, Treatment, Assessment, etc DefinitionTopic ( Example ) Who authored the content
. . contributor . editor 0..* Contributor ContactDetail Who edited the content contributor
. . . contact reviewer Σ 0..* ContactDetail Contact details for Who reviewed the publisher content
. . copyright . endorser 0..1 0..* ContactDetail Who endorsed the content
. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
. . . parameter 0..* ParameterDefinition Parameters defined by the library
. . . dataRequirement 0..* DataRequirement What data is referenced by this library
. . . content Σ 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

UML Diagram ( Legend )

Library ( DomainResource ) An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance. instance; also called its canonical identifier. This SHALL be a URL, SHOULD be globally unique, unique and SHOULD be an a literal address at which at which an authoritative instance of this library is (or will be) published. The This URL SHOULD include can be the major version target of a canonical reference. It SHALL remain the library. For more information see [Technical and Business Versions](resource.html#versions) same when the library is stored on different servers url : uri [0..1] 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 identifier : Identifier [0..*] 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 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 version : string [0..1] 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 name : string [0..1] A short, descriptive, user-friendly title for the library title : string [0..1] An explanatory or alternate title for the library giving additional information about its content subtitle : string [0..1] The status of this library. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of a Value Set or Concept Map. an artifact. (Strength=Required) PublicationStatus ! » A boolean Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing), education/evaluation/marketing) and is not intended to be used for genuine usage (this element modifies the meaning of other elements) experimental : boolean [0..1] Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition type : CodeableConcept [1..1] « The type of knowledge asset this library contains contains. (Strength=Extensible) LibraryType + » A code or group definition that describes the intended subject of the contents of the library subject[x] : Type [0..1] « CodeableConcept | Reference ( Group ); The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType + » The date (and optionally time) when the library was published. The date must change if and 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 date : dateTime [0..1] The name of the individual or organization or individual that published the library publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the library from a consumer's perspective description : markdown [0..1] Explaination The 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 useContext : UsageContext [0..*] A legal or geographic region in which the library is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible) Jurisdiction ValueSet + » Explanation of why this library is needed and why it has been designed as it has purpose : markdown [0..1] A detailed description of how the library is used from a clinical perspective usage : string [0..1] 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 copyright : markdown [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval, approval but doesn't does not change the original approval date lastReviewDate : date [0..1] The period during which the library content was or is planned to be in active use effectivePeriod : Period [0..1] 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 for appropriate library instances useContext : UsageContext [0..*] A legal or geographic region in which the library is intended to be used jurisdiction : CodeableConcept [0..*] Countries and regions within which this artifact is targeted for use (Strength=Extensible) Jurisdiction ValueSet + Descriptive 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 topic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering filtering. (Strength=Example) DefinitionTopic ?? » A contributor to An individiual or organization primarily involved in the content creation and maintenance of the library, including authors, editors, reviewers, and endorsers content contributor author : Contributor ContactDetail [0..*] Contact details to assist a user in finding and communicating with An individual or organization primarily responsible for internal coherence of the publisher content contact editor : ContactDetail [0..*] A copyright statement relating to An individual or organization primarily responsible for review of some aspect of the library and/or its contents. Copyright statements are generally legal restrictions on content reviewer : ContactDetail [0..*] An individual or organization responsible for officially endorsing the content for use and publishing of the library in some setting copyright endorser : markdown ContactDetail [0..1] [0..*] Related artifacts such as additional documentation, justification, or bibliographic references relatedArtifact : RelatedArtifact [0..*] The parameter element defines parameters used by the library parameter : ParameterDefinition [0..*] Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library dataRequirement : DataRequirement [0..*] 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 content : Attachment [0..*]

XML Template 

<

<Library xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <

 <url value="[uri]"/><!-- 0..1 Canonical identifier for this library, represented as a URI (globally unique) -->

 <identifier><!-- 0..* Identifier Additional identifier for the library --></identifier>
 <
 <
 <
 <
 <

 <version value="[string]"/><!-- 0..1 Business version of the library -->
 <name value="[string]"/><!-- ?? 0..1 Name for this library (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this library (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the library -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->

 <type><!-- 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type>
 <
 <
 <
 <
 <
 <
 <
 <</effectivePeriod>
 <</useContext>
 <</jurisdiction>
 <</topic>
 <</contributor>

 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->

 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <

 <description value="[markdown]"/><!-- 0..1 Natural language description of the library -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this library is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the library -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the library was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the library was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the library is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>

 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <parameter><!-- 0..* ParameterDefinition Parameters defined by the library --></parameter>
 <dataRequirement><!-- 0..* DataRequirement What data is referenced by this library --></dataRequirement>
 <content><!-- 0..* Attachment Contents of the library, either embedded or referenced --></content>
</Library>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "Library",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "

  "url" : "<uri>", // Canonical identifier for this library, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the library
  "version" : "<string>", // Business version of the library
  "name" : "<string>", // C? Name for this library (computer friendly)
  "title" : "<string>", // Name for this library (human friendly)
  "subtitle" : "<string>", // Subordinate title of the library
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "type" : { CodeableConcept }, // R!  logic-library | model-definition | asset-collection | module-definition
  // subject[x]: Type of individual the library content is focused on. One of these 2:

  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the library
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for library (if applicable)
  "purpose" : "<markdown>", // Why this library is defined
  "usage" : "<string>", // Describes the clinical usage of the library
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the library was approved by publisher
  "lastReviewDate" : "<date>", // When the library was last reviewed
  "effectivePeriod" : { Period }, // When the library is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "parameter" : [{ ParameterDefinition }], // Parameters defined by the library
  "dataRequirement" : [{ DataRequirement }], // What data is referenced by this library
  "content" : [{ Attachment }] // Contents of the library, either embedded or referenced

}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Library;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:

  fhir:Library.url [ uri ]; # 0..1 Canonical identifier for this library, represented as a URI (globally unique)

  fhir:Library.identifier [ Identifier ], ... ; # 0..* Additional identifier for the library
  fhir:Library.version [ string ]; # 0..1 Business version of the library
  fhir:Library.name [ string ]; # 0..1 Name for this library (computer friendly)
  fhir:Library.title [ string ]; # 0..1 Name for this library (human friendly)
  fhir:Library.subtitle [ string ]; # 0..1 Subordinate title of the library

  fhir:Library.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:

  fhir:Library.experimental [ boolean ]; # 0..1 For testing purposes, not real usage

  fhir:Library.type [ CodeableConcept ]; # 1..1 logic-library | model-definition | asset-collection | module-definition
  fhir:
  fhir:

  # Library.subject[x] : 0..1 Type of individual the library content is focused on. One of these 2
    fhir:Library.subjectCodeableConcept [ CodeableConcept ]
    fhir:Library.subjectReference [ Reference(Group) ]
  fhir:Library.date [ dateTime ]; # 0..1 Date last changed
  fhir:Library.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:Library.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher

  fhir:Library.description [ markdown ]; # 0..1 Natural language description of the library
  fhir:

  fhir:Library.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:Library.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for library (if applicable)
  fhir:Library.purpose [ markdown ]; # 0..1 Why this library is defined

  fhir:Library.usage [ string ]; # 0..1 Describes the clinical usage of the library
  fhir:Library.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions

  fhir:Library.approvalDate [ date ]; # 0..1 When the library was approved by publisher
  fhir:

  fhir:Library.lastReviewDate [ date ]; # 0..1 When the library was last reviewed

  fhir:Library.effectivePeriod [ Period ]; # 0..1 When the library is expected to be used
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  fhir:Library.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:Library.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:Library.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:Library.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:Library.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content

  fhir:Library.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:Library.parameter [ ParameterDefinition ], ... ; # 0..* Parameters defined by the library
  fhir:Library.dataRequirement [ DataRequirement ], ... ; # 0..* What data is referenced by this library
  fhir:Library.content [ Attachment ], ... ; # 0..* Contents of the library, either embedded or referenced
]

Changes since DSTU2 Release 3

Library
Library.subtitle
  • Added Element
Library.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status to http://hl7.org/fhir/ValueSet/publication-status|4.0.1
Library.experimental
  • No longer marked as Modifier
Library.type
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/library-type" to "http://terminology.hl7.org/CodeSystem/library-type"
Library.subject[x]
  • Added Element
Library.author
  • Added Element
Library.editor
  • Added Element
Library.reviewer
  • Added Element
Library.endorser
  • Added Element
Library.contributor
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = 11 tests that all execute ok. All tests pass round-trip testing and 11 r3 resources are invalid (0 errors). )

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

14.1.3.1 14.11.3.1 Terminology Bindings

Path Definition Type Reference
Library.status The lifecycle status of a Value Set or Concept Map. an artifact. Required PublicationStatus
Library.type The type of knowledge asset this library contains contains. Extensible LibraryType
Library.subject[x] The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). Extensible SubjectType
Library.jurisdiction Countries and regions within which this artifact is targeted for use use. Extensible Jurisdiction ValueSet
Library.topic High-level categorization of the definition, used for searching, sorting, and filtering filtering. Example DefinitionTopic

14.11.3.2 Constraints

id Level Location Description Expression
lib-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

14.1.4 14.11.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
composed-of reference What resource is being referenced Library.relatedArtifact.where(type='composed-of').resource
(Any)
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
context-type-quantity composite A use context type and quantity- or range-based value assigned to the library On Library.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-value composite A use context type and value assigned to the library On Library.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date date The library publication date Library.date
depends-on reference What resource is being referenced Library.relatedArtifact.where(type='depends-on').resource
(Any)
derived-from reference What resource is being referenced Library.relatedArtifact.where(type='derived-from').resource
(Any)
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
(Any)
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
(Any)
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