This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R4B
R4
| Responsible Owner: Terminology Infrastructure Work Group | Standards Status : Informative | Compartments : No defined compartments |
URL
This
is
the
narrative
for
this
extension:
http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
Status:
draft.
Extension
maintained
by:
HL7
Indicates
that
the
resource
is
related
to
either
resource.
See
also
the
measurement,
achievement
XML
,
JSON
or
progress
towards
the
referenced
goal.
For
example,
a
Procedure
to
exercise
pertainsToGoal
of
losing
weight.
Turtle
format.
Note
that
a
particular
observation
result,
prescription
or
other
activity
this
is
pertinent
to
the
achievement
(or
possibly
non-achievement)
of
formal
definition
for
the
referenced
goal.
Context
of
Use:
Use
expand
operation
as
an
OperationDefinition
on
Element
ID
Resource
Extension
Content
ValueSet.
See
the
Operation
documentation
Summary
Generated
Narrative:
OperationDefinition
ValueSet-expand
URL: [base]/ValueSet/$expand
URL: [base]/ValueSet/[id]/$expand
|
|
Name |
|
|
Type |
|
Documentation |
| IN | url | type | 0..1 | uri |
A reference to the canonical URL of a value set. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server |
|
| IN | valueSet | type | 0..1 | ValueSet |
The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion |
|
| IN | valueSetVersion | type | 0..1 |
string
|
|
The
identifier
that
|
| IN | context | 0..1 |
|
The context of the value set, so that the server can resolve this to a value set to expand. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the conformance registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time |
||
| IN | contextDirection | 0..1 |
|
If a context is provided, a context direction may also be provided. Valid values are:
The purpose is to inform the server whether to use the value set associated with the context for reading or writing purposes (note: for most elements, this is the same value set, but there are a few elements where the reading and writing value sets are different) |
||
| IN | filter | 0..1 |
|
A text filter that is applied to restrict the codes that are returned (this is useful in a UI context). The interpretation of this is delegated to the server in order to allow to determine the most optimal search approach for the context. The server can document the way this parameter works in TerminologyCapabilities ..expansion.textFilter. Typical usage of this parameter includes functionality like:
Text Search engines such as Lucene or Solr, long with their considerable functionality, might also be used. The optional text search might also be code system specific, and servers might have different implementations for different code systems |
||
| IN | filterProperty | 0..* | code |
Properties to be considered when matching against the filter text in addition to display, definition and designations, etc. The properties must have a string representation, e.g. string, code, or url, though the search is always text based irrespective of the property type. |
||
| IN | date | 0..1 | dateTime |
|
The
date
for
which
the
|
|
| IN | offset |
|
0..1 | integer |
Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages) |
|
| IN | count | 0..1 | integer |
Paging support - how many codes should be provided in a partial page view. Paging only applies to flat expansions - servers ignore paging if the expansion is not flat. If count = 0, the client is asking how large the expansion is. Servers SHOULD honor this request for hierarchical expansions as well, and simply return the overall count |
||
| IN | includeDesignations | 0..1 |
|
Controls whether concept designations are to be included or excluded in value set expansions |
||
| IN | designation | 0..* |
|
A token that specifies a system+code that is either a use or a language. Designations that match by language or use are included in the expansion. If no designation is specified, it is at the server discretion which designations to return |
||
| IN | includeDefinition | 0..1 |
|
|
Controls
whether
the
value
set
definition
is
included
or
excluded
in
value
set
expansions.
This
includes
all
elements
of
|
|
| IN | activeOnly | 0..1 |
|
|
||
| IN | useSupplement | 0..* |
|
The supplement must be used when performing an expansion. Use of this parameter should result in $expand behaving the same way as if the supplements were included in the value set definition using the http://hl7.org/fhir/StructureDefinition/valueset-supplement |
||
| IN | excludeNested | 0..1 |
|
Controls whether or not the value set expansion may nest codes or not (i.e. ValueSet.expansion.contains.contains). If excludeNested is set to true, the expansion MUST be flat (no nesting). If excludeNested is set to false (default), however, nesting is possible but not required |
||
| IN | excludeNotForUI | 0..1 | boolean |
|
Controls whether or not the value set expansion might include
One
purpose
of
such
concepts
is
helping
a
user
navigate
through
the
|
|
| IN | excludePostCoordinated | 0..1 |
|
Controls whether or not the value set expansion includes post coordinated codes |
||
| IN | displayLanguage | 0..1 |
|
Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display |
||
| IN | property | 0..* |
|
|
A request to return a particular property in the expansion. The returned property may include subproperties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. Note that property names can clash, so using a URI is recommended. The special value '*' means all properties and their sub-properties known to the server |
|
| IN | handle-unclosed-expansion | 0..1 | boolean |
If true this asserts that you will correctly handle an unclosed expansion and the returned expansion SHALL include the valueset-unclosed extension if the value set is unclosed. If handle-unclosed-expansion is set to false the server SHALL return an error if the value set is unclosed. |
||
| IN | exclude-system | 0..* |
canonical
|
|
Code
system,
or
a
particular
version
of
a
code
system
to
|
|
| IN | system-version | 0..* |
|
Specifies a version to use for a system, if the value set does not specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56 |
||
| IN | check-system-version | 0..* | canonical |
Edge Case: Specifies a version to use for a system. If a value set specifies a different version, an error is returned instead of the expansion. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56 |
||
| IN | force-system-version | 0..* |
|
Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the value set (and any it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the value is overridden, the version used SHALL explicitly be represented in the expansion parameters |
||
| IN | default-valueset-version | 0..* |
|
Specifies a version to use for a valueset, if the reference to the value set does not specify which version to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://example.org/ValueSet/example|1.0.0. Note that this is similar to the force-system-version parameter but applied to valuesets |
||
| IN | check-valueset-version | 0..* |
|
Edge Case: Specifies a version to use for a valueset. If a reference to a value set specifies a different version, an error is returned instead of the expansion. The format is the same as a canonical URL: [system]|[version] - e.g. http://example.org/ValueSet/example|1.0.0. Note that this is similar to the force-system-version parameter but applied to valuesets |
||
| IN | force-valueset-version | 0..* |
|
|
Edge
Case:
Specifies
a
version
to
use
for
a
valueset.
This
parameter
overrides
any
specified
version
in
the
reference
to
the
value
set
(and
any
it
depends
on).
The
format
is
the
same
as
a
canonical
URL:
[system]|[version]
-
e.g.
http://example.org/ValueSet/example|1.0.0.
Note
that
this
has
obvious
safety
issues,
in
that
it
may
result
in
a
value
set
expansion
giving
a
different
list
of
|
|
| IN | manifest | 0..1 | canonical ( Library ) |
|
Specifies
an
library
that
provides
expansion
rules
for
|
|
| IN | tx-resource | 0..* |
Resource
|
One or more additional resources that are referred to from the value set provided with the $expand or $validate-code invocation. These may be additional value sets or code systems that the client believes will or may be necessary to perform the operation. Resources provided in this fashion are used preferentially to those known to the system, though servers may return an error if these resources are already known to the server (by URL and version) but differ from that information on the server. |
||
| OUT | return | 1..1 | ValueSet |
|
The
value
set
expansion
returned
by
this
query
should
be
treated
as
a
@value
transient
result
that
will
change
over
time
(whether
it
does
or
children
(xpath:
@value|f:*|h:div
)
ext-1
:
Must
have
either
extensions
not
depends
on
how
the
value
set
is
specified),
so
applications
should
repeat
the
operation
each
time
the
value
set
is
used.
When available, ValueSet.status and ValueSet.version from the ValueSet resource instance which contains the definition SHALL be persisted to the ValueSet resource instance which contains the expansion.
If
the
expansion
is
too
large
(at
the
discretion
of
the
server),
the
server
MAY
return
an
error
(OperationOutcome
with
code
too-costly).
Clients
can
work
through
large
flat
expansions
in
a
set
of
pages
(partial
views
of
the
full
expansion)
instead
of
just
getting
the
full
expansion
in
a
single
exchange
by
using
offset
and
count
parameters,
or
value[x],
use
the
count
parameter
to
request
a
subset
of
the
expansion
for
limited
purposes.
Servers
are
not
obliged
to
support
paging,
but
if
they
do,
SHALL
support
both
(xpath:
exists(f:extension)!=exists(f:*[starts-with(local-name(.),
'value')])
)
the
offset
and
count
parameters.
Hierarchical
expansions
are
not
subject
to
paging
and
servers
simply
return
the
entire
expansion.
Different servers may return different results from expanding a value set for the following reasons:
When
a
@value
server
cannot
correctly
expand
a
value
set
because
it
does
not
fully
understand
the
code
systems
(e.g.
it
has
the
wrong
version,
or
children
(xpath
on
Extension.value[x]:
@value|f:*|h:div
)
incomplete
definitions)
then
it
SHALL
return
an
error.
If
the
value
set
itself
is
unbounded
due
to
the
inclusion
of
post-coordinated
value
sets
(e.g.
SNOMED
CT,
UCUM),
then
the
extension
http://hl7.org/fhir/StructureDefinition/valueset-unclosed
can
be
used
to
indicate
that
the
expansion
is
incomplete
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.