This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot2:
Release
6
Ballot
(2nd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
Terminology
Infrastructure
Work
Group
|
Maturity Level : 0 | Trial Use | Use Context : Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/executablevalueset
Defines an executable value set as one that SHALL have an expansion included, as well as a usage warning indicating the expansion is a point-in-time snapshot and must be maintained over time for production usage. The value set expansion specifies the timestamp when the expansion was produced, SHOULD contain the parameters used for the expansion, and SHALL contain the codes that are obtained by evaluating the value set definition. If this is ONLY an executable value set, a computable definition of the value set must be obtained to compute the updated expansion.
This
profile
was
published
on
Thu,
Jan
1,
1970
00:00+1000
00:00+0800
as
a
draft
by
HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from ShareableValueSet .
Summary
mustSupport
When this profile has defined an element as mustSupport, the sender must provide the element value when available, and the receiver must accept the element value, persist the value and when appropriate, provide function as defined in the profile. When mustSupport is defined at a complex element level, all sub-elements inherit mustSupport.
Mandatory:
3
4
elements
(+1
nested
mandatory
element)
Must-Support:
19
elements
Fixed
Value:
1
element
Extensions
This structure refers to these extensions:
This indicates the differences between this profile and the base ShareableValueSet structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ShareableValueSet | A set of codes drawn from one or more code systems | |
|
|
1.. * | Extension |
Slice: Unordered, Open by value:url |
|
S | 1..1 | (Complex) |
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning |
|
S | 1..1 | markdown |
Value
of
extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. |
|
S
C
|
1..1 | BackboneElement |
Used
when
the
value
set
is
"expanded"
evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. |
|
S | 0 .. 1 | uri | Identifies the value set expansion (business identifier) |
|
S | 1 .. 1 | dateTime | Time ValueSet expansion happened |
|
S | 0 .. 1 | integer | Total number of codes in the expansion |
|
S | 0 .. 1 | integer | Offset at which this resource starts |
|
S | 0 .. * | BackboneElement | Parameter that controlled the expansion process |
|
S | 0 .. * | BackboneElement | Codes in the value set |
|
S | 0 .. 1 | uri | System value for the code |
|
S | 0 .. 1 | boolean | If user cannot select this entry |
|
S | 0 .. 1 | boolean | If concept is inactive in the code system |
|
S
C
|
0 .. 1 | string | Version in which this code/display is defined |
|
S | 1..1 | code | Code - if blank, this is not a selectable code |
|
S | 0 .. 1 | string | User display for the concept |
|
S | 0 .. * | BackboneElement | Property value for the concept |
|
S | 1 .. 1 | code | Reference to ValueSet.expansion.property.code |
|
S | 1 .. 1 | code , Coding , string , integer , boolean , dateTime , decimal | Value of the property for this concept |
|
S | 0 .. * | Codes contained under this entry | |
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableValueSet structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
|
1..1 | ShareableValueSet |
A
set
of
codes
drawn
from
one
or
more
code
systems
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
||||
|
Σ | 0..1 | id | 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: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
|
Extension |
Extension
Slice: Unordered, Open by value:url |
|||||
|
S | 0..* | code |
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
||||
|
S | 0..1 | uri |
Reference
to
the
current
trusted
source
of
the
ValueSet
resource
(metadata
and
definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource |
||||
|
S | 1..1 |
|
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning |
||||
|
0..1 | id | Unique id for inter-element referencing | |||||
|
0..0 | |||||||
|
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning" | |||||
|
S | 1..1 | markdown |
Value
of
extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. |
||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
S
Σ
C
|
1..1 | uri |
Canonical
identifier
for
this
value
set,
represented
as
a
URI
(globally
unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic |
||||
|
Σ | 0..* | Identifier |
Additional
identifier
for
the
value
set
(business
identifier)
|
||||
|
S Σ | 1..1 | string | Business version of the value set | ||||
|
S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) |
|||||
|
string | |||||||
|
Coding | |||||||
|
S
Σ
C
|
0..1 | string | Name for this value set (computer friendly) | ||||
|
S Σ | 1..1 | string | Name for this value set (human friendly) | ||||
|
?! S Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact. |
||||
|
S Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
|
Σ | 0..1 | dateTime | Date last changed | ||||
|
S Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
S | 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 ValueSet ( extensible ): Countries and regions within which this artifact is targeted for use. |
||||
|
Σ | 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 | string | Copyright holder and year(s) | ||||
|
|
0..1 | date | When the ValueSet was approved by publisher | ||||
|
|
0..1 | date | When the ValueSet was last reviewed by the publisher | ||||
|
Σ
|
0..1 | Period | When the ValueSet is expected to be used | ||||
|
|
0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment,
etc
Binding: Definition Topic ( example ) |
||||
|
|
0..* | ContactDetail |
Who
authored
the
ValueSet
|
||||
|
|
0..* | ContactDetail |
Who
edited
the
ValueSet
|
||||
|
|
0..* | ContactDetail |
Who
reviewed
the
ValueSet
|
||||
|
|
0..* | ContactDetail |
Who
endorsed
the
ValueSet
|
||||
|
|
0..* | RelatedArtifact |
Additional
documentation,
citations,
etc
|
||||
|
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 | ||||
|
Σ
C
|
1..* | BackboneElement |
Include
one
or
more
codes
from
a
code
system
or
other
value
set(s)
vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter |
||||
|
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
|
||||
|
Σ
C
|
0..1 | uri | The system the codes come from | ||||
|
Σ | 0..1 | string | Specific version of the code system referred to | ||||
|
C
|
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 | |||||
|
C
|
0..* | BackboneElement |
Additional
representations
for
this
concept
vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present |
||||
|
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: All Languages ( required ): IETF language tag for a human language
| |||||
|
C
|
0..1 | Coding |
Types
of
uses
of
designations
Binding: Designation Use ( extensible ): Details of how a designation would be used. |
||||
|
C
|
0..* | Coding |
Additional
ways
how
this
designation
would
be
used
Binding: Designation Use ( extensible ): Details of how a designation would be used. |
||||
|
1..1 | string | The text value for this designation | |||||
|
Σ
C
|
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
|
child-of
|
descendent-leaf
|
exists
Binding: Filter Operator ( required ): The kind of operation to perform as a part of a property based filter. |
||||
|
Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
|
Σ
C
|
0..* | canonical ( ValueSet ) |
Select
the
contents
included
in
this
value
set
|
||||
|
|
0..1 |
|
A copyright statement for the specific code system included in the value set | ||||
|
0..* | See include (ValueSet) |
Explicitly
exclude
codes
from
a
code
system
or
other
value
sets
|
|||||
|
|
0..* | string |
Property
to
return
if
client
doesn't
override
|
||||
|
S
C
|
1..1 | BackboneElement |
Used
when
the
value
set
is
"expanded"
evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. |
||||
|
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
|
||||
|
S | 0..1 | uri | Identifies the value set expansion (business identifier) | ||||
|
|
0..1 | uri | Opaque urls for paging through expansion results | ||||
|
S | 1..1 | dateTime | Time ValueSet expansion happened | ||||
|
S | 0..1 | integer | Total number of codes in the expansion | ||||
|
S | 0..1 | integer | Offset at which this resource starts | ||||
|
S | 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 | |||||||
|
|
0..* | BackboneElement |
Additional
information
supplied
about
each
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
|
||||
|
1..1 | code | Identifies the property on the concepts, and when referred to in operations | |||||
|
0..1 | uri | Formal identifier for the property | |||||
|
S
C
|
0..* | BackboneElement |
Codes
in
the
value
set
vsd-6: SHALL have a code or a display vsd-9: SHALL have a code if not abstract vsd-10: SHALL have a system if a code is present |
||||
|
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
|
||||
|
S
C
|
0..1 | uri | System value for the code | ||||
|
S
C
|
0..1 | boolean | If user cannot select this entry | ||||
|
S | 0..1 | boolean | If concept is inactive in the code system | ||||
|
S
C
|
0..1 | string | Version in which this code/display is defined | ||||
|
S
C
|
1..1 | code | Code - if blank, this is not a selectable code | ||||
|
S
C
|
0..1 | string | User display for the concept | ||||
|
0..* | See designation (ValueSet) |
Additional
representations
for
this
item
|
|||||
|
S | 0..* | BackboneElement |
Property
value
for
the
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
|
||||
|
S | 1..1 | code | Reference to ValueSet.expansion.property.code | ||||
|
S | 1..1 | Value of the property for this concept | |||||
|
code | |||||||
|
Coding | |||||||
|
string | |||||||
|
integer | |||||||
|
boolean | |||||||
|
dateTime | |||||||
|
decimal | |||||||
|
0..* | BackboneElement |
SubProperty
value
for
the
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
|
||||
|
1..1 | code | Reference to ValueSet.expansion.property.code | |||||
|
1..1 | Value of the subproperty for this concept | ||||||
|
code | |||||||
|
Coding | |||||||
|
string | |||||||
|
integer | |||||||
|
boolean | |||||||
|
dateTime | |||||||
|
decimal | |||||||
|
S | 0..* | See contains (ValueSet) |
Codes
contained
under
this
entry
|
||||
|
|
0..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description | ||||
|
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 |
|
Criteria describing which concepts or codes should be included and why | |||||
|
0..1 |
|
Criteria describing which concepts or codes should be excluded and why | |||||
|
||||||||
<!-- ExecutableValueSet --><ValueSet xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained>
<<a href="executablevalueset-definitions.html#ValueSet.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this value set, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the value set (business identifier) --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the value set --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this value set (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this value set (human friendly) --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the value set --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for value set (if applicable) --></jurisdiction> <immutable value="[boolean]"/><!-- I 0..1 Indicates whether or not any change to the content logical definition may occur --> <purpose value="[markdown]"/><!-- I 0..1 Why this value set is defined --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the ValueSet was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the ValueSet was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the ValueSet is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the ValueSet --></author> <editor><!-- I 0..* ContactDetail Who edited the ValueSet --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the ValueSet --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the ValueSet --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <compose> I 0..1 BackboneElement <!-- I 0..1 Content logical definition of the value set (CLD) --><<a href="executablevalueset-definitions.html#ValueSet.compose.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <lockedDate value="[date]"/><!-- I 0..1 Fixed date for references with no specified version (transitive) --> <inactive value="[boolean]"/><!-- I 0..1 Whether inactive codes are in the value set --> <include> I 1..* BackboneElement <!-- I 1..* Include one or more codes from a code system or other value set(s) --><<a href="executablevalueset-definitions.html#ValueSet.compose.include.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <system value="[uri]"/><!-- I 0..1 The system the codes come from --> <version value="[string]"/><!-- I 0..1 Specific version of the code system referred to --> <concept> I 0..* BackboneElement <!-- I 0..* A concept defined in the system --><<a href="executablevalueset-definitions.html#ValueSet.compose.include.concept.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Code or expression from system --> <display value="[string]"/><!-- I 0..1 Text to display for this code for this value set in this valueset --> <designation> I 0..* BackboneElement <!-- I 0..* Additional representations for this concept --><<a href="executablevalueset-definitions.html#ValueSet.compose.include.concept.designation.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <language value="[code]"/><!-- I 0..1 Human language of the designation --> <use><!-- I 0..1 Coding Types of uses of designations --></use> <additionalUse><!-- I 0..* Coding Additional ways how this designation would be used --></additionalUse> <value value="[string]"/><!-- I 1..1 The text value for this designation --> </designation> </concept> <filter> I 0..* BackboneElement <!-- I 0..* Select codes/concepts by their properties (including relationships) --><<a href="executablevalueset-definitions.html#ValueSet.compose.include.filter.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <property value="[code]"/><!-- I 1..1 A property/filter defined by the code system --> <op value="[code]"/><!-- I 1..1 = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists --><<value value="[string]"/><!-- I 1..1 Code from the system, or regex criteria, or boolean value for exists --> </filter> <valueSet value="[canonical]"/><!-- I 0..* Select the contents included in this value set --><<copyright value="[markdown]"/><!-- I 0..1 A copyright statement for the specific code system included in the value set --> </include> <exclude><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include Explicitly exclude codes from a code system or other value sets --></exclude> <property value="[string]"/><!-- I 0..* Property to return if client doesn't override --> </compose> <expansion> I 1..1 BackboneElement <!-- I 1..1 Used when the value set is "expanded" --><<a href="executablevalueset-definitions.html#ValueSet.expansion.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <identifier value="[uri]"/><!-- I 0..1 Identifies the value set expansion (business identifier) --> <next value="[uri]"/><!-- I 0..1 Opaque urls for paging through expansion results --> <timestamp value="[dateTime]"/><!-- I 1..1 Time ValueSet expansion happened --> <total value="[integer]"/><!-- I 0..1 Total number of codes in the expansion --> <offset value="[integer]"/><!-- I 0..1 Offset at which this resource starts --> <parameter> I 0..* BackboneElement <!-- I 0..* Parameter that controlled the expansion process --><<a href="executablevalueset-definitions.html#ValueSet.expansion.parameter.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name as assigned by the client or server --> <value[x]><!-- I 0..1 string|boolean|integer| decimal|uri|code|dateTime Value of the named parameter --></value[x]> </parameter> <property> I 0..* BackboneElement <!-- I 0..* Additional information supplied about each concept --><<a href="executablevalueset-definitions.html#ValueSet.expansion.property.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Identifies the property on the concepts, and when referred to in operations --> <uri value="[uri]"/><!-- I 0..1 Formal identifier for the property --> </property> <contains> I 0..* BackboneElement <!-- I 0..* Codes in the value set --><<a href="executablevalueset-definitions.html#ValueSet.expansion.contains.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <system value="[uri]"/><!-- I 0..1 System value for the code --> <abstract value="[boolean]"/><!-- I 0..1 If user cannot select this entry --> <inactive value="[boolean]"/><!-- I 0..1 If concept is inactive in the code system --> <version value="[string]"/><!-- I 0..1 Version in which this code/display is defined --> <code value="[code]"/><!-- I 1..1 Code - if blank, this is not a selectable code --> <display value="[string]"/><!-- I 0..1 User display for the concept --> <designation><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include.concept.designation Additional representations for this item --></designation> <property> I 0..* BackboneElement <!-- I 0..* Property value for the concept --><<a href="executablevalueset-definitions.html#ValueSet.expansion.contains.property.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Reference to ValueSet.expansion.property.code --> <value[x]><!-- I 1..1 code|Coding|string| integer|boolean|dateTime|decimal Value of the property for this concept --></value[x]> <subProperty> I 0..* BackboneElement <!-- I 0..* SubProperty value for the concept --><<a href="executablevalueset-definitions.html#ValueSet.expansion.contains.property.subProperty.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Reference to ValueSet.expansion.property.code --> <value[x]><!-- I 1..1 code| Coding|string|integer|boolean|dateTime|decimal Value of the subproperty for this concept --></value[x]> </subProperty> </property> <contains><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains Codes contained under this entry --></contains> </contains> </expansion> <scope> I 0..1 BackboneElement <!-- I 0..1 Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description --><<a href="executablevalueset-definitions.html#ValueSet.scope.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <inclusionCriteria value="[markdown]"/><!-- I 0..1 Criteria describing which concepts or codes should be included and why --><<exclusionCriteria value="[markdown]"/><!-- I 0..1 Criteria describing which concepts or codes should be excluded and why --> </scope> </ValueSet>
{ // ExecutableValueSet
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"extension" : [ // sliced by value:url in the specified order, Open
{ // narrative | semi-structured | structured | executable // I
// from Element: extension
},
{ // Reference to the current trusted source of the ValueSet resource (metadata and definition) // I
// from Element: extension
},
{ //
{ // A warning about how to interpret and/or correctly use the value set // I R!
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "http://hl7.org/fhir/StructureDefinition/valueset-warning", // R!
"valueMarkdown" : "This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated." // I R!
}
],
"<a href="executablevalueset-definitions.html#ValueSet.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"url" : "<uri>", // I R! Canonical identifier for this value set, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // IAdditional identifier for the value set (business identifier)
"version" : "<string>", // I R! Business version of the value set
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // IName for this value set (computer friendly)
"title" : "<string>", // I R! Name for this value set (human friendly)
"status" : "<code>", // I R! draft | active | retired | unknown
"experimental" : <boolean>, // I R! For testing purposes, not real usage
"date" : "<dateTime>", // IDate last changed
"publisher" : "<string>", // IName of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // IContact details for the publisher
"description" : "<markdown>", // I R! Natural language description of the value set
"useContext" : [{ UsageContext }], // IThe context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for value set (if applicable)
"immutable" : <boolean>, // IIndicates whether or not any change to the content logical definition may occur
"purpose" : "<markdown>", // IWhy this value set is defined
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"approvalDate" : "<date>", // IWhen the ValueSet was approved by publisher
"lastReviewDate" : "<date>", // IWhen the ValueSet was last reviewed by the publisher
"effectivePeriod" : { Period }, // IWhen the ValueSet is expected to be used
"topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
"author" : [{ ContactDetail }], // IWho authored the ValueSet
"editor" : [{ ContactDetail }], // IWho edited the ValueSet
"reviewer" : [{ ContactDetail }], // IWho reviewed the ValueSet
"endorser" : [{ ContactDetail }], // IWho endorsed the ValueSet
"relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
"compose" : { BackboneElement }, // IContent logical definition of the value set (CLD)
"expansion" : { BackboneElement }, // I R! Used when the value set is "expanded"
"scope" : { BackboneElement }, // IDescription of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
}
This structure is derived from ShareableValueSet .
Summary
mustSupport
When this profile has defined an element as mustSupport, the sender must provide the element value when available, and the receiver must accept the element value, persist the value and when appropriate, provide function as defined in the profile. When mustSupport is defined at a complex element level, all sub-elements inherit mustSupport.
Mandatory:
3
4
elements
(+1
nested
mandatory
element)
Must-Support:
19
elements
Fixed
Value:
1
element
Extensions
This structure refers to these extensions:
Differential View
This indicates the differences between this profile and the base ShareableValueSet structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ShareableValueSet | A set of codes drawn from one or more code systems | |
|
|
1.. * | Extension |
Slice: Unordered, Open by value:url |
|
S | 1..1 | (Complex) |
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning |
|
S | 1..1 | markdown |
Value
of
extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. |
|
S
C
|
1..1 | BackboneElement |
Used
when
the
value
set
is
"expanded"
evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. |
|
S | 0 .. 1 | uri | Identifies the value set expansion (business identifier) |
|
S | 1 .. 1 | dateTime | Time ValueSet expansion happened |
|
S | 0 .. 1 | integer | Total number of codes in the expansion |
|
S | 0 .. 1 | integer | Offset at which this resource starts |
|
S | 0 .. * | BackboneElement | Parameter that controlled the expansion process |
|
S | 0 .. * | BackboneElement | Codes in the value set |
|
S | 0 .. 1 | uri | System value for the code |
|
S | 0 .. 1 | boolean | If user cannot select this entry |
|
S | 0 .. 1 | boolean | If concept is inactive in the code system |
|
S
C
|
0 .. 1 | string | Version in which this code/display is defined |
|
S | 1..1 | code | Code - if blank, this is not a selectable code |
|
S | 0 .. 1 | string | User display for the concept |
|
S | 0 .. * | BackboneElement | Property value for the concept |
|
S | 1 .. 1 | code | Reference to ValueSet.expansion.property.code |
|
S | 1 .. 1 | code , Coding , string , integer , boolean , dateTime , decimal | Value of the property for this concept |
|
S | 0 .. * | Codes contained under this entry | |
|
||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableValueSet structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
|
1..1 | ShareableValueSet |
A
set
of
codes
drawn
from
one
or
more
code
systems
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
||||
|
Σ | 0..1 | id | 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: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
|
Extension |
Extension
Slice: Unordered, Open by value:url |
|||||
|
S | 0..* | code |
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
||||
|
S | 0..1 | uri |
Reference
to
the
current
trusted
source
of
the
ValueSet
resource
(metadata
and
definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource |
||||
|
S | 1..1 |
|
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning |
||||
|
0..1 | id | Unique id for inter-element referencing | |||||
|
0..0 | |||||||
|
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning" | |||||
|
S | 1..1 | markdown |
Value
of
extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. |
||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
S
Σ
C
|
1..1 | uri |
Canonical
identifier
for
this
value
set,
represented
as
a
URI
(globally
unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic |
||||
|
Σ | 0..* | Identifier |
Additional
identifier
for
the
value
set
(business
identifier)
|
||||
|
S Σ | 1..1 | string | Business version of the value set | ||||
|
S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) |
|||||
|
string | |||||||
|
Coding | |||||||
|
S
Σ
C
|
0..1 | string | Name for this value set (computer friendly) | ||||
|
S Σ | 1..1 | string | Name for this value set (human friendly) | ||||
|
?! S Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact. |
||||
|
S Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
|
Σ | 0..1 | dateTime | Date last changed | ||||
|
S Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
S | 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 ValueSet ( extensible ): Countries and regions within which this artifact is targeted for use. |
||||
|
Σ | 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 | string | Copyright holder and year(s) | ||||
|
|
0..1 | date | When the ValueSet was approved by publisher | ||||
|
|
0..1 | date | When the ValueSet was last reviewed by the publisher | ||||
|
Σ
|
0..1 | Period | When the ValueSet is expected to be used | ||||
|
|
0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment,
etc
Binding: Definition Topic ( example ) |
||||
|
|
0..* | ContactDetail |
Who
authored
the
ValueSet
|
||||
|
|
0..* | ContactDetail |
Who
edited
the
ValueSet
|
||||
|
|
0..* | ContactDetail |
Who
reviewed
the
ValueSet
|
||||
|
|
0..* | ContactDetail |
Who
endorsed
the
ValueSet
|
||||
|
|
0..* | RelatedArtifact |
Additional
documentation,
citations,
etc
|
||||
|
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 | ||||
|
Σ
C
|
1..* | BackboneElement |
Include
one
or
more
codes
from
a
code
system
or
other
value
set(s)
vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter |
||||
|
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
|
||||
|
Σ
C
|
0..1 | uri | The system the codes come from | ||||
|
Σ | 0..1 | string | Specific version of the code system referred to | ||||
|
C
|
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 | |||||
|
C
|
0..* | BackboneElement |
Additional
representations
for
this
concept
vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present |
||||
|
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: All Languages ( required ): IETF language tag for a human language
| |||||
|
C
|
0..1 | Coding |
Types
of
uses
of
designations
Binding: Designation Use ( extensible ): Details of how a designation would be used. |
||||
|
C
|
0..* | Coding |
Additional
ways
how
this
designation
would
be
used
Binding: Designation Use ( extensible ): Details of how a designation would be used. |
||||
|
1..1 | string | The text value for this designation | |||||
|
Σ
C
|
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
|
child-of
|
descendent-leaf
|
exists
Binding: Filter Operator ( required ): The kind of operation to perform as a part of a property based filter. |
||||
|
Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
|
Σ
C
|
0..* | canonical ( ValueSet ) |
Select
the
contents
included
in
this
value
set
|
||||
|
|
0..1 |
|
A copyright statement for the specific code system included in the value set | ||||
|
0..* | See include (ValueSet) |
Explicitly
exclude
codes
from
a
code
system
or
other
value
sets
|
|||||
|
|
0..* | string |
Property
to
return
if
client
doesn't
override
|
||||
|
S
C
|
1..1 | BackboneElement |
Used
when
the
value
set
is
"expanded"
evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. |
||||
|
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
|
||||
|
S | 0..1 | uri | Identifies the value set expansion (business identifier) | ||||
|
|
0..1 | uri | Opaque urls for paging through expansion results | ||||
|
S | 1..1 | dateTime | Time ValueSet expansion happened | ||||
|
S | 0..1 | integer | Total number of codes in the expansion | ||||
|
S | 0..1 | integer | Offset at which this resource starts | ||||
|
S | 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 | |||||||
|
|
0..* | BackboneElement |
Additional
information
supplied
about
each
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
|
||||
|
1..1 | code | Identifies the property on the concepts, and when referred to in operations | |||||
|
0..1 | uri | Formal identifier for the property | |||||
|
S
C
|
0..* | BackboneElement |
Codes
in
the
value
set
vsd-6: SHALL have a code or a display vsd-9: SHALL have a code if not abstract vsd-10: SHALL have a system if a code is present |
||||
|
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
|
||||
|
S
C
|
0..1 | uri | System value for the code | ||||
|
S
C
|
0..1 | boolean | If user cannot select this entry | ||||
|
S | 0..1 | boolean | If concept is inactive in the code system | ||||
|
S
C
|
0..1 | string | Version in which this code/display is defined | ||||
|
S
C
|
1..1 | code | Code - if blank, this is not a selectable code | ||||
|
S
C
|
0..1 | string | User display for the concept | ||||
|
0..* | See designation (ValueSet) |
Additional
representations
for
this
item
|
|||||
|
S | 0..* | BackboneElement |
Property
value
for
the
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
|
||||
|
S | 1..1 | code | Reference to ValueSet.expansion.property.code | ||||
|
S | 1..1 | Value of the property for this concept | |||||
|
code | |||||||
|
Coding | |||||||
|
string | |||||||
|
integer | |||||||
|
boolean | |||||||
|
dateTime | |||||||
|
decimal | |||||||
|
0..* | BackboneElement |
SubProperty
value
for
the
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
|
||||
|
1..1 | code | Reference to ValueSet.expansion.property.code | |||||
|
1..1 | Value of the subproperty for this concept | ||||||
|
code | |||||||
|
Coding | |||||||
|
string | |||||||
|
integer | |||||||
|
boolean | |||||||
|
dateTime | |||||||
|
decimal | |||||||
|
S | 0..* | See contains (ValueSet) |
Codes
contained
under
this
entry
|
||||
|
|
0..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description | ||||
|
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 |
|
Criteria describing which concepts or codes should be included and why | |||||
|
0..1 |
|
Criteria describing which concepts or codes should be excluded and why | |||||
|
||||||||
XML Template
<!-- ExecutableValueSet --><ValueSet xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained>
<<a href="executablevalueset-definitions.html#ValueSet.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this value set, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the value set (business identifier) --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the value set --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this value set (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this value set (human friendly) --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the value set --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for value set (if applicable) --></jurisdiction> <immutable value="[boolean]"/><!-- I 0..1 Indicates whether or not any change to the content logical definition may occur --> <purpose value="[markdown]"/><!-- I 0..1 Why this value set is defined --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the ValueSet was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the ValueSet was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the ValueSet is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the ValueSet --></author> <editor><!-- I 0..* ContactDetail Who edited the ValueSet --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the ValueSet --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the ValueSet --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <compose> I 0..1 BackboneElement <!-- I 0..1 Content logical definition of the value set (CLD) --><<a href="executablevalueset-definitions.html#ValueSet.compose.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <lockedDate value="[date]"/><!-- I 0..1 Fixed date for references with no specified version (transitive) --> <inactive value="[boolean]"/><!-- I 0..1 Whether inactive codes are in the value set --> <include> I 1..* BackboneElement <!-- I 1..* Include one or more codes from a code system or other value set(s) --><<a href="executablevalueset-definitions.html#ValueSet.compose.include.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <system value="[uri]"/><!-- I 0..1 The system the codes come from --> <version value="[string]"/><!-- I 0..1 Specific version of the code system referred to --> <concept> I 0..* BackboneElement <!-- I 0..* A concept defined in the system --><<a href="executablevalueset-definitions.html#ValueSet.compose.include.concept.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Code or expression from system --> <display value="[string]"/><!-- I 0..1 Text to display for this code for this value set in this valueset --> <designation> I 0..* BackboneElement <!-- I 0..* Additional representations for this concept --><<a href="executablevalueset-definitions.html#ValueSet.compose.include.concept.designation.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <language value="[code]"/><!-- I 0..1 Human language of the designation --> <use><!-- I 0..1 Coding Types of uses of designations --></use> <additionalUse><!-- I 0..* Coding Additional ways how this designation would be used --></additionalUse> <value value="[string]"/><!-- I 1..1 The text value for this designation --> </designation> </concept> <filter> I 0..* BackboneElement <!-- I 0..* Select codes/concepts by their properties (including relationships) --><<a href="executablevalueset-definitions.html#ValueSet.compose.include.filter.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <property value="[code]"/><!-- I 1..1 A property/filter defined by the code system --> <op value="[code]"/><!-- I 1..1 = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists --><<value value="[string]"/><!-- I 1..1 Code from the system, or regex criteria, or boolean value for exists --> </filter> <valueSet value="[canonical]"/><!-- I 0..* Select the contents included in this value set --><<copyright value="[markdown]"/><!-- I 0..1 A copyright statement for the specific code system included in the value set --> </include> <exclude><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include Explicitly exclude codes from a code system or other value sets --></exclude> <property value="[string]"/><!-- I 0..* Property to return if client doesn't override --> </compose> <expansion> I 1..1 BackboneElement <!-- I 1..1 Used when the value set is "expanded" --><<a href="executablevalueset-definitions.html#ValueSet.expansion.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <identifier value="[uri]"/><!-- I 0..1 Identifies the value set expansion (business identifier) --> <next value="[uri]"/><!-- I 0..1 Opaque urls for paging through expansion results --> <timestamp value="[dateTime]"/><!-- I 1..1 Time ValueSet expansion happened --> <total value="[integer]"/><!-- I 0..1 Total number of codes in the expansion --> <offset value="[integer]"/><!-- I 0..1 Offset at which this resource starts --> <parameter> I 0..* BackboneElement <!-- I 0..* Parameter that controlled the expansion process --><<a href="executablevalueset-definitions.html#ValueSet.expansion.parameter.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name as assigned by the client or server --> <value[x]><!-- I 0..1 string|boolean|integer| decimal|uri|code|dateTime Value of the named parameter --></value[x]> </parameter> <property> I 0..* BackboneElement <!-- I 0..* Additional information supplied about each concept --><<a href="executablevalueset-definitions.html#ValueSet.expansion.property.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Identifies the property on the concepts, and when referred to in operations --> <uri value="[uri]"/><!-- I 0..1 Formal identifier for the property --> </property> <contains> I 0..* BackboneElement <!-- I 0..* Codes in the value set --><<a href="executablevalueset-definitions.html#ValueSet.expansion.contains.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <system value="[uri]"/><!-- I 0..1 System value for the code --> <abstract value="[boolean]"/><!-- I 0..1 If user cannot select this entry --> <inactive value="[boolean]"/><!-- I 0..1 If concept is inactive in the code system --> <version value="[string]"/><!-- I 0..1 Version in which this code/display is defined --> <code value="[code]"/><!-- I 1..1 Code - if blank, this is not a selectable code --> <display value="[string]"/><!-- I 0..1 User display for the concept --> <designation><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include.concept.designation Additional representations for this item --></designation> <property> I 0..* BackboneElement <!-- I 0..* Property value for the concept --><<a href="executablevalueset-definitions.html#ValueSet.expansion.contains.property.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Reference to ValueSet.expansion.property.code --> <value[x]><!-- I 1..1 code|Coding|string| integer|boolean|dateTime|decimal Value of the property for this concept --></value[x]> <subProperty> I 0..* BackboneElement <!-- I 0..* SubProperty value for the concept --><<a href="executablevalueset-definitions.html#ValueSet.expansion.contains.property.subProperty.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Reference to ValueSet.expansion.property.code --> <value[x]><!-- I 1..1 code| Coding|string|integer|boolean|dateTime|decimal Value of the subproperty for this concept --></value[x]> </subProperty> </property> <contains><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains Codes contained under this entry --></contains> </contains> </expansion> <scope> I 0..1 BackboneElement <!-- I 0..1 Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description --><<a href="executablevalueset-definitions.html#ValueSet.scope.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <inclusionCriteria value="[markdown]"/><!-- I 0..1 Criteria describing which concepts or codes should be included and why --><<exclusionCriteria value="[markdown]"/><!-- I 0..1 Criteria describing which concepts or codes should be excluded and why --> </scope> </ValueSet>
JSON Template
{ // ExecutableValueSet
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"extension" : [ // sliced by value:url in the specified order, Open
{ // narrative | semi-structured | structured | executable // I
// from Element: extension
},
{ // Reference to the current trusted source of the ValueSet resource (metadata and definition) // I
// from Element: extension
},
{ //
{ // A warning about how to interpret and/or correctly use the value set // I R!
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "http://hl7.org/fhir/StructureDefinition/valueset-warning", // R!
"valueMarkdown" : "This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated." // I R!
}
],
"<a href="executablevalueset-definitions.html#ValueSet.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"url" : "<uri>", // I R! Canonical identifier for this value set, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // IAdditional identifier for the value set (business identifier)
"version" : "<string>", // I R! Business version of the value set
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // IName for this value set (computer friendly)
"title" : "<string>", // I R! Name for this value set (human friendly)
"status" : "<code>", // I R! draft | active | retired | unknown
"experimental" : <boolean>, // I R! For testing purposes, not real usage
"date" : "<dateTime>", // IDate last changed
"publisher" : "<string>", // IName of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // IContact details for the publisher
"description" : "<markdown>", // I R! Natural language description of the value set
"useContext" : [{ UsageContext }], // IThe context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for value set (if applicable)
"immutable" : <boolean>, // IIndicates whether or not any change to the content logical definition may occur
"purpose" : "<markdown>", // IWhy this value set is defined
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"approvalDate" : "<date>", // IWhen the ValueSet was approved by publisher
"lastReviewDate" : "<date>", // IWhen the ValueSet was last reviewed by the publisher
"effectivePeriod" : { Period }, // IWhen the ValueSet is expected to be used
"topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
"author" : [{ ContactDetail }], // IWho authored the ValueSet
"editor" : [{ ContactDetail }], // IWho edited the ValueSet
"reviewer" : [{ ContactDetail }], // IWho reviewed the ValueSet
"endorser" : [{ ContactDetail }], // IWho endorsed the ValueSet
"relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
"compose" : { BackboneElement }, // IContent logical definition of the value set (CLD)
"expansion" : { BackboneElement }, // I R! Used when the value set is "expanded"
"scope" : { BackboneElement }, // IDescription of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| ValueSet.language | All Languages | required | All Languages |
| ValueSet.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
| ValueSet.status | PublicationStatus | required | PublicationStatus |
| ValueSet.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
| ValueSet.topic | Definition Topic | example | Definition Topic |
| ValueSet.compose.include.concept.designation.language | All Languages | required | All Languages |
| ValueSet.compose.include.concept.designation.use | Designation Use | extensible | Designation Use |
| ValueSet.compose.include.concept.designation.additionalUse | Designation Use | extensible | Designation Use |
| ValueSet.compose.include.filter.op | Filter Operator | required | Filter Operator |
| Id | Path | Details | Requirements |
| evs-1 | ValueSet.expansion |
For
contains,
a
version
SHALL
be
provided
unless
the
parameters
element
has
a
"system-version"
parameter
corresponding
to
the
system
of
the
entry
and
the
version
matches
the
system-version
parameter.
Expression
:
contains.version.exists()
xor
parameter.where(name
=
'system-version').exists()
|