This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v4.3.0:
R4B
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R4B
R4
Clinical
Decision
Support
Work
Group
|
Maturity
Level
:
|
Trial Use | Use Context : Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/cqllibrary
Represents a CQL logic library
This
profile
was
published
on
[no
date]
Thu,
Jan
1,
1970
00:00+1000
as
a
draft
by
HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from Library .
This structure is derived from Library .
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | Library | Represents a library of quality improvement components | |
|
1..1 | CodeableConcept |
logic-library
|
model-definition
|
asset-collection
|
module-definition
Fixed Value: As shown |
|
|
1..1 | Coding |
Code
defined
by
a
terminology
system
Fixed Value: (complex) |
|
|
1..1 | uri |
Identity
of
the
terminology
system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type |
|
|
1..1 | code |
Symbol
in
syntax
defined
by
the
system
Fixed Value: logic-library |
|
|
1..1 | string |
Representation
defined
by
the
system
Fixed Value: Logic Library |
|
|
S | 0..* | ParameterDefinition |
Parameters
defined
by
the
library
|
|
S | 0..* | DataRequirement |
What
data
is
referenced
by
this
library
|
Documentation
for
this
format
|
||||
| Name | Flags | Card. | Type |
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
I | 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: Common Languages ( preferred
|
||||
|
|
0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
|
0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
Σ
|
0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
|
Σ
|
0..* | Identifier |
Additional
identifier
for
the
library
|
||||
|
Σ
|
0..1 | string | Business version of the library | ||||
|
Σ I | 0..1 | string | Name for this library (computer friendly) | ||||
|
Σ
|
0..1 | 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 |
||||
|
Σ
|
0..1 | boolean | For testing purposes, not real usage | ||||
|
Σ
|
1..1 | CodeableConcept |
logic-library
|
model-definition
|
asset-collection
|
module-definition
Binding: LibraryType ( extensible Fixed Value: As shown |
||||
|
0..0 | string | Unique id for inter-element referencing | |||||
|
0..0 | Extension | Additional content defined by implementations | |||||
|
1..1 | Coding |
Code
defined
by
a
terminology
system
Fixed Value: (complex) |
|||||
|
0..0 | string | Unique id for inter-element referencing | |||||
|
0..0 | Extension | Additional content defined by implementations | |||||
|
1..1 | uri |
Identity
of
the
terminology
system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type |
|||||
|
0..0 | string | Version of the system - if relevant | |||||
|
1..1 | code |
Symbol
in
syntax
defined
by
the
system
Fixed Value: logic-library |
|||||
|
1..1 | string |
Representation
defined
by
the
system
Fixed Value: Logic Library |
|||||
|
0..0 | boolean | If this coding was chosen directly by the user | |||||
|
0..0 | string | Plain text representation of the concept | |||||
|
|
0..1 |
Type
of
individual
the
library
content
is
focused
on
Binding: Subject type ( extensible |
|||||
|
CodeableConcept | |||||||
|
Reference
|
|||||||
|
Σ
|
0..1 | dateTime | Date last changed | ||||
|
Σ
|
0..1 | string | Name of the publisher (organization or individual) | ||||
|
Σ
|
0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
Σ
|
0..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 ( extensible |
||||
|
|
0..1 | markdown | Why this library is defined | ||||
|
|
0..1 | string | Describes the clinical usage of the library | ||||
|
|
0..1 | markdown | Use and/or publishing restrictions | ||||
|
|
0..1 | date | When the library was approved by publisher | ||||
|
|
0..1 | date | When the library was last reviewed | ||||
|
Σ
|
0..1 | Period | When the library is expected to be used | ||||
|
|
0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment,
etc.
Binding: DefinitionTopic ( example |
||||
|
|
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,
etc.
|
||||
|
S
|
0..* | ParameterDefinition |
Parameters
defined
by
the
library
|
||||
|
S
|
0..* | DataRequirement |
What
data
is
referenced
by
this
library
|
||||
|
Σ
|
0..* | Attachment |
Contents
of
the
library,
either
embedded
or
referenced
|
||||
Documentation
for
this
format
|
||||||||
<!-- CQL Library --><Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension -->
<</id><id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!--0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
0..1 A set of rules under which this content was created --> <language value="[code]"/><!--
0..1 Language of the resource content --> <text><!--
0..1 Narrative Text summary of the resource, for human interpretation --></text>
<</contained><contained><!--0..* Resource Contained, inline Resources --></contained> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored --></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 --> <name value="[string]"/><!--
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 --> <experimental value="[boolean]"/><!--
0..1 For testing purposes, not real usage --> <type><!--
1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type> <subject[x]><!--
0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]> <date value="[dateTime]"/><!--
0..1 Date last changed --> <publisher value="[string]"/><!--
0..1 Name of the publisher (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><!--
0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!--
0..1 Why this library is defined --> <usage value="[string]"/><!--
0..1 Describes the clinical usage of the library --> <copyright value="[markdown]"/><!--
0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!--
0..1 When the library was approved by publisher --> <lastReviewDate value="[date]"/><!--
0..1 When the library was last reviewed --> <effectivePeriod><!--
0..1 Period When the library is expected to be used --></effectivePeriod> <topic><!--
0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic> <author><!--
0..* ContactDetail Who authored the content --></author> <editor><!--
0..* ContactDetail Who edited the content --></editor> <reviewer><!--
0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!--
0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!--
0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <parameter><!--
0..* ParameterDefinition Parameters defined by the library --></parameter> <dataRequirement><!--
0..* DataRequirement What data is referenced by this library --></dataRequirement> <content><!--
0..* Attachment Contents of the library, either embedded or referenced --></content> </Library>
{ // CQL Library
// from Element: extension
"meta" : { Meta }, // C?Metadata about the resource
"implicitRules" : "<uri>", // C?A set of rules under which this content was created
"language" : "<code>", // C?Language of the resource content
"text" : { Narrative }, // C?Text summary of the resource, for human interpretation
"
"contained" : [{ Resource }], // C?Contained, inline Resources
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
"url" : "<uri>", // C?Canonical identifier for this library, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // C?Additional identifier for the library
"version" : "<string>", // C?Business version of the library
"name" : "<string>", // C?Name for this library (computer friendly)
"title" : "<string>", // C?Name for this library (human friendly)
"subtitle" : "<string>", // C?Subordinate title of the library
"status" : "<code>", // C? R! draft | active | retired | unknown
"experimental" : <boolean>, // C?For testing purposes, not real usage
"type" : { CodeableConcept }, // C? R!
// value[x]: Type of individual the library content is focused on. One of these 2:
"subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the library content is focused on
"subjectReference" : { Reference(Group) }, // C?Type of individual the library content is focused on
"date" : "<dateTime>", // C?Date last changed
"publisher" : "<string>", // C?Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // C?Contact details for the publisher
"description" : "<markdown>", // C?Natural language description of the library
"useContext" : [{ UsageContext }], // C?The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for library (if applicable)
"purpose" : "<markdown>", // C?Why this library is defined
"usage" : "<string>", // C?Describes the clinical usage of the library
"copyright" : "<markdown>", // C?Use and/or publishing restrictions
"approvalDate" : "<date>", // C?When the library was approved by publisher
"lastReviewDate" : "<date>", // C?When the library was last reviewed
"effectivePeriod" : { Period }, // C?When the library is expected to be used
"topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc.
"author" : [{ ContactDetail }], // C?Who authored the content
"editor" : [{ ContactDetail }], // C?Who edited the content
"reviewer" : [{ ContactDetail }], // C?Who reviewed the content
"endorser" : [{ ContactDetail }], // C?Who endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
"parameter" : [{ ParameterDefinition }], // C?Parameters defined by the library
"dataRequirement" : [{ DataRequirement }] // C?What data is referenced by this library
"content" : [{ Attachment }], // C?Contents of the library, either embedded or referenced
}
This structure is derived from Library .
Differential View
This structure is derived from Library .
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | Library | Represents a library of quality improvement components | |
|
1..1 | CodeableConcept |
logic-library
|
model-definition
|
asset-collection
|
module-definition
Fixed Value: As shown |
|
|
1..1 | Coding |
Code
defined
by
a
terminology
system
Fixed Value: (complex) |
|
|
1..1 | uri |
Identity
of
the
terminology
system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type |
|
|
1..1 | code |
Symbol
in
syntax
defined
by
the
system
Fixed Value: logic-library |
|
|
1..1 | string |
Representation
defined
by
the
system
Fixed Value: Logic Library |
|
|
S | 0..* | ParameterDefinition |
Parameters
defined
by
the
library
|
|
S | 0..* | DataRequirement |
What
data
is
referenced
by
this
library
|
Documentation
for
this
format
|
||||
Snapshot View
| Name | Flags | Card. | Type |
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
I | 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: Common Languages ( preferred
|
||||
|
|
0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
|
0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
Σ
|
0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
|
Σ
|
0..* | Identifier |
Additional
identifier
for
the
library
|
||||
|
Σ
|
0..1 | string | Business version of the library | ||||
|
Σ I | 0..1 | string | Name for this library (computer friendly) | ||||
|
Σ
|
0..1 | 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 |
||||
|
Σ
|
0..1 | boolean | For testing purposes, not real usage | ||||
|
Σ
|
1..1 | CodeableConcept |
logic-library
|
model-definition
|
asset-collection
|
module-definition
Binding: LibraryType ( extensible Fixed Value: As shown |
||||
|
0..0 | string | Unique id for inter-element referencing | |||||
|
0..0 | Extension | Additional content defined by implementations | |||||
|
1..1 | Coding |
Code
defined
by
a
terminology
system
Fixed Value: (complex) |
|||||
|
0..0 | string | Unique id for inter-element referencing | |||||
|
0..0 | Extension | Additional content defined by implementations | |||||
|
1..1 | uri |
Identity
of
the
terminology
system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type |
|||||
|
0..0 | string | Version of the system - if relevant | |||||
|
1..1 | code |
Symbol
in
syntax
defined
by
the
system
Fixed Value: logic-library |
|||||
|
1..1 | string |
Representation
defined
by
the
system
Fixed Value: Logic Library |
|||||
|
0..0 | boolean | If this coding was chosen directly by the user | |||||
|
0..0 | string | Plain text representation of the concept | |||||
|
|
0..1 |
Type
of
individual
the
library
content
is
focused
on
Binding: Subject type ( extensible |
|||||
|
CodeableConcept | |||||||
|
Reference
|
|||||||
|
Σ
|
0..1 | dateTime | Date last changed | ||||
|
Σ
|
0..1 | string | Name of the publisher (organization or individual) | ||||
|
Σ
|
0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
Σ
|
0..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 ( extensible |
||||
|
|
0..1 | markdown | Why this library is defined | ||||
|
|
0..1 | string | Describes the clinical usage of the library | ||||
|
|
0..1 | markdown | Use and/or publishing restrictions | ||||
|
|
0..1 | date | When the library was approved by publisher | ||||
|
|
0..1 | date | When the library was last reviewed | ||||
|
Σ
|
0..1 | Period | When the library is expected to be used | ||||
|
|
0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment,
etc.
Binding: DefinitionTopic ( example |
||||
|
|
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,
etc.
|
||||
|
S
|
0..* | ParameterDefinition |
Parameters
defined
by
the
library
|
||||
|
S
|
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
<!-- CQL Library --><Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension -->
<</id><id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!--0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
0..1 A set of rules under which this content was created --> <language value="[code]"/><!--
0..1 Language of the resource content --> <text><!--
0..1 Narrative Text summary of the resource, for human interpretation --></text>
<</contained><contained><!--0..* Resource Contained, inline Resources --></contained> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored --></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 --> <name value="[string]"/><!--
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 --> <experimental value="[boolean]"/><!--
0..1 For testing purposes, not real usage --> <type><!--
1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type> <subject[x]><!--
0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]> <date value="[dateTime]"/><!--
0..1 Date last changed --> <publisher value="[string]"/><!--
0..1 Name of the publisher (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><!--
0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!--
0..1 Why this library is defined --> <usage value="[string]"/><!--
0..1 Describes the clinical usage of the library --> <copyright value="[markdown]"/><!--
0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!--
0..1 When the library was approved by publisher --> <lastReviewDate value="[date]"/><!--
0..1 When the library was last reviewed --> <effectivePeriod><!--
0..1 Period When the library is expected to be used --></effectivePeriod> <topic><!--
0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic> <author><!--
0..* ContactDetail Who authored the content --></author> <editor><!--
0..* ContactDetail Who edited the content --></editor> <reviewer><!--
0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!--
0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!--
0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <parameter><!--
0..* ParameterDefinition Parameters defined by the library --></parameter> <dataRequirement><!--
0..* DataRequirement What data is referenced by this library --></dataRequirement> <content><!--
0..* Attachment Contents of the library, either embedded or referenced --></content> </Library>
JSON Template
{ // CQL Library
// from Element: extension
"meta" : { Meta }, // C?Metadata about the resource
"implicitRules" : "<uri>", // C?A set of rules under which this content was created
"language" : "<code>", // C?Language of the resource content
"text" : { Narrative }, // C?Text summary of the resource, for human interpretation
"
"contained" : [{ Resource }], // C?Contained, inline Resources
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
"url" : "<uri>", // C?Canonical identifier for this library, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // C?Additional identifier for the library
"version" : "<string>", // C?Business version of the library
"name" : "<string>", // C?Name for this library (computer friendly)
"title" : "<string>", // C?Name for this library (human friendly)
"subtitle" : "<string>", // C?Subordinate title of the library
"status" : "<code>", // C? R! draft | active | retired | unknown
"experimental" : <boolean>, // C?For testing purposes, not real usage
"type" : { CodeableConcept }, // C? R!
// value[x]: Type of individual the library content is focused on. One of these 2:
"subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the library content is focused on
"subjectReference" : { Reference(Group) }, // C?Type of individual the library content is focused on
"date" : "<dateTime>", // C?Date last changed
"publisher" : "<string>", // C?Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // C?Contact details for the publisher
"description" : "<markdown>", // C?Natural language description of the library
"useContext" : [{ UsageContext }], // C?The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for library (if applicable)
"purpose" : "<markdown>", // C?Why this library is defined
"usage" : "<string>", // C?Describes the clinical usage of the library
"copyright" : "<markdown>", // C?Use and/or publishing restrictions
"approvalDate" : "<date>", // C?When the library was approved by publisher
"lastReviewDate" : "<date>", // C?When the library was last reviewed
"effectivePeriod" : { Period }, // C?When the library is expected to be used
"topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc.
"author" : [{ ContactDetail }], // C?Who authored the content
"editor" : [{ ContactDetail }], // C?Who edited the content
"reviewer" : [{ ContactDetail }], // C?Who reviewed the content
"endorser" : [{ ContactDetail }], // C?Who endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
"parameter" : [{ ParameterDefinition }], // C?Parameters defined by the library
"dataRequirement" : [{ DataRequirement }] // C?What data is referenced by this library
"content" : [{ Attachment }], // C?Contents of the library, either embedded or referenced
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| Library.language | Common Languages | preferred | Common Languages |
| Library.status | PublicationStatus | required | PublicationStatus |
| Library.type | LibraryType | extensible | LibraryType |
| Library.subject[x] | Subject type | extensible | Subject type |
| Library.jurisdiction | Jurisdiction | extensible | Jurisdiction |
| Library.topic | DefinitionTopic | example | DefinitionTopic |