Current Build

14.2 Resource Library - Content

Clinical Decision Support Work GroupMaturity Level: 2 Trial UseCompartments: 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.

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.

This resource is referenced by ActivityDefinition, Measure and PlanDefinition

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library DomainResourceRepresents a library of quality improvement components
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriLogical URI to reference this library (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the library
... version Σ0..1stringBusiness version of the library
... name Σ0..1stringName for this library (computer friendly)
... title Σ0..1stringName for this library (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
LibraryType (Extensible)
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description Σ0..1markdownNatural language description of the library
... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Jurisdiction ValueSet (Extensible)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
DefinitionTopic (Example)
... contributor 0..*ContributorA content contributor
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content 0..*AttachmentContents 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. 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](resource.html#versions)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 artifactsidentifier : 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 artifactsversion : 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 generationname : string [0..1]A short, descriptive, user-friendly title for the librarytitle : 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. (Strength=Required)PublicationStatus! »A 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 (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 Definitiontype : CodeableConcept [1..1] « The type of knowledge asset this library contains (Strength=Extensible)LibraryType+ »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 changesdate : dateTime [0..1]The name of the individual or organization that published the librarypublisher : string [0..1]A free text natural language description of the library from a consumer's perspectivedescription : markdown [0..1]Explaination of why this library is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the library is used from a clinical perspectiveusage : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval datelastReviewDate : date [0..1]The period during which the library content was or is planned to be in active useeffectivePeriod : 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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the library is intended to be usedjurisdiction : 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 searchingtopic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering (Strength=Example)DefinitionTopic?? »A contributor to the content of the library, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the librarycopyright : markdown [0..1]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]The parameter element defines parameters used by the libraryparameter : ParameterDefinition [0..*]Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the librarydataRequirement : 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 contentcontent : 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 Logical URI to reference this library (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) -->
 <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>
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <description value="[markdown]"/><!-- 0..1 Natural language description of the library -->
 <purpose value="[markdown]"/><!-- 0..1 Why this library is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the library -->
 <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>
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <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" : "Library",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this library (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the library
  "version" : "<string>", // Business version of the library
  "name" : "<string>", // Name for this library (computer friendly)
  "title" : "<string>", // Name for this library (human friendly)
  "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
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "description" : "<markdown>", // Natural language description of the library
  "purpose" : "<markdown>", // Why this library is defined
  "usage" : "<string>", // Describes the clinical usage of the library
  "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
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for library (if applicable)
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "contributor" : [{ Contributor }], // A content contributor
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "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:Library.url [ uri ]; # 0..1 Logical URI to reference this library (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.status [ code ]; # 1..1 draft | active | retired | unknown
  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:Library.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:Library.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:Library.description [ markdown ]; # 0..1 Natural language description of the library
  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.approvalDate [ date ]; # 0..1 When the library was approved by publisher
  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:Library.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:Library.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for library (if applicable)
  fhir:Library.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc
  fhir:Library.contributor [ Contributor ], ... ; # 0..* A content contributor
  fhir:Library.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:Library.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  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

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library DomainResourceRepresents a library of quality improvement components
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriLogical URI to reference this library (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the library
... version Σ0..1stringBusiness version of the library
... name Σ0..1stringName for this library (computer friendly)
... title Σ0..1stringName for this library (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
LibraryType (Extensible)
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description Σ0..1markdownNatural language description of the library
... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Jurisdiction ValueSet (Extensible)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
DefinitionTopic (Example)
... contributor 0..*ContributorA content contributor
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content 0..*AttachmentContents 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. 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](resource.html#versions)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 artifactsidentifier : 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 artifactsversion : 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 generationname : string [0..1]A short, descriptive, user-friendly title for the librarytitle : 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. (Strength=Required)PublicationStatus! »A 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 (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 Definitiontype : CodeableConcept [1..1] « The type of knowledge asset this library contains (Strength=Extensible)LibraryType+ »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 changesdate : dateTime [0..1]The name of the individual or organization that published the librarypublisher : string [0..1]A free text natural language description of the library from a consumer's perspectivedescription : markdown [0..1]Explaination of why this library is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the library is used from a clinical perspectiveusage : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval datelastReviewDate : date [0..1]The period during which the library content was or is planned to be in active useeffectivePeriod : 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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the library is intended to be usedjurisdiction : 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 searchingtopic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering (Strength=Example)DefinitionTopic?? »A contributor to the content of the library, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the librarycopyright : markdown [0..1]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]The parameter element defines parameters used by the libraryparameter : ParameterDefinition [0..*]Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the librarydataRequirement : 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 contentcontent : 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 Logical URI to reference this library (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) -->
 <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>
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <description value="[markdown]"/><!-- 0..1 Natural language description of the library -->
 <purpose value="[markdown]"/><!-- 0..1 Why this library is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the library -->
 <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>
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <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" : "Library",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this library (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the library
  "version" : "<string>", // Business version of the library
  "name" : "<string>", // Name for this library (computer friendly)
  "title" : "<string>", // Name for this library (human friendly)
  "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
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "description" : "<markdown>", // Natural language description of the library
  "purpose" : "<markdown>", // Why this library is defined
  "usage" : "<string>", // Describes the clinical usage of the library
  "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
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for library (if applicable)
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "contributor" : [{ Contributor }], // A content contributor
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "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:Library.url [ uri ]; # 0..1 Logical URI to reference this library (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.status [ code ]; # 1..1 draft | active | retired | unknown
  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:Library.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:Library.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:Library.description [ markdown ]; # 0..1 Natural language description of the library
  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.approvalDate [ date ]; # 0..1 When the library was approved by publisher
  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:Library.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:Library.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for library (if applicable)
  fhir:Library.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc
  fhir:Library.contributor [ Contributor ], ... ; # 0..* A content contributor
  fhir:Library.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:Library.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  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

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron + JSON Schema, ShEx (for Turtle)

PathDefinitionTypeReference
Library.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
Library.type The type of knowledge asset this library containsExtensibleLibraryType
Library.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet
Library.topic High-level categorization of the definition, used for searching, sorting, and filteringExampleDefinitionTopic

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

NameTypeDescriptionExpressionIn Common
composed-ofreferenceWhat resource is being referencedLibrary.relatedArtifact.where(type='composed-of').resource
(Any)
datedateThe library publication dateLibrary.date
depends-onreferenceWhat resource is being referencedLibrary.relatedArtifact.where(type='depends-on').resource
(Any)
derived-fromreferenceWhat resource is being referencedLibrary.relatedArtifact.where(type='derived-from').resource
(Any)
descriptionstringThe description of the libraryLibrary.description
effectivedateThe time during which the library is intended to be in useLibrary.effectivePeriod
identifiertokenExternal identifier for the libraryLibrary.identifier
jurisdictiontokenIntended jurisdiction for the libraryLibrary.jurisdiction
namestringComputationally friendly name of the libraryLibrary.name
predecessorreferenceWhat resource is being referencedLibrary.relatedArtifact.where(type='predecessor').resource
(Any)
publisherstringName of the publisher of the libraryLibrary.publisher
statustokenThe current status of the libraryLibrary.status
successorreferenceWhat resource is being referencedLibrary.relatedArtifact.where(type='successor').resource
(Any)
titlestringThe human-friendly name of the libraryLibrary.title
topictokenTopics associated with the moduleLibrary.topic
urluriThe uri that identifies the libraryLibrary.url
versiontokenThe business version of the libraryLibrary.version