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
R3
R2
Vocabulary
Work
Group
|
Maturity
Level
:
|
Trial Use | Use Context : Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/shareablevalueset
Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets
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 ValueSet .
This structure is derived from ValueSet .
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ValueSet | A set of codes drawn from one or more code systems | |
|
1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | |
|
1..1 | string | Business version of the value set | |
|
1..1 | string | Name for this value set (computer friendly) | |
|
1..1 | code | draft | active | retired | unknown | |
|
1..1 | boolean | For testing purposes, not real usage | |
|
1..1 | string | Name of the publisher (organization or individual) | |
|
1..1 | markdown | Natural language description of the value set | |
Documentation
for
this
format
|
||||
| Name | Flags | Card. | Type |
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
I | 1..1 | ValueSet |
A
set
of
codes
drawn
from
one
or
more
code
systems
|
||||
|
Σ | 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
|
||||
|
Σ
|
1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | ||||
|
Σ
|
0..* | Identifier |
Additional
identifier
for
the
value
set
(business
identifier)
|
||||
|
Σ
|
1..1 | string | Business version of the value set | ||||
|
Σ
|
1..1 | string | Name for this value set (computer friendly) | ||||
|
Σ
|
0..1 | string | Name for this value set (human friendly) | ||||
|
?!
Σ
|
1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required |
||||
|
Σ
|
1..1 | boolean | For testing purposes, not real usage | ||||
|
Σ
|
0..1 | dateTime | Date last changed | ||||
|
Σ
|
1..1 | string | Name of the publisher (organization or individual) | ||||
|
Σ
|
0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
|
1..1 | markdown | Natural language description of the value set | ||||
|
Σ
|
0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
||||
|
Σ
|
0..* | CodeableConcept |
Intended
jurisdiction
for
value
set
(if
applicable)
Binding: Jurisdiction ( extensible |
||||
|
Σ
|
0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
|
|
0..1 | markdown | Why this value set is defined | ||||
|
|
0..1 | markdown | Use and/or publishing restrictions | ||||
|
|
0..1 | BackboneElement | Content logical definition of the value set (CLD) | ||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ
|
0..1 | date | Fixed date for references with no specified version (transitive) | ||||
|
Σ
|
0..1 | boolean | Whether inactive codes are in the value set | ||||
|
Σ I | 1..* | BackboneElement |
Include
one
or
more
codes
from
a
code
system
or
other
value
set(s)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ I | 0..1 | uri | The system the codes come from | ||||
|
Σ
|
0..1 | string | Specific version of the code system referred to | ||||
|
I | 0..* | BackboneElement |
A
concept
defined
in
the
system
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
|
1..1 | code | Code or expression from system | ||||
|
|
0..1 | string | Text to display for this code for this value set in this valueset | ||||
|
|
0..* | BackboneElement |
Additional
representations
for
this
concept
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
|
0..1 | code |
Human
language
of
the
designation
Binding: Common Languages ( preferred
|
||||
|
|
0..1 | Coding |
Types
of
uses
of
designations
Binding: Designation Use ( extensible |
||||
|
|
1..1 | string | The text value for this designation | ||||
|
Σ I | 0..* | BackboneElement |
Select
codes/concepts
by
their
properties
(including
relationships)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ
|
1..1 | code | A property/filter defined by the code system | ||||
|
Σ
|
1..1 | code |
=
|
is-a
|
descendent-of
|
is-not-a
|
regex
|
in
|
not-in
|
generalizes
|
exists
Binding: FilterOperator ( required |
||||
|
Σ
|
1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
|
Σ I | 0..* | canonical ( ValueSet ) |
Select
the
contents
included
in
this
value
set
|
||||
|
I | 0..* | See include (ValueSet) |
|
||||
|
|
0..1 | BackboneElement | Used when the value set is "expanded" | ||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
|
0..1 | uri | Identifies the value set expansion (business identifier) | ||||
|
|
1..1 | dateTime | Time ValueSet expansion happened | ||||
|
|
0..1 | integer | Total number of codes in the expansion | ||||
|
|
0..1 | integer | Offset at which this resource starts | ||||
|
|
0..* | BackboneElement |
Parameter
that
controlled
the
expansion
process
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
|
1..1 | string | Name as assigned by the client or server | ||||
|
|
0..1 | Value of the named parameter | |||||
|
string | |||||||
|
boolean | |||||||
|
integer | |||||||
|
decimal | |||||||
|
uri | |||||||
|
code | |||||||
|
dateTime | |||||||
|
I | 0..* | BackboneElement |
Codes
in
the
value
set
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
|
0..1 | uri | System value for the code | ||||
|
|
0..1 | boolean | If user cannot select this entry | ||||
|
|
0..1 | boolean | If concept is inactive in the code system | ||||
|
|
0..1 | string | Version in which this code/display is defined | ||||
|
I | 0..1 | code | Code - if blank, this is not a selectable code | ||||
|
I | 0..1 | string | User display for the concept | ||||
|
|
0..* | See designation (ValueSet) |
|
||||
|
|
0..* | See contains (ValueSet) |
|
||||
Documentation
for
this
format
|
||||||||
<!-- Shareable ValueSet -->![]()
< xmlns="http://hl7.org/fhir"<ValueSet 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]"/><!--
1..1 Canonical identifier for this value set, represented as a URI (globally unique) --> <identifier><!--
0..* Identifier Additional identifier for the value set (business identifier) --></identifier> <version value="[string]"/><!--
1..1 Business version of the value set --> <name value="[string]"/><!--
1..1 Name for this value set (computer friendly) --> <title value="[string]"/><!--
0..1 Name for this value set (human friendly) --> <status value="[code]"/><!--
1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!--
1..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!--
0..1 Date last changed --> <publisher value="[string]"/><!--
1..1 Name of the publisher (organization or individual) --> <contact><!--
0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!--
1..1 Natural language description of the value set --> <useContext><!--
0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!--
0..* CodeableConcept Intended jurisdiction for value set (if applicable) --></jurisdiction> <immutable value="[boolean]"/><!--
0..1 Indicates whether or not any change to the content logical definition may occur --> <purpose value="[markdown]"/><!--
0..1 Why this value set is defined --> <copyright value="[markdown]"/><!--
0..1 Use and/or publishing restrictions -->
<<compose>0..1 BackboneElement <!--
0..1 Content logical definition of the value set (CLD) --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <lockedDate value="[date]"/><!--
0..1 Fixed date for references with no specified version (transitive) --> <inactive value="[boolean]"/><!--
0..1 Whether inactive codes are in the value set -->
<<include>1..* BackboneElement <!--
1..* Include one or more codes from a code system or other value set(s) --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <system value="[uri]"/><!--
0..1 The system the codes come from --> <version value="[string]"/><!--
0..1 Specific version of the code system referred to -->
<<concept>0..* BackboneElement <!--
0..* A concept defined in the system --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!--
1..1 Code or expression from system --> <display value="[string]"/><!--
0..1 Text to display for this code for this value set in this valueset -->
<<designation>0..* BackboneElement <!--
0..* Additional representations for this concept --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <language value="[code]"/><!--
0..1 Human language of the designation --> <use><!--
0..1 Coding Types of uses of designations --></use> <value value="[string]"/><!--
1..1 The text value for this designation --> </designation> </concept>
<<filter>0..* BackboneElement <!--
0..* Select codes/concepts by their properties (including relationships) --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <property value="[code]"/><!--
1..1 A property/filter defined by the code system --> <op value="[code]"/><!--
1..1 = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists --> <value value="[string]"/><!--
1..1 Code from the system, or regex criteria, or boolean value for exists --> </filter> <valueSet value="[canonical]"/><!--
0..* Select the contents included in this value set --> </include>
<</exclude><exclude><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include Explicitly exclude codes from a code system or other value sets --></exclude> </compose><<expansion>0..1 BackboneElement <!--
0..1 Used when the value set is "expanded" --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <identifier value="[uri]"/><!--
0..1 Identifies the value set expansion (business identifier) --> <timestamp value="[dateTime]"/><!--
1..1 Time ValueSet expansion happened --> <total value="[integer]"/><!--
0..1 Total number of codes in the expansion --> <offset value="[integer]"/><!--
0..1 Offset at which this resource starts -->
<<parameter>0..* BackboneElement <!--
0..* Parameter that controlled the expansion process --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!--
1..1 Name as assigned by the client or server --> <value[x]><!--
0..1 string|boolean|integer| decimal|uri|code|dateTime Value of the named parameter --></value[x]> </parameter>
<<contains>0..* BackboneElement <!--
0..* Codes in the value set --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <system value="[uri]"/><!--
0..1 System value for the code --> <abstract value="[boolean]"/><!--
0..1 If user cannot select this entry --> <inactive value="[boolean]"/><!--
0..1 If concept is inactive in the code system --> <version value="[string]"/><!--
0..1 Version in which this code/display is defined --> <code value="[code]"/><!--
0..1 Code - if blank, this is not a selectable code --> <display value="[string]"/><!--
0..1 User display for the concept -->
<</designation> <</contains><designation><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include.concept.designation Additional representations for this item --></designation> <contains><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains Codes contained under this entry --></contains> </contains> </expansion> </ValueSet>
{ // Shareable ValueSet
// 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? R! Canonical identifier for this value set, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // C?Additional identifier for the value set (business identifier)
"version" : "<string>", // C? R! Business version of the value set
"name" : "<string>", // C? R! Name for this value set (computer friendly)
"title" : "<string>", // C?Name for this value set (human friendly)
"status" : "<code>", // C? R! draft | active | retired | unknown
"experimental" : <boolean>, // C? R! For testing purposes, not real usage
"date" : "<dateTime>", // C?Date last changed
"publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // C?Contact details for the publisher
"description" : "<markdown>", // C? R! Natural language description of the value set
"useContext" : [{ UsageContext }], // C?The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for value set (if applicable)
"immutable" : <boolean>, // C?Indicates whether or not any change to the content logical definition may occur
"purpose" : "<markdown>", // C?Why this value set is defined
"copyright" : "<markdown>", // C?Use and/or publishing restrictions
"
"
"compose" : { BackboneElement }, // C?Content logical definition of the value set (CLD)
"expansion" : { BackboneElement } // C?Used when the value set is "expanded"
}
This structure is derived from ValueSet .
Differential View
This structure is derived from ValueSet .
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ValueSet | A set of codes drawn from one or more code systems | |
|
1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | |
|
1..1 | string | Business version of the value set | |
|
1..1 | string | Name for this value set (computer friendly) | |
|
1..1 | code | draft | active | retired | unknown | |
|
1..1 | boolean | For testing purposes, not real usage | |
|
1..1 | string | Name of the publisher (organization or individual) | |
|
1..1 | markdown | Natural language description of the value set | |
Documentation
for
this
format
|
||||
Snapshot View
| Name | Flags | Card. | Type |
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
I | 1..1 | ValueSet |
A
set
of
codes
drawn
from
one
or
more
code
systems
|
||||
|
Σ | 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
|
||||
|
Σ
|
1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | ||||
|
Σ
|
0..* | Identifier |
Additional
identifier
for
the
value
set
(business
identifier)
|
||||
|
Σ
|
1..1 | string | Business version of the value set | ||||
|
Σ
|
1..1 | string | Name for this value set (computer friendly) | ||||
|
Σ
|
0..1 | string | Name for this value set (human friendly) | ||||
|
?!
Σ
|
1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required |
||||
|
Σ
|
1..1 | boolean | For testing purposes, not real usage | ||||
|
Σ
|
0..1 | dateTime | Date last changed | ||||
|
Σ
|
1..1 | string | Name of the publisher (organization or individual) | ||||
|
Σ
|
0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
|
1..1 | markdown | Natural language description of the value set | ||||
|
Σ
|
0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
||||
|
Σ
|
0..* | CodeableConcept |
Intended
jurisdiction
for
value
set
(if
applicable)
Binding: Jurisdiction ( extensible |
||||
|
Σ
|
0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
|
|
0..1 | markdown | Why this value set is defined | ||||
|
|
0..1 | markdown | Use and/or publishing restrictions | ||||
|
|
0..1 | BackboneElement | Content logical definition of the value set (CLD) | ||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ
|
0..1 | date | Fixed date for references with no specified version (transitive) | ||||
|
Σ
|
0..1 | boolean | Whether inactive codes are in the value set | ||||
|
Σ I | 1..* | BackboneElement |
Include
one
or
more
codes
from
a
code
system
or
other
value
set(s)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ I | 0..1 | uri | The system the codes come from | ||||
|
Σ
|
0..1 | string | Specific version of the code system referred to | ||||
|
I | 0..* | BackboneElement |
A
concept
defined
in
the
system
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
|
1..1 | code | Code or expression from system | ||||
|
|
0..1 | string | Text to display for this code for this value set in this valueset | ||||
|
|
0..* | BackboneElement |
Additional
representations
for
this
concept
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
|
0..1 | code |
Human
language
of
the
designation
Binding: Common Languages ( preferred
|
||||
|
|
0..1 | Coding |
Types
of
uses
of
designations
Binding: Designation Use ( extensible |
||||
|
|
1..1 | string | The text value for this designation | ||||
|
Σ I | 0..* | BackboneElement |
Select
codes/concepts
by
their
properties
(including
relationships)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ
|
1..1 | code | A property/filter defined by the code system | ||||
|
Σ
|
1..1 | code |
=
|
is-a
|
descendent-of
|
is-not-a
|
regex
|
in
|
not-in
|
generalizes
|
exists
Binding: FilterOperator ( required |
||||
|
Σ
|
1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
|
Σ I | 0..* | canonical ( ValueSet ) |
Select
the
contents
included
in
this
value
set
|
||||
|
I | 0..* | See include (ValueSet) |
|
||||
|
|
0..1 | BackboneElement | Used when the value set is "expanded" | ||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
|
0..1 | uri | Identifies the value set expansion (business identifier) | ||||
|
|
1..1 | dateTime | Time ValueSet expansion happened | ||||
|
|
0..1 | integer | Total number of codes in the expansion | ||||
|
|
0..1 | integer | Offset at which this resource starts | ||||
|
|
0..* | BackboneElement |
Parameter
that
controlled
the
expansion
process
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
|
1..1 | string | Name as assigned by the client or server | ||||
|
|
0..1 | Value of the named parameter | |||||
|
string | |||||||
|
boolean | |||||||
|
integer | |||||||
|
decimal | |||||||
|
uri | |||||||
|
code | |||||||
|
dateTime | |||||||
|
I | 0..* | BackboneElement |
Codes
in
the
value
set
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
||||
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
|
0..1 | uri | System value for the code | ||||
|
|
0..1 | boolean | If user cannot select this entry | ||||
|
|
0..1 | boolean | If concept is inactive in the code system | ||||
|
|
0..1 | string | Version in which this code/display is defined | ||||
|
I | 0..1 | code | Code - if blank, this is not a selectable code | ||||
|
I | 0..1 | string | User display for the concept | ||||
|
|
0..* | See designation (ValueSet) |
|
||||
|
|
0..* | See contains (ValueSet) |
|
||||
Documentation
for
this
format
|
||||||||
XML Template
<!-- Shareable ValueSet -->![]()
< xmlns="http://hl7.org/fhir"<ValueSet 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]"/><!--
1..1 Canonical identifier for this value set, represented as a URI (globally unique) --> <identifier><!--
0..* Identifier Additional identifier for the value set (business identifier) --></identifier> <version value="[string]"/><!--
1..1 Business version of the value set --> <name value="[string]"/><!--
1..1 Name for this value set (computer friendly) --> <title value="[string]"/><!--
0..1 Name for this value set (human friendly) --> <status value="[code]"/><!--
1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!--
1..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!--
0..1 Date last changed --> <publisher value="[string]"/><!--
1..1 Name of the publisher (organization or individual) --> <contact><!--
0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!--
1..1 Natural language description of the value set --> <useContext><!--
0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!--
0..* CodeableConcept Intended jurisdiction for value set (if applicable) --></jurisdiction> <immutable value="[boolean]"/><!--
0..1 Indicates whether or not any change to the content logical definition may occur --> <purpose value="[markdown]"/><!--
0..1 Why this value set is defined --> <copyright value="[markdown]"/><!--
0..1 Use and/or publishing restrictions -->
<<compose>0..1 BackboneElement <!--
0..1 Content logical definition of the value set (CLD) --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <lockedDate value="[date]"/><!--
0..1 Fixed date for references with no specified version (transitive) --> <inactive value="[boolean]"/><!--
0..1 Whether inactive codes are in the value set -->
<<include>1..* BackboneElement <!--
1..* Include one or more codes from a code system or other value set(s) --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <system value="[uri]"/><!--
0..1 The system the codes come from --> <version value="[string]"/><!--
0..1 Specific version of the code system referred to -->
<<concept>0..* BackboneElement <!--
0..* A concept defined in the system --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!--
1..1 Code or expression from system --> <display value="[string]"/><!--
0..1 Text to display for this code for this value set in this valueset -->
<<designation>0..* BackboneElement <!--
0..* Additional representations for this concept --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <language value="[code]"/><!--
0..1 Human language of the designation --> <use><!--
0..1 Coding Types of uses of designations --></use> <value value="[string]"/><!--
1..1 The text value for this designation --> </designation> </concept>
<<filter>0..* BackboneElement <!--
0..* Select codes/concepts by their properties (including relationships) --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <property value="[code]"/><!--
1..1 A property/filter defined by the code system --> <op value="[code]"/><!--
1..1 = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists --> <value value="[string]"/><!--
1..1 Code from the system, or regex criteria, or boolean value for exists --> </filter> <valueSet value="[canonical]"/><!--
0..* Select the contents included in this value set --> </include>
<</exclude><exclude><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include Explicitly exclude codes from a code system or other value sets --></exclude> </compose><<expansion>0..1 BackboneElement <!--
0..1 Used when the value set is "expanded" --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <identifier value="[uri]"/><!--
0..1 Identifies the value set expansion (business identifier) --> <timestamp value="[dateTime]"/><!--
1..1 Time ValueSet expansion happened --> <total value="[integer]"/><!--
0..1 Total number of codes in the expansion --> <offset value="[integer]"/><!--
0..1 Offset at which this resource starts -->
<<parameter>0..* BackboneElement <!--
0..* Parameter that controlled the expansion process --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!--
1..1 Name as assigned by the client or server --> <value[x]><!--
0..1 string|boolean|integer| decimal|uri|code|dateTime Value of the named parameter --></value[x]> </parameter>
<<contains>0..* BackboneElement <!--
0..* Codes in the value set --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <system value="[uri]"/><!--
0..1 System value for the code --> <abstract value="[boolean]"/><!--
0..1 If user cannot select this entry --> <inactive value="[boolean]"/><!--
0..1 If concept is inactive in the code system --> <version value="[string]"/><!--
0..1 Version in which this code/display is defined --> <code value="[code]"/><!--
0..1 Code - if blank, this is not a selectable code --> <display value="[string]"/><!--
0..1 User display for the concept -->
<</designation> <</contains><designation><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include.concept.designation Additional representations for this item --></designation> <contains><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains Codes contained under this entry --></contains> </contains> </expansion> </ValueSet>
JSON Template
{ // Shareable ValueSet
// 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? R! Canonical identifier for this value set, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // C?Additional identifier for the value set (business identifier)
"version" : "<string>", // C? R! Business version of the value set
"name" : "<string>", // C? R! Name for this value set (computer friendly)
"title" : "<string>", // C?Name for this value set (human friendly)
"status" : "<code>", // C? R! draft | active | retired | unknown
"experimental" : <boolean>, // C? R! For testing purposes, not real usage
"date" : "<dateTime>", // C?Date last changed
"publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // C?Contact details for the publisher
"description" : "<markdown>", // C? R! Natural language description of the value set
"useContext" : [{ UsageContext }], // C?The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for value set (if applicable)
"immutable" : <boolean>, // C?Indicates whether or not any change to the content logical definition may occur
"purpose" : "<markdown>", // C?Why this value set is defined
"copyright" : "<markdown>", // C?Use and/or publishing restrictions
"
"
"compose" : { BackboneElement }, // C?Content logical definition of the value set (CLD)
"expansion" : { BackboneElement } // C?Used when the value set is "expanded"
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| ValueSet.language | Common Languages | preferred | Common Languages |
| ValueSet.status | PublicationStatus | required | PublicationStatus |
| ValueSet.jurisdiction | Jurisdiction | extensible | Jurisdiction |
| ValueSet.compose.include.concept.designation.language | Common Languages | preferred | Common Languages |
| ValueSet.compose.include.concept.designation.use | Designation Use | extensible | Designation Use |
| ValueSet.compose.include.filter.op | FilterOperator | required | FilterOperator |