This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
Responsible
Owner:
Clinical
Decision
Support
Work
Group
|
|
Security Category : Anonymous |
Compartments
:
|
The
Library
resource
is
a
general-purpose
container
for
knowledge
asset
artifact
definitions.
It
can
be
used
to
describe
and
expose
existing
knowledge
assets
artifacts
such
as
logic
libraries
and
information
model
descriptions,
as
well
as
to
describe
a
collection
of
knowledge
assets.
artifacts.
The
Library
resource
is
a
general
purpose
container
knowledge
artifact
that
can
fulfill
a
variety
of
use
cases,
including
managing
collections
of
artifacts,
providing
a
FHIR
wrapper
for
clinical
non-FHIR
knowledge
assets.
These
assets
artifacts,
and
describing
logic
and
interaction
capabilities
of
knowledge
modules.
For
example,
a
Library
may
be
defined
using
used
to
wrap
a
non-FHIR
representation,
such
as
a
shareable
library
of
clinical
logic,
written
in
Clinical
Quality
Language
(CQL),
or
the
XML
Schema
for
an
information
model,
or
they
(CQL)
.
In
addition,
a
Library
may
be
used
to
refer
to
artifacts
defined
using
FHIR
resources
such
as
the
description
of
a
protocol
represented
by
a
PlanDefinition
resource.
In
addition
to
representing
As
a
CanonicalResource
and
MetadataResource,
a
Library
has
all
the
typical
metadata
of
the
library,
such
as
url,
identifier,
version,
and
title.
In
addition,
the
resource
has
elements
for
tracking
dependencies,
as
well
as
for
representing
the
parameters
and
data
requirements
for
any
expression
functionality
provided
by
the
library.
For
non-FHIR
assets,
the
actual
content
of
the
library
is
represented
using
the
Attachment
data
type,
and
may
either
be
referenced
with
a
URL,
or
the
content
may
be
embedded
as
a
base-64
encoded
string.
Either
way,
the
contentType
element
of
the
attachment
is
used
to
indicate
the
representation
of
the
library
content.
Note that because the library content may be embedded as well as be retrievable from an external repository via the attachment URL, the possibility exists for the embedded content to be different from the content on the repository. With proper versioning and governance, this should never occur, but to minimize the potential impact of this possibility, implementers SHALL give precedence to the embedded content of a library when it is present.
A
common
use
case
for
the
Library
resource
is
to
establish
the
release
dependencies
of
a
collection
of
artifacts.
A
library
with
a
type
of
asset-collection
can
be
used
to
define
the
collection
of
artifacts,
as
well
as
the
required
dependencies,
especially
when
the
artifacts
in
the
collection
have
version-independent
canonical
references,
as
is
often
the
case
with
CodeSystem
and
ValueSet
references.
This
usage
is
known
as
an
artifact
manifest
,
and
is
described
more
fully
in
the
Artifact
Manifest
topic
of
the
Canonical
Resource
Management
Infrastructure
implementation
guide.
The
Library
resource
is
definitional
in
nature,
meaning
it
is
intended
to
represent
shareable
knowledge
independent
of
any
particular
patient.
This
is
in
contrast
to
the
DocumentReference
resource,
which
captures
non-FHIR
content
related
to
a
specific
patient,
and
the
Media
and
Binary
resources
which
capture
multimedia
content
and
content,
or
other
raw
binary
content,
respectively.
content.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Represents
a
library
of
quality
improvement
components
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension Interfaces Implemented: MetadataResource |
|
|
Σ C | 0..1 | uri |
Canonical
identifier
for
this
library,
represented
as
a
URI
(globally
unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic |
|
Σ | 0..* | Identifier |
Additional
identifier
for
the
library
|
|
Σ | 0..1 | string |
Business
version
of
the
library
|
|
Σ
|
0..1 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) |
|
|
string | |||
| Coding | |||
![]() ![]() | Σ C | 0..1 | string |
Name
for
this
library
(computer
friendly)
|
|
Σ T | 0..1 | string |
Name
for
this
library
(human
friendly)
|
|
T | 0..1 | string |
Subordinate
title
of
the
library
|
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( Required ) |
|
Σ | 0..1 | boolean |
For
testing
|
|
Σ | 1..1 | CodeableConcept |
logic-library
|
model-definition
|
asset-collection
|
module-definition
|
etc.
Binding: LibraryType
(
Extensible
)
|
|
0..1 |
Type
of
individual
the
library
content
is
focused
on
|
||
|
CodeableConcept | |||
|
Reference ( Group ) | |||
|
Σ | 0..1 | dateTime |
Date
last
changed
|
|
Σ T | 0..1 | string |
Name
of
the
|
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
Σ T | 0..1 | markdown |
Natural
language
description
of
the
library
|
|
Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
Σ | 0..* | CodeableConcept |
Jurisdiction
of
the
authority
that
maintains
the
library
(if
applicable)
Binding: Jurisdiction ValueSet
(
Extensible
)
|
|
T | 0..1 | markdown |
Why
this
library
is
defined
|
|
T | 0..1 |
|
Describes
the
clinical
usage
of
the
library
|
|
T | 0..1 | markdown |
Notice
about
intellectual
property
ownership,
can
include
restrictions
on
use
|
|
T | 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,
|
|
|
0..* | ContactDetail |
Who
authored
the
content
|
|
|
0..* | ContactDetail |
Who
edited
the
content
|
|
|
0..* | ContactDetail |
Who
reviewed
the
content
|
|
|
0..* | ContactDetail |
Who
endorsed
the
content
|
|
|
C | 0..* | RelatedArtifact |
Additional
documentation,
citations,
+ Warning: Dependencies and components of a Library should reference a resource |
|
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
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<<Library xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<<url value="[uri]"/><!-- 0..1 Canonical identifier for this library, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the library --></identifier>< <<version value="[string]"/><!-- 0..1 Business version of the library --> <versionAlgorithm[x]><!-- 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]"/><!-- 0..1 Name for this library (human friendly) --> <subtitle value="[string]"/><!-- 0..1 Subordinate title of the library --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->< <</type> <</subject[x]> < <<experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage --> <type><!-- 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition | etc.--></type> <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the library --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
<</jurisdiction><jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the library (if applicable)--></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this library is defined -->
< <<usage value="[markdown]"/><!-- 0..1 Describes the clinical usage of the library --> <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When the library was approved by publisher --><<lastReviewDate value="[date]"/><!-- 0..1 When the library was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period When the library is expected to be used --></effectivePeriod><</topic><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> <</endorser> <</relatedArtifact><reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <parameter><!-- 0..* ParameterDefinition Parameters defined by the library --></parameter> <dataRequirement><!-- 0..* DataRequirement What data is referenced by this library --></dataRequirement> <content><!-- 0..* Attachment Contents of the library, either embedded or referenced --></content> </Library>
JSON Template
{
"resourceType" : "",
"resourceType" : "Library",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"url" : "<uri>", // Canonical identifier for this library, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // Additional identifier for the library
"
"
"version" : "<string>", // Business version of the library
// versionAlgorithm[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>",
"versionAlgorithmCoding" : { Coding },
"name" : "<string>", // I Name for this library (computer friendly)
"title" : "<string>", // Name for this library (human friendly)
"subtitle" : "<string>", // Subordinate title of the library
"status" : "<code>", // R! draft | active | retired | unknown
"
"
"experimental" : <boolean>, // For testing only - never for real usage
"type" : { CodeableConcept }, // R! logic-library | model-definition | asset-collection | module-definition | etc.
// subject[x]: Type of individual the library content is focused on. One of these 2:
"subjectCodeableConcept" : { CodeableConcept },
"subjectReference" : { Reference(Group) },
"
"
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the library
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"
"jurisdiction" : [{ CodeableConcept }], // Jurisdiction of the authority that maintains the library (if applicable)
"purpose" : "<markdown>", // Why this library is defined
"
"
"usage" : "<markdown>", // Describes the clinical usage of the library
"copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"approvalDate" : "<date>", // When the library was approved by publisher
"
"lastReviewDate" : "<date>", // When the library was last reviewed by the publisher
"effectivePeriod" : { Period }, // When the library is expected to be used
"
"topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
"author" : [{ ContactDetail }], // Who authored the content
"editor" : [{ ContactDetail }], // Who edited the content
"
"
"
"reviewer" : [{ ContactDetail }], // Who reviewed the content
"endorser" : [{ ContactDetail }], // Who endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
"parameter" : [{ ParameterDefinition }], // Parameters defined by the library
"dataRequirement" : [{ DataRequirement }], // What data is referenced by this library
"content" : [{ Attachment }] // Contents of the library, either embedded or referenced
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:;[ a fhir:Library; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir:# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:url [ uri ] ; # 0..1 Canonical identifier for this library, represented as a URI (globally unique) fhir:identifier ( [ Identifier ] ... ) ; # 0..* Additional identifier for the library fhir:version [ string ] ; # 0..1 Business version of the library # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2 fhir:versionAlgorithm [ a fhir:String ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 I Name for this library (computer friendly) fhir:title [ string ] ; # 0..1 Name for this library (human friendly) fhir:subtitle [ string ] ; # 0..1 Subordinate title of the library fhir:status [ code ] ; # 1..1 draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage fhir:type [ CodeableConcept ] ; # 1..1 logic-library | model-definition | asset-collection | module-definition | etc. # subject[x] : 0..1 Type of individual the library content is focused on. One of these 2 fhir:subject [ a fhir:CodeableConcept ; CodeableConcept ] fhir:subject [ a fhir:Reference ; Reference(Group) ] fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher fhir:description [ markdown ] ; # 0..1 Natural language description of the library fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support fhir:jurisdiction ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the library (if applicable) fhir:purpose [ markdown ] ; # 0..1 Why this library is defined fhir:usage [ markdown ] ; # 0..1 Describes the clinical usage of the library fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:approvalDate [ date ] ; # 0..1 When the library was approved by publisher fhir:lastReviewDate [ date ] ; # 0..1 When the library was last reviewed by the publisher fhir:effectivePeriod [ Period ] ; # 0..1 When the library is expected to be used fhir:topic ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc fhir:author ( [ ContactDetail ] ... ) ; # 0..* Who authored the content fhir:editor ( [ ContactDetail ] ... ) ; # 0..* Who edited the content fhir:reviewer ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content fhir:endorser ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content fhir:relatedArtifact ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc fhir:parameter ( [ ParameterDefinition ] ... ) ; # 0..* Parameters defined by the library fhir:dataRequirement ( [ DataRequirement ] ... ) ; # 0..* What data is referenced by this library fhir:content ( [ Attachment ] ... ) ; # 0..* Contents of the library, either embedded or referenced ]
Changes
since
R3
from
both
R4
and
R4B
| Library | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R3
<-->
R4
Conversion
Maps
(status
=
11
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
11
r3
resources
are
invalid
(0
errors).
)
for
R4B
as
XML
or
JSON
.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Represents
a
library
of
quality
improvement
components
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension Interfaces Implemented: MetadataResource |
|
|
Σ C | 0..1 | uri |
Canonical
identifier
for
this
library,
represented
as
a
URI
(globally
unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic |
|
Σ | 0..* | Identifier |
Additional
identifier
for
the
library
|
|
Σ | 0..1 | string |
Business
version
of
the
library
|
|
Σ
|
0..1 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) |
|
|
string | |||
| Coding | |||
![]() ![]() | Σ C | 0..1 | string |
Name
for
this
library
(computer
friendly)
|
|
Σ T | 0..1 | string |
Name
for
this
library
(human
friendly)
|
|
T | 0..1 | string |
Subordinate
title
of
the
library
|
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( Required ) |
|
Σ | 0..1 | boolean |
For
testing
|
|
Σ | 1..1 | CodeableConcept |
logic-library
|
model-definition
|
asset-collection
|
module-definition
|
etc.
Binding: LibraryType
(
Extensible
)
|
|
0..1 |
Type
of
individual
the
library
content
is
focused
on
|
||
|
CodeableConcept | |||
|
Reference ( Group ) | |||
|
Σ | 0..1 | dateTime |
Date
last
changed
|
|
Σ T | 0..1 | string |
Name
of
the
|
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
Σ T | 0..1 | markdown |
Natural
language
description
of
the
library
|
|
Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
Σ | 0..* | CodeableConcept |
Jurisdiction
of
the
authority
that
maintains
the
library
(if
applicable)
Binding: Jurisdiction ValueSet
(
Extensible
)
|
|
T | 0..1 | markdown |
Why
this
library
is
defined
|
|
T | 0..1 |
|
Describes
the
clinical
usage
of
the
library
|
|
T | 0..1 | markdown |
Notice
about
intellectual
property
ownership,
can
include
restrictions
on
use
|
|
T | 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,
|
|
|
0..* | ContactDetail |
Who
authored
the
content
|
|
|
0..* | ContactDetail |
Who
edited
the
content
|
|
|
0..* | ContactDetail |
Who
reviewed
the
content
|
|
|
0..* | ContactDetail |
Who
endorsed
the
content
|
|
|
C | 0..* | RelatedArtifact |
Additional
documentation,
citations,
+ Warning: Dependencies and components of a Library should reference a resource |
|
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
|
||||
See the Extensions for this resource
XML Template
<<Library xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<<url value="[uri]"/><!-- 0..1 Canonical identifier for this library, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the library --></identifier>< <<version value="[string]"/><!-- 0..1 Business version of the library --> <versionAlgorithm[x]><!-- 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]"/><!-- 0..1 Name for this library (human friendly) --> <subtitle value="[string]"/><!-- 0..1 Subordinate title of the library --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->< <</type> <</subject[x]> < <<experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage --> <type><!-- 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition | etc.--></type> <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the library --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
<</jurisdiction><jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the library (if applicable)--></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this library is defined -->
< <<usage value="[markdown]"/><!-- 0..1 Describes the clinical usage of the library --> <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When the library was approved by publisher --><<lastReviewDate value="[date]"/><!-- 0..1 When the library was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period When the library is expected to be used --></effectivePeriod><</topic><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> <</endorser> <</relatedArtifact><reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <parameter><!-- 0..* ParameterDefinition Parameters defined by the library --></parameter> <dataRequirement><!-- 0..* DataRequirement What data is referenced by this library --></dataRequirement> <content><!-- 0..* Attachment Contents of the library, either embedded or referenced --></content> </Library>
JSON Template
{
"resourceType" : "",
"resourceType" : "Library",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"url" : "<uri>", // Canonical identifier for this library, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // Additional identifier for the library
"
"
"version" : "<string>", // Business version of the library
// versionAlgorithm[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>",
"versionAlgorithmCoding" : { Coding },
"name" : "<string>", // I Name for this library (computer friendly)
"title" : "<string>", // Name for this library (human friendly)
"subtitle" : "<string>", // Subordinate title of the library
"status" : "<code>", // R! draft | active | retired | unknown
"
"
"experimental" : <boolean>, // For testing only - never for real usage
"type" : { CodeableConcept }, // R! logic-library | model-definition | asset-collection | module-definition | etc.
// subject[x]: Type of individual the library content is focused on. One of these 2:
"subjectCodeableConcept" : { CodeableConcept },
"subjectReference" : { Reference(Group) },
"
"
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the library
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"
"jurisdiction" : [{ CodeableConcept }], // Jurisdiction of the authority that maintains the library (if applicable)
"purpose" : "<markdown>", // Why this library is defined
"
"
"usage" : "<markdown>", // Describes the clinical usage of the library
"copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"approvalDate" : "<date>", // When the library was approved by publisher
"
"lastReviewDate" : "<date>", // When the library was last reviewed by the publisher
"effectivePeriod" : { Period }, // When the library is expected to be used
"
"topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
"author" : [{ ContactDetail }], // Who authored the content
"editor" : [{ ContactDetail }], // Who edited the content
"
"
"
"reviewer" : [{ ContactDetail }], // Who reviewed the content
"endorser" : [{ ContactDetail }], // Who endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
"parameter" : [{ ParameterDefinition }], // Parameters defined by the library
"dataRequirement" : [{ DataRequirement }], // What data is referenced by this library
"content" : [{ Attachment }] // Contents of the library, either embedded or referenced
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:;[ a fhir:Library; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir:# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:url [ uri ] ; # 0..1 Canonical identifier for this library, represented as a URI (globally unique) fhir:identifier ( [ Identifier ] ... ) ; # 0..* Additional identifier for the library fhir:version [ string ] ; # 0..1 Business version of the library # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2 fhir:versionAlgorithm [ a fhir:String ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 I Name for this library (computer friendly) fhir:title [ string ] ; # 0..1 Name for this library (human friendly) fhir:subtitle [ string ] ; # 0..1 Subordinate title of the library fhir:status [ code ] ; # 1..1 draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage fhir:type [ CodeableConcept ] ; # 1..1 logic-library | model-definition | asset-collection | module-definition | etc. # subject[x] : 0..1 Type of individual the library content is focused on. One of these 2 fhir:subject [ a fhir:CodeableConcept ; CodeableConcept ] fhir:subject [ a fhir:Reference ; Reference(Group) ] fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher fhir:description [ markdown ] ; # 0..1 Natural language description of the library fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support fhir:jurisdiction ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the library (if applicable) fhir:purpose [ markdown ] ; # 0..1 Why this library is defined fhir:usage [ markdown ] ; # 0..1 Describes the clinical usage of the library fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:approvalDate [ date ] ; # 0..1 When the library was approved by publisher fhir:lastReviewDate [ date ] ; # 0..1 When the library was last reviewed by the publisher fhir:effectivePeriod [ Period ] ; # 0..1 When the library is expected to be used fhir:topic ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc fhir:author ( [ ContactDetail ] ... ) ; # 0..* Who authored the content fhir:editor ( [ ContactDetail ] ... ) ; # 0..* Who edited the content fhir:reviewer ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content fhir:endorser ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content fhir:relatedArtifact ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc fhir:parameter ( [ ParameterDefinition ] ... ) ; # 0..* Parameters defined by the library fhir:dataRequirement ( [ DataRequirement ] ... ) ; # 0..* What data is referenced by this library fhir:content ( [ Attachment ] ... ) ; # 0..* Contents of the library, either embedded or referenced ]
Changes
since
Release
3
from
both
R4
and
R4B
| Library | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R3
<-->
R4
Conversion
Maps
(status
=
11
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
11
r3
resources
are
invalid
(0
errors).
)
for
R4B
as
XML
or
JSON
.
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
,
the
extensions
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| Library.versionAlgorithm[x] |
|
|
Indicates the mechanism used to compare versions to determine which is more current. |
| Library.status | PublicationStatus | Required | The lifecycle status of an artifact. |
| Library.type |
![]() |
Extensible |
The type of knowledge asset this library contains. |
| Library.subject[x] |
|
Extensible |
All Resource Types that represent participant resources |
| Library.jurisdiction |
![]() |
Extensible |
This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.
Note:
The
codes
for
countries
and
country
subdivisions
are
taken
from
ISO
3166
|
| Library.topic | DefinitionTopic | Example |
High-level
categorization
of
the
definition,
used
for
searching,
sorting,
and
filtering.
|
|
|
Level | Location | Description | Expression |
cnl-0
|
Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation |
|
cnl-1
| Warning | Library.url | URL should not contain | or # - these characters make processing canonical references problematic | exists() implies matches('^[^|# ]+$') |
lib-2
| Warning | Library.relatedArtifact | Dependencies and components of a Library should reference a resource | type in ('depends-on' | 'composed-of' | 'part-of') implies ((resource.exists() xor resourceReference.exists()) or (artifact is canonical xor artifact is Reference)) |
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| composed-of | reference | What resource is being referenced |
Library.relatedArtifact.where(type='composed-of').resource
(Any) |
5 Resources |
| content-type | token | The type of content in the library (e.g. text/cql) | Library.content.contentType | |
| context | token | A use context assigned to the library |
|
25 Resources |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the library |
|
25 Resources |
| context-type | token | A type of use context assigned to the library | Library.useContext.code | 25 Resources |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the library |
On
Library.useContext:
context-type: code context-quantity: |
25 Resources |
| context-type-value | composite | A use context type and value assigned to the library |
On
Library.useContext:
context-type: code context: |
25 Resources |
| date | date | The library publication date | Library.date | 26 Resources |
| depends-on | reference | What resource is being referenced |
Library.relatedArtifact.where(type='depends-on').resource
(Any) |
5 Resources |
| derived-from | reference | What resource is being referenced |
Library.relatedArtifact.where(type='derived-from').resource
(Any) |
9 Resources |
| description | string | The description of the library | Library.description | 24 Resources |
| effective | date | The time during which the library is intended to be in use | Library.effectivePeriod | 10 Resources |
| experimental | token | Whether the Library is experimental | Library.experimental | |
| identifier | token | External identifier for the library | Library.identifier | 30 Resources |
| jurisdiction | token |
|
Library.jurisdiction | 22 Resources |
| name | string | Computationally friendly name of the library | Library.name | 24 Resources |
| predecessor | reference | What resource is being referenced |
Library.relatedArtifact.where(type='predecessor').resource
(Any) |
9 Resources |
| publisher | string | Name of the publisher of the library | Library.publisher | 26 Resources |
| status | token | The current status of the library | Library.status | 30 Resources |
| subject-canonical | reference | The subject of the Library when expressed as a canonical |
Library.subject
as
canonical
( Group ) |
|
| subject-code |
token
|
The subject of the Library when expressed as a code | Library.subject as CodeableConcept | |
| subject-reference | reference | The subject of the Library when expressed as a reference |
Library.subject
as
Reference
( Group ) | |
| successor | reference | What resource is being referenced |
Library.relatedArtifact.where(type='successor').resource
(Any) |
5 Resources |
| title | string | The human-friendly name of the library | Library.title | 24 Resources |
| topic | token | Topics associated with the module | Library.topic | 10 Resources |
| type | token | The type of the library (e.g. logic-library, model-definition, asset-collection, module-definition) | Library.type | |
| url | uri | The uri that identifies the library | Library.url | 30 Resources |
| version | token | The business version of the library | Library.version | 27 Resources |