STU3 Candidate

This page is part of the FHIR Specification (v1.8.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

14.3 Resource Library - Content

Clinical Decision Support Work GroupMaturity Level: 0Compartments: 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 exist knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

14.3.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 Reasoning module.

The Library resource is a general purpose container for clinical knowledge that is defined using a non-FHIR representation. For example, a shareable library of clinical logic, written in Clinical Quality Language (CQL), or the XML Schema for an information model. 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.

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.3.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 and PlanDefinition

14.3.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library DomainResourceRepresents a library of quality improvement components
... 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)
... type ?!Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
LibraryType (Extensible)
... status ?!Σ1..1codedraft | active | retired
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... 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 library approved by publisher
... lastReviewDate 0..1dateLast review date for the library
... effectivePeriod Σ0..1PeriodThe effective date range for the library
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Jurisdiction ValueSet (Extensible)
... topic 0..*CodeableConceptDescriptional topics for the library
... contributor 0..*ContributorA content contributor
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactRelated artifacts for the library
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementData requirements of the library
... content 0..*AttachmentThe content of the library

doco Documentation for this format

UML Diagram (Legend)

Library (DomainResource)An absolute URL that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see [Technical and Business Versions](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 are orderable. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active 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]Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition (this element modifies the meaning of other elements)type : CodeableConcept [1..1] « The type of knowledge asset this library contains (Strength=Extensible)LibraryType+ »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 flag to indicate that this library is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the library was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the library changesdate : dateTime [0..1]A free text natural language description of the library from the consumer's perspectivedescription : markdown [0..1]Explains 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 asset 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 asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval datelastReviewDate : date [0..1]The period during which the library content was or is planned to be effectiveeffectivePeriod : 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 of code system definitionsuseContext : UsageContext [0..*]A jurisdiction 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+ »Clinical topics related to the content of the librarytopic : CodeableConcept [0..*]A contributor to the content of the library, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]The name of the individual or organization that published the librarypublisher : string [0..1]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) -->
 <type><!-- 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type>
 <status value="[code]"/><!-- 1..1 draft | active | retired -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <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 library approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the library -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the library --></effectivePeriod>
 <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction>
 <topic><!-- 0..* CodeableConcept Descriptional topics for the library --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedArtifact><!-- 0..* RelatedArtifact Related artifacts for the library --></relatedArtifact>
 <parameter><!-- 0..* ParameterDefinition Parameters defined by the library --></parameter>
 <dataRequirement><!-- 0..* DataRequirement Data requirements of the library --></dataRequirement>
 <content><!-- 0..* Attachment The content of the library --></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)
  "type" : { CodeableConcept }, // R!  logic-library | model-definition | asset-collection | module-definition
  "status" : "<code>", // R!  draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "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 library approved by publisher
  "lastReviewDate" : "<date>", // Last review date for the library
  "effectivePeriod" : { Period }, // The effective date range for the library
  "useContext" : [{ UsageContext }], // Content intends to support these contexts
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for library (if applicable)
  "topic" : [{ CodeableConcept }], // Descriptional topics for the library
  "contributor" : [{ Contributor }], // A content contributor
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "relatedArtifact" : [{ RelatedArtifact }], // Related artifacts for the library
  "parameter" : [{ ParameterDefinition }], // Parameters defined by the library
  "dataRequirement" : [{ DataRequirement }], // Data requirements of the library
  "content" : [{ Attachment }] // The content of the library
}

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.type [ CodeableConcept ]; # 1..1 logic-library | model-definition | asset-collection | module-definition
  fhir:Library.status [ code ]; # 1..1 draft | active | retired
  fhir:Library.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:Library.date [ dateTime ]; # 0..1 Date this was last changed
  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 library approved by publisher
  fhir:Library.lastReviewDate [ date ]; # 0..1 Last review date for the library
  fhir:Library.effectivePeriod [ Period ]; # 0..1 The effective date range for the library
  fhir:Library.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts
  fhir:Library.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for library (if applicable)
  fhir:Library.topic [ CodeableConcept ], ... ; # 0..* Descriptional topics for the library
  fhir:Library.contributor [ Contributor ], ... ; # 0..* A content contributor
  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.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:Library.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Related artifacts for the library
  fhir:Library.parameter [ ParameterDefinition ], ... ; # 0..* Parameters defined by the library
  fhir:Library.dataRequirement [ DataRequirement ], ... ; # 0..* Data requirements of the library
  fhir:Library.content [ Attachment ], ... ; # 0..* The content of the library
]

Changes since DSTU2

