This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) 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
Clinical Decision Support Work Group | Maturity Level: 1 | Trial Use | Use Context: Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/shareablelibrary
Enforces the minimum information set for the library metadata required by HL7 and other organizations that share and publish libraries
This profile was published on [no date] as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Library.
This structure is derived from Library.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | |||
url | 1..1 | uri | ||
identifier | S | 0..* | Identifier | |
version | 1..1 | string | ||
name | 1..1 | string | ||
title | S | 0..1 | string | |
experimental | 1..1 | boolean | ||
date | S | 0..1 | dateTime | |
publisher | 1..1 | string | ||
contact | S | 0..* | ContactDetail | |
description | 1..1 | markdown | ||
useContext | S | 0..* | UsageContext | |
jurisdiction | S | 0..* | CodeableConcept | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | Represents a library of quality improvement components | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
url | ΣI | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
identifier | SΣI | 0..* | Identifier | Additional identifier for the library |
version | ΣI | 1..1 | string | Business version of the library |
name | ΣI | 1..1 | string | Name for this library (computer friendly) |
title | SΣI | 0..1 | string | Name for this library (human friendly) |
subtitle | I | 0..1 | string | Subordinate title of the library |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ΣI | 1..1 | boolean | For testing purposes, not real usage |
type | ΣI | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible) |
subject[x] | I | 0..1 | Type of individual the library content is focused on Binding: Subject type (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(group.html) | |||
date | SΣI | 0..1 | dateTime | Date last changed |
publisher | ΣI | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣI | 0..* | ContactDetail | Contact details for the publisher |
description | ΣI | 1..1 | markdown | Natural language description of the library |
useContext | SΣI | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣI | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction (extensible) |
purpose | I | 0..1 | markdown | Why this library is defined |
usage | I | 0..1 | string | Describes the clinical usage of the library |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | I | 0..1 | date | When the library was approved by publisher |
lastReviewDate | I | 0..1 | date | When the library was last reviewed |
effectivePeriod | ΣI | 0..1 | Period | When the library is expected to be used |
topic | I | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example) |
author | I | 0..* | ContactDetail | Who authored the content |
editor | I | 0..* | ContactDetail | Who edited the content |
reviewer | I | 0..* | ContactDetail | Who reviewed the content |
endorser | I | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | I | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
parameter | I | 0..* | ParameterDefinition | Parameters defined by the library |
dataRequirement | I | 0..* | DataRequirement | What data is referenced by this library |
content | ΣI | 0..* | Attachment | Contents of the library, either embedded or referenced |
Documentation for this format |
<!-- Shareable Library --> <Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id><!-- 0..1 string Logical id of this artifact --></id> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- 1..1 Canonical identifier for this library, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the library --></identifier> <version value="[string]"/><!-- 1..1 Business version of the library --> <name value="[string]"/><!-- 1..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]"/><!-- 1..1 For testing purposes, not real usage --> <type><!-- 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type> <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]"/><!-- 1..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 1..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>
{ // Shareable Library // from Element: extension "meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "url" : "<uri>", // C? R! Canonical identifier for this library, represented as a URI (globally unique) "identifier" : [{ Identifier }], // C?Additional identifier for the library "version" : "<string>", // C? R! Business version of the library "name" : "<string>", // C? R! Name for this library (computer friendly) "title" : "<string>", // C?Name for this library (human friendly) "subtitle" : "<string>", // C?Subordinate title of the library "status" : "<code>", // C? R! draft | active | retired | unknown "experimental" : <boolean>, // C? R! For testing purposes, not real usage "type" : { CodeableConcept }, // C? R! logic-library | model-definition | asset-collection | module-definition // value[x]: Type of individual the library content is focused on. One of these 2: "subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the library content is focused on "subjectReference" : { Reference(Group) }, // C?Type of individual the library content is focused on "date" : "<dateTime>", // C?Date last changed "publisher" : "<string>", // C? R! Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // C?Contact details for the publisher "description" : "<markdown>", // C? R! Natural language description of the library "useContext" : [{ UsageContext }], // C?The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for library (if applicable) "purpose" : "<markdown>", // C?Why this library is defined "usage" : "<string>", // C?Describes the clinical usage of the library "copyright" : "<markdown>", // C?Use and/or publishing restrictions "approvalDate" : "<date>", // C?When the library was approved by publisher "lastReviewDate" : "<date>", // C?When the library was last reviewed "effectivePeriod" : { Period }, // C?When the library is expected to be used "topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc. "author" : [{ ContactDetail }], // C?Who authored the content "editor" : [{ ContactDetail }], // C?Who edited the content "reviewer" : [{ ContactDetail }], // C?Who reviewed the content "endorser" : [{ ContactDetail }], // C?Who endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc. "parameter" : [{ ParameterDefinition }], // C?Parameters defined by the library "dataRequirement" : [{ DataRequirement }] // C?What data is referenced by this library "content" : [{ Attachment }], // C?Contents of the library, either embedded or referenced }
This structure is derived from Library.
Differential View
This structure is derived from Library.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | |||
url | 1..1 | uri | ||
identifier | S | 0..* | Identifier | |
version | 1..1 | string | ||
name | 1..1 | string | ||
title | S | 0..1 | string | |
experimental | 1..1 | boolean | ||
date | S | 0..1 | dateTime | |
publisher | 1..1 | string | ||
contact | S | 0..* | ContactDetail | |
description | 1..1 | markdown | ||
useContext | S | 0..* | UsageContext | |
jurisdiction | S | 0..* | CodeableConcept | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | Represents a library of quality improvement components | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
url | ΣI | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
identifier | SΣI | 0..* | Identifier | Additional identifier for the library |
version | ΣI | 1..1 | string | Business version of the library |
name | ΣI | 1..1 | string | Name for this library (computer friendly) |
title | SΣI | 0..1 | string | Name for this library (human friendly) |
subtitle | I | 0..1 | string | Subordinate title of the library |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ΣI | 1..1 | boolean | For testing purposes, not real usage |
type | ΣI | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible) |
subject[x] | I | 0..1 | Type of individual the library content is focused on Binding: Subject type (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(group.html) | |||
date | SΣI | 0..1 | dateTime | Date last changed |
publisher | ΣI | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣI | 0..* | ContactDetail | Contact details for the publisher |
description | ΣI | 1..1 | markdown | Natural language description of the library |
useContext | SΣI | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣI | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction (extensible) |
purpose | I | 0..1 | markdown | Why this library is defined |
usage | I | 0..1 | string | Describes the clinical usage of the library |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | I | 0..1 | date | When the library was approved by publisher |
lastReviewDate | I | 0..1 | date | When the library was last reviewed |
effectivePeriod | ΣI | 0..1 | Period | When the library is expected to be used |
topic | I | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example) |
author | I | 0..* | ContactDetail | Who authored the content |
editor | I | 0..* | ContactDetail | Who edited the content |
reviewer | I | 0..* | ContactDetail | Who reviewed the content |
endorser | I | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | I | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
parameter | I | 0..* | ParameterDefinition | Parameters defined by the library |
dataRequirement | I | 0..* | DataRequirement | What data is referenced by this library |
content | ΣI | 0..* | Attachment | Contents of the library, either embedded or referenced |
Documentation for this format |
XML Template
<!-- Shareable Library --> <Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id><!-- 0..1 string Logical id of this artifact --></id> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- 1..1 Canonical identifier for this library, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the library --></identifier> <version value="[string]"/><!-- 1..1 Business version of the library --> <name value="[string]"/><!-- 1..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]"/><!-- 1..1 For testing purposes, not real usage --> <type><!-- 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type> <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]"/><!-- 1..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 1..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
{ // Shareable Library // from Element: extension "meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "url" : "<uri>", // C? R! Canonical identifier for this library, represented as a URI (globally unique) "identifier" : [{ Identifier }], // C?Additional identifier for the library "version" : "<string>", // C? R! Business version of the library "name" : "<string>", // C? R! Name for this library (computer friendly) "title" : "<string>", // C?Name for this library (human friendly) "subtitle" : "<string>", // C?Subordinate title of the library "status" : "<code>", // C? R! draft | active | retired | unknown "experimental" : <boolean>, // C? R! For testing purposes, not real usage "type" : { CodeableConcept }, // C? R! logic-library | model-definition | asset-collection | module-definition // value[x]: Type of individual the library content is focused on. One of these 2: "subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the library content is focused on "subjectReference" : { Reference(Group) }, // C?Type of individual the library content is focused on "date" : "<dateTime>", // C?Date last changed "publisher" : "<string>", // C? R! Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // C?Contact details for the publisher "description" : "<markdown>", // C? R! Natural language description of the library "useContext" : [{ UsageContext }], // C?The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for library (if applicable) "purpose" : "<markdown>", // C?Why this library is defined "usage" : "<string>", // C?Describes the clinical usage of the library "copyright" : "<markdown>", // C?Use and/or publishing restrictions "approvalDate" : "<date>", // C?When the library was approved by publisher "lastReviewDate" : "<date>", // C?When the library was last reviewed "effectivePeriod" : { Period }, // C?When the library is expected to be used "topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc. "author" : [{ ContactDetail }], // C?Who authored the content "editor" : [{ ContactDetail }], // C?Who edited the content "reviewer" : [{ ContactDetail }], // C?Who reviewed the content "endorser" : [{ ContactDetail }], // C?Who endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc. "parameter" : [{ ParameterDefinition }], // C?Parameters defined by the library "dataRequirement" : [{ DataRequirement }] // C?What data is referenced by this library "content" : [{ Attachment }], // C?Contents of the library, either embedded or referenced }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
Library.language | Common Languages | preferred | Common Languages |
Library.status | PublicationStatus | required | PublicationStatus |
Library.type | LibraryType | extensible | LibraryType |
Library.subject[x] | Subject type | extensible | Subject type |
Library.jurisdiction | Jurisdiction | extensible | Jurisdiction |
Library.topic | DefinitionTopic | example | DefinitionTopic |