This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0:
R5
-
Mixed
Normative
and
STU
)
).
This
is
the
current
published
version
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
:
|
Trial Use | Use Context : Any |
The
official
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
[no
date]
as
a
draft
Thu,
Jan
1,
1970
00:00+1000
with
unknown
status
'active"
by
HL7.
.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from Library .
Summary
Mandatory:
6
4
elements
Must-Support:
6
11
elements
Extensions
This structure refers to these extensions:
This
structure
is
derived
from
indicates
the
differences
between
this
profile
and
the
base
Library
.
structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | Library | Represents a library of quality improvement components | |
|
S |
|
|
shareable
|
computable
|
publishable
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability ( required ) |
|
S | 0..* |
|
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
|
S |
|
|
Additional
documentation,
review,
or
usage
guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
|
S | 1..1 |
|
Canonical identifier for this library, represented as a URI (globally unique) |
|
S |
|
string | Business version of the library |
|
S |
|
|
How to compare versions |
|
S |
|
|
Name for this library (computer friendly) |
|
S | 1..1 | string | Name for this library (human friendly) |
|
S |
0
..
|
|
For testing purposes, not real usage |
|
|
0
..
|
|
Name of the publisher/steward (organization or individual) |
|
S | 1..1 |
|
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
|
|---|---|---|---|---|
|
|
1..1 | Library |
Represents
a
library
of
quality
improvement
components
|
|
Σ | 0..1 |
|
Logical id of this artifact |
|
Σ
|
0..1 | Meta | Metadata about the resource |
|
?!
Σ
|
0..1 | uri | A set of rules under which this content was created |
|
0..1 | code |
Language
of
the
resource
content
Binding: |
|
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |
|
0..* | Resource |
Contained,
inline
Resources
|
|
|
0..* | Extension |
Extension
Slice: Unordered, Open by value:url | |
![]() ![]() | S | 0..* | code |
shareable
|
computable
|
publishable
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability ( required ) |
![]() ![]() | S | 0..* |
|
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
![]() ![]() | S | 0..* | (Complex) |
Additional
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
|
?!
|
0..* | Extension |
Extensions
that
cannot
be
ignored
|
|
S
Σ
|
1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
|
Σ
|
0..* | Identifier |
Additional
identifier
for
the
library
|
|
|
1..1 | string | Business version of the library |
| S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) | |
![]() ![]() ![]() | string | |||
![]() ![]() ![]() | Coding | |||
|
S
Σ
|
|
string | Name for this library (computer friendly) |
|
S
Σ
|
|
string | Name for this library (human friendly) |
|
0..1 | string | Subordinate title of the library | |
|
?!
Σ
|
1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required |
|
|
|
boolean | For testing purposes, not real usage |
|
Σ
|
1..1 | CodeableConcept |
logic-library
|
model-definition
|
asset-collection
|
module-definition
Binding: |
|
0..1 |
Type
of
individual
the
library
content
is
focused
on
Binding: |
||
|
CodeableConcept | |||
|
Reference
|
|||
|
|
0..1 | dateTime | Date last changed |
|
|
|
string |
Name
of
the
|
|
|
0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
|
1..1 | markdown | Natural language description of the library |
|
|
0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
|
0..* | CodeableConcept |
Intended
jurisdiction
for
library
(if
applicable)
Binding: Jurisdiction ValueSet ( extensible |
|
0..1 | markdown | Why this library is defined | |
|
0..1 |
|
Describes the clinical usage of the library | |
|
0..1 | markdown | Use and/or publishing restrictions | |
|
0..1 | string | Copyright holder and year(s) | |
![]() ![]() | 0..1 | date | When the library was approved by publisher | |
|
0..1 | date | When the library was last reviewed by the publisher | |
|
Σ
|
0..1 | Period | When the library is expected to be used |
|
|
0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment,
Binding: |
|
0..* | ContactDetail |
Who
authored
the
content
|
|
|
0..* | ContactDetail |
Who
edited
the
content
|
|
|
0..* | ContactDetail |
Who
reviewed
the
content
|
|
|
0..* | ContactDetail |
Who
endorsed
the
content
|
|
|
0..* | RelatedArtifact |
Additional
documentation,
citations,
|
|
|
0..* | ParameterDefinition |
Parameters
defined
by
the
library
|
|
|
0..* | DataRequirement |
What
data
is
referenced
by
this
library
|
|
|
Σ
|
0..* | Attachment |
Contents
of
the
library,
either
embedded
or
referenced
|
Documentation
for
this
format
|
||||
<!-- Shareable Library --><!-- ShareableLibrary --><Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension -->
<</id> <</meta> < < <<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> <<a href="shareablelibrary-definitions.html#Library.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<contained><!-- 0..* Resource Contained, inline Resources --></contained> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> < <</identifier> < < < < < < <</type> <</subject[x]> < < <</contact> < < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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> < < < < < <<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> <</author> <</editor> <</reviewer> <</endorser> < Additional documentation, citations, etc.</relatedArtifact> <<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" " " " " "<a href="shareablelibrary-definitions.html#Library.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."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 } ], "Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"> " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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
structure
is
derived
from
indicates
the
differences
between
this
profile
and
the
base
Library
.
structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | Library | Represents a library of quality improvement components | |
|
S |
|
|
shareable
|
computable
|
publishable
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability ( required ) |
|
S | 0..* |
|
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
|
S |
|
|
Additional
documentation,
review,
or
usage
guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
|
S | 1..1 |
|
Canonical identifier for this library, represented as a URI (globally unique) |
|
S |
|
string | Business version of the library |
|
S |
|
|
How to compare versions |
|
S |
|
|
Name for this library (computer friendly) |
|
S | 1..1 | string | Name for this library (human friendly) |
|
S |
0
..
|
|
For testing purposes, not real usage |
|
|
0
..
|
|
Name of the publisher/steward (organization or individual) |
|
S | 1..1 |
|
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
|
|---|---|---|---|---|
|
|
1..1 | Library |
Represents
a
library
of
quality
improvement
components
|
|
Σ | 0..1 |
|
Logical id of this artifact |
|
Σ
|
0..1 | Meta | Metadata about the resource |
|
?!
Σ
|
0..1 | uri | A set of rules under which this content was created |
|
0..1 | code |
Language
of
the
resource
content
Binding: |
|
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |
|
0..* | Resource |
Contained,
inline
Resources
|
|
|
0..* | Extension |
Extension
Slice: Unordered, Open by value:url | |
![]() ![]() | S | 0..* | code |
shareable
|
computable
|
publishable
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability ( required ) |
![]() ![]() | S | 0..* |
|
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
![]() ![]() | S | 0..* | (Complex) |
Additional
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
|
?!
|
0..* | Extension |
Extensions
that
cannot
be
ignored
|
|
S
Σ
|
1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
|
Σ
|
0..* | Identifier |
Additional
identifier
for
the
library
|
|
|
1..1 | string | Business version of the library |
| S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) | |
![]() ![]() ![]() | string | |||
![]() ![]() ![]() | Coding | |||
|
S
Σ
|
|
string | Name for this library (computer friendly) |
|
S
Σ
|
|
string | Name for this library (human friendly) |
|
0..1 | string | Subordinate title of the library | |
|
?!
Σ
|
1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required |
|
|
|
boolean | For testing purposes, not real usage |
|
Σ
|
1..1 | CodeableConcept |
logic-library
|
model-definition
|
asset-collection
|
module-definition
Binding: |
|
0..1 |
Type
of
individual
the
library
content
is
focused
on
Binding: |
||
|
CodeableConcept | |||
|
Reference
|
|||
|
|
0..1 | dateTime | Date last changed |
|
|
|
string |
Name
of
the
|
|
|
0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
|
1..1 | markdown | Natural language description of the library |
|
|
0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
|
0..* | CodeableConcept |
Intended
jurisdiction
for
library
(if
applicable)
Binding: Jurisdiction ValueSet ( extensible |
|
0..1 | markdown | Why this library is defined | |
|
0..1 |
|
Describes the clinical usage of the library | |
|
0..1 | markdown | Use and/or publishing restrictions | |
|
0..1 | string | Copyright holder and year(s) | |
![]() ![]() | 0..1 | date | When the library was approved by publisher | |
|
0..1 | date | When the library was last reviewed by the publisher | |
|
Σ
|
0..1 | Period | When the library is expected to be used |
|
|
0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment,
Binding: |
|
0..* | ContactDetail |
Who
authored
the
content
|
|
|
0..* | ContactDetail |
Who
edited
the
content
|
|
|
0..* | ContactDetail |
Who
reviewed
the
content
|
|
|
0..* | ContactDetail |
Who
endorsed
the
content
|
|
|
0..* | RelatedArtifact |
Additional
documentation,
citations,
|
|
|
0..* | ParameterDefinition |
Parameters
defined
by
the
library
|
|
|
0..* | DataRequirement |
What
data
is
referenced
by
this
library
|
|
|
Σ
|
0..* | Attachment |
Contents
of
the
library,
either
embedded
or
referenced
|
Documentation
for
this
format
|
||||
XML Template
<!-- Shareable Library --><!-- ShareableLibrary --><Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension -->
<</id> <</meta> < < <<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> <<a href="shareablelibrary-definitions.html#Library.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<contained><!-- 0..* Resource Contained, inline Resources --></contained> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> < <</identifier> < < < < < < <</type> <</subject[x]> < < <</contact> < < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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> < < < < < <<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> <</author> <</editor> <</reviewer> <</endorser> < Additional documentation, citations, etc.</relatedArtifact> <<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" " " " " "<a href="shareablelibrary-definitions.html#Library.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."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 } ], "Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"> " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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 |
|
|
|
| Library.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
| Library.status | PublicationStatus | required | PublicationStatus |
| Library.type |
|
extensible |
|
| Library.subject[x] |
|
extensible |
|
| Library.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
| Library.topic |
|
example |
|