This resource did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library DomainResourceRepresents a library of quality improvement components
... 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)
... type ?!Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
LibraryType (Extensible)
... status ?!Σ1..1codedraft | active | retired
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... 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 library approved by publisher
... lastReviewDate 0..1dateLast review date for the library
... effectivePeriod Σ0..1PeriodThe effective date range for the library
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Jurisdiction ValueSet (Extensible)
... topic 0..*CodeableConceptDescriptional topics for the library
... contributor 0..*ContributorA content contributor
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactRelated artifacts for the library
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementData requirements of the library
... content 0..*AttachmentThe content of the library

doco Documentation for this format

UML Diagram (Legend)

Library (DomainResource)An absolute URL that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see [Technical and Business Versions](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 are orderable. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active 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]Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition (this element modifies the meaning of other elements)type : CodeableConcept [1..1] « The type of knowledge asset this library contains (Strength=Extensible)LibraryType+ »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 flag to indicate that this library is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the library was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the library changesdate : dateTime [0..1]A free text natural language description of the library from the consumer's perspectivedescription : markdown [0..1]Explains 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 asset 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 asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval datelastReviewDate : date [0..1]The period during which the library content was or is planned to be effectiveeffectivePeriod : 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 of code system definitionsuseContext : UsageContext [0..*]A jurisdiction 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+ »Clinical topics related to the content of the librarytopic : CodeableConcept [0..*]A contributor to the content of the library, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]The name of the individual or organization that published the librarypublisher : string [0..1]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) -->
 <type><!-- 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type>
 <status value="[code]"/><!-- 1..1 draft | active | retired -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <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 library approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the library -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the library --></effectivePeriod>
 <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction>
 <topic><!-- 0..* CodeableConcept Descriptional topics for the library --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedArtifact><!-- 0..* RelatedArtifact Related artifacts for the library --></relatedArtifact>
 <parameter><!-- 0..* ParameterDefinition Parameters defined by the library --></parameter>
 <dataRequirement><!-- 0..* DataRequirement Data requirements of the library --></dataRequirement>
 <content><!-- 0..* Attachment The content of the library --></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)
  "type" : { CodeableConcept }, // R!  logic-library | model-definition | asset-collection | module-definition
  "status" : "<code>", // R!  draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "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 library approved by publisher
  "lastReviewDate" : "<date>", // Last review date for the library
  "effectivePeriod" : { Period }, // The effective date range for the library
  "useContext" : [{ UsageContext }], // Content intends to support these contexts
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for library (if applicable)
  "topic" : [{ CodeableConcept }], // Descriptional topics for the library
  "contributor" : [{ Contributor }], // A content contributor
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "relatedArtifact" : [{ RelatedArtifact }], // Related artifacts for the library
  "parameter" : [{ ParameterDefinition }], // Parameters defined by the library
  "dataRequirement" : [{ DataRequirement }], // Data requirements of the library
  "content" : [{ Attachment }] // The content of the library
}

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.type [ CodeableConcept ]; # 1..1 logic-library | model-definition | asset-collection | module-definition
  fhir:Library.status [ code ]; # 1..1 draft | active | retired
  fhir:Library.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:Library.date [ dateTime ]; # 0..1 Date this was last changed
  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 library approved by publisher
  fhir:Library.lastReviewDate [ date ]; # 0..1 Last review date for the library
  fhir:Library.effectivePeriod [ Period ]; # 0..1 The effective date range for the library
  fhir:Library.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts
  fhir:Library.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for library (if applicable)
  fhir:Library.topic [ CodeableConcept ], ... ; # 0..* Descriptional topics for the library
  fhir:Library.contributor [ Contributor ], ... ; # 0..* A content contributor
  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.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:Library.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Related artifacts for the library
  fhir:Library.parameter [ ParameterDefinition ], ... ; # 0..* Parameters defined by the library
  fhir:Library.dataRequirement [ DataRequirement ], ... ; # 0..* Data requirements of the library
  fhir:Library.content [ Attachment ], ... ; # 0..* The content of the library
]

Changes since DSTU2

This resource did not exist in Release 2

 

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

14.3.3.1 Terminology Bindings

PathDefinitionTypeReference
Library.type The type of knowledge asset this library containsExtensibleLibraryType
Library.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
Library.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet

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

NameTypeDescriptionPathsIn Common
datedateThe library publication dateLibrary.date
descriptionstringText search against the description of the libraryLibrary.description
effectivedateEffective time associated with the libraryLibrary.effectivePeriod
identifiertokenExternal identifiers for the libraryLibrary.identifier
jurisdictiontokenIntended jurisdiction for libraryLibrary.jurisdiction
namestringName of the libraryLibrary.name
publisherstringName of the publisher of the libraryLibrary.publisher
statustokenThe current status of the libraryLibrary.status
titlestringText search against the title of the libraryLibrary.title
topictokenTopics associated with the moduleLibrary.topic
urluriThe uri that identifies the libraryLibrary.url
versiontokenThe version identifier of the libraryLibrary.version