This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
The canonical 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
Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management implementation guide as part of the next FHIR release. Implementers are encouraged to look there for updates, corrections and clarifications.
This profile was published on Thu, Jan 1, 1970 00:00+0000 with unknown status 'active" by .
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Library.
Summary
Mandatory: 4 elements
Must-Support: 11 elements
Extensions
This structure refers to these extensions:
This indicates the differences between this profile and the base Library structure.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | Library | Represents a library of quality improvement components | |
Slices for extension | Content/Rules for all slices | |||
knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability Value Set (required) |
knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) |
artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
url | S | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
version | S | 1..1 | string | Business version of the library |
versionAlgorithm[x] | S | 0..1 | string, Coding | How to compare versions |
name | S | 0..1 | string | Name for this library (computer friendly) |
title | S | 1..1 | string | Name for this library (human friendly) |
experimental | S | 0..1 | boolean | For testing purposes, not real usage |
publisher | S | 0..1 | string | Name of the publisher/steward (organization or individual) |
description | S | 1..1 | markdown | Natural language description of the library |
Documentation for this format |
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Library structure.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Library | C | 1..1 | Library | Represents a library of quality improvement components cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
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: All Languages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability Value Set (required) | ||||
knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) | ||||
artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | SΣC | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the library | ||||
version | SΣ | 1..1 | string | Business version of the library | ||||
versionAlgorithm[x] | SΣ | 0..1 | How to compare versions Binding: Version Algorithm (extensible) | |||||
versionAlgorithmString | string | |||||||
versionAlgorithmCoding | Coding | |||||||
name | SΣC | 0..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 | SΣ | 0..1 | boolean | For testing purposes, not real usage | ||||
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: Library Type (extensible): The type of knowledge asset this library contains. | ||||
subject[x] | 0..1 | Type of individual the library content is focused on Binding: Participant Resource Types (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | SΣ | 1..1 | markdown | Natural language description of the library | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this library is defined | |||||
usage | 0..1 | markdown | Describes the clinical usage of the library | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
approvalDate | 0..1 | date | When the library was approved by publisher | |||||
lastReviewDate | 0..1 | date | When the library was last reviewed by the publisher | |||||
effectivePeriod | Σ | 0..1 | Period | When the library is expected to be used | ||||
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
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 | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
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 |
<!-- ShareableLibrary --> <Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this library, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the library --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the library --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this library (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this library (human friendly) --> <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the library --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage --> <type><!-- I 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the library --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this library is defined --> <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the library --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the library was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the library was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the library is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the content --></author> <editor><!-- I 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <parameter><!-- I 0..* ParameterDefinition Parameters defined by the library --></parameter> <dataRequirement><!-- I 0..* DataRequirement What data is referenced by this library --></dataRequirement> <content><!-- I 0..* Attachment Contents of the library, either embedded or referenced --></content> </Library>
{ // ShareableLibrary // from Element: extension "meta" : { Meta }, // IMetadata about the resource "implicitRules" : "<uri>", // IA set of rules under which this content was created "language" : "<code>", // ILanguage of the resource content "text" : { Narrative }, // IText 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 // I // from Element: extension }, { // narrative | semi-structured | structured | executable // I // from Element: extension }, { // Additional documentation, review, or usage guidance // I // from Element: extension } ], "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored "url" : "<uri>", // I R! Canonical identifier for this library, represented as a URI (globally unique) "identifier" : [{ Identifier }], // IAdditional identifier for the library "version" : "<string>", // I R! Business version of the library // value[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", // IHow to compare versions "versionAlgorithmCoding" : { Coding }, // IHow to compare versions "name" : "<string>", // IName for this library (computer friendly) "title" : "<string>", // I R! Name for this library (human friendly) "subtitle" : "<string>", // ISubordinate title of the library "status" : "<code>", // I R! draft | active | retired | unknown "experimental" : <boolean>, // IFor testing purposes, not real usage "type" : { CodeableConcept }, // I 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 }, // IType of individual the library content is focused on "subjectReference" : { Reference(Group) }, // IType of individual the library content is focused on "date" : "<dateTime>", // IDate last changed "publisher" : "<string>", // IName of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // IContact details for the publisher "description" : "<markdown>", // I R! Natural language description of the library "useContext" : [{ UsageContext }], // IThe context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for library (if applicable) "purpose" : "<markdown>", // IWhy this library is defined "usage" : "<markdown>", // IDescribes the clinical usage of the library "copyright" : "<markdown>", // IUse and/or publishing restrictions "copyrightLabel" : "<string>", // ICopyright holder and year(s) "approvalDate" : "<date>", // IWhen the library was approved by publisher "lastReviewDate" : "<date>", // IWhen the library was last reviewed by the publisher "effectivePeriod" : { Period }, // IWhen the library is expected to be used "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc "author" : [{ ContactDetail }], // IWho authored the content "editor" : [{ ContactDetail }], // IWho edited the content "reviewer" : [{ ContactDetail }], // IWho reviewed the content "endorser" : [{ ContactDetail }], // IWho endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc "parameter" : [{ ParameterDefinition }], // IParameters defined by the library "dataRequirement" : [{ DataRequirement }], // IWhat data is referenced by this library "content" : [{ Attachment }], // IContents of the library, either embedded or referenced }
This structure is derived from Library.
Differential View
This indicates the differences between this profile and the base Library structure.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | Library | Represents a library of quality improvement components | |
Slices for extension | Content/Rules for all slices | |||
knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability Value Set (required) |
knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) |
artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
url | S | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
version | S | 1..1 | string | Business version of the library |
versionAlgorithm[x] | S | 0..1 | string, Coding | How to compare versions |
name | S | 0..1 | string | Name for this library (computer friendly) |
title | S | 1..1 | string | Name for this library (human friendly) |
experimental | S | 0..1 | boolean | For testing purposes, not real usage |
publisher | S | 0..1 | string | Name of the publisher/steward (organization or individual) |
description | S | 1..1 | markdown | Natural language description of the library |
Documentation for this format |
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Library structure.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Library | C | 1..1 | Library | Represents a library of quality improvement components cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
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: All Languages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability Value Set (required) | ||||
knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) | ||||
artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | SΣC | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the library | ||||
version | SΣ | 1..1 | string | Business version of the library | ||||
versionAlgorithm[x] | SΣ | 0..1 | How to compare versions Binding: Version Algorithm (extensible) | |||||
versionAlgorithmString | string | |||||||
versionAlgorithmCoding | Coding | |||||||
name | SΣC | 0..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 | SΣ | 0..1 | boolean | For testing purposes, not real usage | ||||
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: Library Type (extensible): The type of knowledge asset this library contains. | ||||
subject[x] | 0..1 | Type of individual the library content is focused on Binding: Participant Resource Types (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | SΣ | 1..1 | markdown | Natural language description of the library | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this library is defined | |||||
usage | 0..1 | markdown | Describes the clinical usage of the library | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
approvalDate | 0..1 | date | When the library was approved by publisher | |||||
lastReviewDate | 0..1 | date | When the library was last reviewed by the publisher | |||||
effectivePeriod | Σ | 0..1 | Period | When the library is expected to be used | ||||
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
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 | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
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
<!-- ShareableLibrary --> <Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this library, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the library --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the library --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this library (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this library (human friendly) --> <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the library --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage --> <type><!-- I 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the library --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this library is defined --> <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the library --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the library was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the library was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the library is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the content --></author> <editor><!-- I 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <parameter><!-- I 0..* ParameterDefinition Parameters defined by the library --></parameter> <dataRequirement><!-- I 0..* DataRequirement What data is referenced by this library --></dataRequirement> <content><!-- I 0..* Attachment Contents of the library, either embedded or referenced --></content> </Library>
JSON Template
{ // ShareableLibrary // from Element: extension "meta" : { Meta }, // IMetadata about the resource "implicitRules" : "<uri>", // IA set of rules under which this content was created "language" : "<code>", // ILanguage of the resource content "text" : { Narrative }, // IText 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 // I // from Element: extension }, { // narrative | semi-structured | structured | executable // I // from Element: extension }, { // Additional documentation, review, or usage guidance // I // from Element: extension } ], "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored "url" : "<uri>", // I R! Canonical identifier for this library, represented as a URI (globally unique) "identifier" : [{ Identifier }], // IAdditional identifier for the library "version" : "<string>", // I R! Business version of the library // value[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", // IHow to compare versions "versionAlgorithmCoding" : { Coding }, // IHow to compare versions "name" : "<string>", // IName for this library (computer friendly) "title" : "<string>", // I R! Name for this library (human friendly) "subtitle" : "<string>", // ISubordinate title of the library "status" : "<code>", // I R! draft | active | retired | unknown "experimental" : <boolean>, // IFor testing purposes, not real usage "type" : { CodeableConcept }, // I 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 }, // IType of individual the library content is focused on "subjectReference" : { Reference(Group) }, // IType of individual the library content is focused on "date" : "<dateTime>", // IDate last changed "publisher" : "<string>", // IName of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // IContact details for the publisher "description" : "<markdown>", // I R! Natural language description of the library "useContext" : [{ UsageContext }], // IThe context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for library (if applicable) "purpose" : "<markdown>", // IWhy this library is defined "usage" : "<markdown>", // IDescribes the clinical usage of the library "copyright" : "<markdown>", // IUse and/or publishing restrictions "copyrightLabel" : "<string>", // ICopyright holder and year(s) "approvalDate" : "<date>", // IWhen the library was approved by publisher "lastReviewDate" : "<date>", // IWhen the library was last reviewed by the publisher "effectivePeriod" : { Period }, // IWhen the library is expected to be used "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc "author" : [{ ContactDetail }], // IWho authored the content "editor" : [{ ContactDetail }], // IWho edited the content "reviewer" : [{ ContactDetail }], // IWho reviewed the content "endorser" : [{ ContactDetail }], // IWho endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc "parameter" : [{ ParameterDefinition }], // IParameters defined by the library "dataRequirement" : [{ DataRequirement }], // IWhat data is referenced by this library "content" : [{ Attachment }], // IContents of the library, either embedded or referenced }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
Library.language | All Languages | required | All Languages |
Library.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
Library.status | PublicationStatus | required | PublicationStatus |
Library.type | Library Type | extensible | Library Type |
Library.subject[x] | Participant Resource Types | extensible | Participant Resource Types |
Library.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
Library.topic | Definition Topic | example | Definition Topic |