This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Use Context: Country: World |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/publishablelibrary
Supports declaration of the library metadata required by HL7 and other organizations that share and publish libraries with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.
This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from ShareableLibrary.
This structure is derived from ShareableLibrary.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | ShareableLibrary | Represents a library of quality improvement components | |
cqf-logicDefinition | S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
title | S | 1..1 | string | Name for this library (human friendly) |
type | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition | |
date | S | 1..1 | dateTime | Date last changed |
purpose | 0..1 | markdown | Why this library is defined | |
usage | 0..1 | string | Describes the clinical usage of the library | |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the library was approved by publisher |
lastReviewDate | S | 0..1 | date | When the library was last reviewed |
effectivePeriod | S | 0..1 | Period | When the library is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
display | S | 0..1 | string | Brief description of the related artifact |
url | S | 0..1 | url | Where the artifact can be accessed |
resource | S | 0..1 | canonical(Resource) | What resource is being referenced |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | ShareableLibrary | Represents a library of quality improvement components |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages: IETF language tag | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cqf-knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability (required) |
cqf-knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) |
cqf-artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
cqf-logicDefinition | S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
identifier | SΣ | 0..* | Identifier | Additional identifier for the library |
version | Σ | 1..1 | string | Business version of the library |
name | ΣI | 1..1 | string | Name for this library (computer friendly) |
title | SΣ | 1..1 | string | Name for this library (human friendly) |
subtitle | 0..1 | string | Subordinate title of the library | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage |
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
subject[x] | 0..1 | Type of individual the library content is focused on Binding: Subject type (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | SΣ | 1..1 | dateTime | Date last changed |
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 1..1 | markdown | Natural language description of the library |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction (extensible): Countries and regions within which this artifact is targeted for use. |
purpose | 0..1 | markdown | Why this library is defined | |
usage | 0..1 | string | Describes the clinical usage of the library | |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the library was approved by publisher |
lastReviewDate | S | 0..1 | date | When the library was last reviewed |
effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) |
label | Σ | 0..1 | string | Short label |
display | SΣ | 0..1 | string | Brief description of the related artifact |
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact |
url | SΣ | 0..1 | url | Where the artifact can be accessed |
document | Σ | 0..1 | Attachment | What document is being referenced |
resource | SΣ | 0..1 | canonical(Resource) | What resource is being referenced |
parameter | 0..* | ParameterDefinition | Parameters defined by the library | |
dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |
content | Σ | 0..* | Attachment | Contents of the library, either embedded or referenced |
Documentation for this format |
<!-- PublishableLibrary --> <Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <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]"/><!-- 1..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]"/><!-- 1..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 <!-- 0..* Additional documentation, citations, etc. --> <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of --> <label value="[string]"/><!-- 0..1 Short label --> <display value="[string]"/><!-- 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- 0..1 Bibliographic citation for the artifact --> <url value="[url]"/><!-- 0..1 Where the artifact can be accessed --> <document><!-- 0..1 Attachment What document is being referenced --></document> <resource value="[canonical]"/><!-- 0..1 What resource is being referenced --> </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>
{ // PublishableLibrary // 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 "extension" : [ // sliced by value:url in the specified order, Open { // shareable | computable | publishable | executable // C? // from Element: extension }, { // narrative | semi-structured | structured | executable // C? // from Element: extension }, { // Additional documentation, review, or usage guidance // C? // from Element: extension }, { // A logic definition used in the artifact // C? // from Element: extension } ], "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? R! 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? R! 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 ShareableLibrary.
Differential View
This structure is derived from ShareableLibrary.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | ShareableLibrary | Represents a library of quality improvement components | |
cqf-logicDefinition | S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
title | S | 1..1 | string | Name for this library (human friendly) |
type | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition | |
date | S | 1..1 | dateTime | Date last changed |
purpose | 0..1 | markdown | Why this library is defined | |
usage | 0..1 | string | Describes the clinical usage of the library | |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the library was approved by publisher |
lastReviewDate | S | 0..1 | date | When the library was last reviewed |
effectivePeriod | S | 0..1 | Period | When the library is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
display | S | 0..1 | string | Brief description of the related artifact |
url | S | 0..1 | url | Where the artifact can be accessed |
resource | S | 0..1 | canonical(Resource) | What resource is being referenced |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | ShareableLibrary | Represents a library of quality improvement components |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages: IETF language tag | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cqf-knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability (required) |
cqf-knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) |
cqf-artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
cqf-logicDefinition | S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
identifier | SΣ | 0..* | Identifier | Additional identifier for the library |
version | Σ | 1..1 | string | Business version of the library |
name | ΣI | 1..1 | string | Name for this library (computer friendly) |
title | SΣ | 1..1 | string | Name for this library (human friendly) |
subtitle | 0..1 | string | Subordinate title of the library | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage |
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
subject[x] | 0..1 | Type of individual the library content is focused on Binding: Subject type (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | SΣ | 1..1 | dateTime | Date last changed |
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 1..1 | markdown | Natural language description of the library |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction (extensible): Countries and regions within which this artifact is targeted for use. |
purpose | 0..1 | markdown | Why this library is defined | |
usage | 0..1 | string | Describes the clinical usage of the library | |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the library was approved by publisher |
lastReviewDate | S | 0..1 | date | When the library was last reviewed |
effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) |
label | Σ | 0..1 | string | Short label |
display | SΣ | 0..1 | string | Brief description of the related artifact |
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact |
url | SΣ | 0..1 | url | Where the artifact can be accessed |
document | Σ | 0..1 | Attachment | What document is being referenced |
resource | SΣ | 0..1 | canonical(Resource) | What resource is being referenced |
parameter | 0..* | ParameterDefinition | Parameters defined by the library | |
dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |
content | Σ | 0..* | Attachment | Contents of the library, either embedded or referenced |
Documentation for this format |
XML Template
<!-- PublishableLibrary --> <Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <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]"/><!-- 1..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]"/><!-- 1..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 <!-- 0..* Additional documentation, citations, etc. --> <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of --> <label value="[string]"/><!-- 0..1 Short label --> <display value="[string]"/><!-- 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- 0..1 Bibliographic citation for the artifact --> <url value="[url]"/><!-- 0..1 Where the artifact can be accessed --> <document><!-- 0..1 Attachment What document is being referenced --></document> <resource value="[canonical]"/><!-- 0..1 What resource is being referenced --> </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
{ // PublishableLibrary // 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 "extension" : [ // sliced by value:url in the specified order, Open { // shareable | computable | publishable | executable // C? // from Element: extension }, { // narrative | semi-structured | structured | executable // C? // from Element: extension }, { // Additional documentation, review, or usage guidance // C? // from Element: extension }, { // A logic definition used in the artifact // C? // from Element: extension } ], "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? R! 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? R! 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 | preferred | DefinitionTopic |
Library.relatedArtifact.type | RelatedArtifactType | required | RelatedArtifactType |