Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). 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

4.16 Resource Library - Content

Clinical Decision Support

Work Group

Maturity Level: 0

Compartments: Not linked to any defined compartments

The Library resource provides a representation container for knowledge artifact component definitions. It is effectively an exposure of the header information for a CQL/ELM library.

4.16.1 Scope and Usage

This resource is a draft proposal for use as part of an approach to Clinical Quality within FHIR, and is documented as part of the Clinical Quality Improvement Framework Implementation Guide. Future updates to this resource will incorporate documentation from that guide.

This resource is referenced by DecisionSupportRule, Measure and OrderSet

Structure

Name	Flags	Card.	Type	Description & Constraints
Library			DomainResource	Represents a library of quality improvement components
identifier	Σ	0..*	Identifier	Logical identifier
version	Σ	0..1	string	The version of the module, if any
moduleMetadata		0..1	Reference(ModuleMetadata)	The metadata information for the library
moduleDefinition		1..1	Reference(ModuleDefinition)	The header information for the library
document		1..1	Attachment	The content of the library
Documentation for this format

UML Diagram

XML Template

<Library xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Logical identifier --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <moduleMetadata><!-- 0..1 Reference(ModuleMetadata) The metadata information for the library --></moduleMetadata>
 <moduleDefinition><!-- 1..1 Reference(ModuleDefinition) The header information for the library --></moduleDefinition>
 <document><!-- 1..1 Attachment The content of the library --></document>
</Library>

JSON Template

{
  "resourceType" : "Library",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Logical identifier
  "version" : "<string>", // The version of the module, if any
  "moduleMetadata" : { Reference(ModuleMetadata) }, // The metadata information for the library
  "moduleDefinition" : { Reference(ModuleDefinition) }, // R!  The header information for the library
  "document" : { Attachment } // R!  The content of the library
}

Structure

Name	Flags	Card.	Type	Description & Constraints
Library			DomainResource	Represents a library of quality improvement components
identifier	Σ	0..*	Identifier	Logical identifier
version	Σ	0..1	string	The version of the module, if any
moduleMetadata		0..1	Reference(ModuleMetadata)	The metadata information for the library
moduleDefinition		1..1	Reference(ModuleDefinition)	The header information for the library
document		1..1	Attachment	The content of the library
Documentation for this format

UML Diagram

XML Template

<Library xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Logical identifier --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <moduleMetadata><!-- 0..1 Reference(ModuleMetadata) The metadata information for the library --></moduleMetadata>
 <moduleDefinition><!-- 1..1 Reference(ModuleDefinition) The header information for the library --></moduleDefinition>
 <document><!-- 1..1 Attachment The content of the library --></document>
</Library>

JSON Template

{
  "resourceType" : "Library",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Logical identifier
  "version" : "<string>", // The version of the module, if any
  "moduleMetadata" : { Reference(ModuleMetadata) }, // The metadata information for the library
  "moduleDefinition" : { Reference(ModuleDefinition) }, // R!  The header information for the library
  "document" : { Attachment } // R!  The content of the library
}

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire