This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
and
STU
|
Responsible
Owner:
Terminology
Infrastructure
| Standards Status : Informative | Compartments : No defined compartments |
This is the narrative for the resource. See also the XML , JSON or Turtle format.
Note that this is the formal definition for the validate-code operation as an OperationDefinition on ValueSet. See the Operation documentation
Generated Narrative: OperationDefinition ValueSet-validate-code
URL: [base]/ValueSet/$validate-code
URL: [base]/ValueSet/[id]/$validate-code
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | url | type | 0..1 | uri |
Value
set
Canonical
URL.
The
server
must
know
the
value
set
(e.g.
it
is
defined
explicitly
in
| |
| IN | context | 0..1 | uri |
The
context
of
the
value
set,
so
that
the
server
can
resolve
this
to
a
value
set
to
validate
against.
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
| ||
| IN | valueSet | type | 0..1 | ValueSet |
The
| |
| IN | valueSetVersion | type | 0..1 | string |
The
identifier
that
is
used
to
identify
a
specific
version
of
the
value
set
to
be
used
when
validating
the
code.
This
is
| |
| IN | code | 0..1 | code | The code that is to be validated. If a code is provided, a system or a context must be provided (if a context is provided, then the server SHALL ensure that the code is not ambiguous without a system) | ||
| IN | system | 0..1 | uri | The system for the code that is to be validated | ||
| IN | systemVersion | 0..1 | string | The version of the system, if one was provided in the source data. Note that this is a different parameter to system-version | ||
| IN | display | 0..1 | string | The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name using the display parameter in the outcome. Whether displays are case sensitive is code system dependent | ||
| IN | coding | 0..1 | Coding | A coding to validate | ||
| IN | codeableConcept | 0..1 | CodeableConcept |
A
full
| ||
| IN | date | 0..1 | dateTime |
The
date
for
which
the
validation
should
be
checked.
Normally,
this
is
the
current
conditions
(which
is
the
default
values)
but
under
some
circumstances,
systems
need
to
validate
that
a
correct
code
was
used
at
some
point
in
the
past.
A
typical
example
of
this
would
be
where
code
selection
is
constrained
to
the
set
of
codes
that
were
available
| ||
| IN | abstract | 0..1 | boolean |
If
this
parameter
has
a
value
of
Note that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used as a 'concrete' concept to in an actual patient/care/process record. This language is borrowed from object-orientated theory where 'abstract' entities are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropriate to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context. |
||
| IN | displayLanguage | 0..* |
code
|
Specifies the language for display validation. Note: the display value only needs to match 1 displayLanguage in order for the validate operation to return true. | ||
| IN | useSupplement | 0..* | canonical |
The
supplement
must
be
used
when
validating
the
code.
Use
of
this
parameter
should
result
in
$validate-code
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 | lenient-display-validation |
|
0..1 |
boolean
|
When the 'lenient-display-validation' parameter is true, an invalid display string will not cause the 'result' output parameter to be 'false'. If the 'lenient-display-validation' parameter is false or absent, then an invalid display will cause the 'result' output parameter to be 'false', i.e. the validation will fail. |
|
| IN | valueset-membership-only |
|
0..1 | boolean |
When 'true', the server will not perform the additional validation tasks beyond validating membership in the value set (e.g. the server won't check displays, etc.) |
|
| IN | inferSystem | 0..1 | boolean |
| ||
| IN | system-version | 0..* |
canonical
|
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. Note that this is a different parameter to systemVersion | ||
| 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 | default-valueset-version | 0..* | canonical | 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..* | canonical | 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..* | canonical | 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 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. Note that this is similar to the force-system-version parameter but applied to valuesets. | ||
| IN | manifest | 0..1 | canonical ( Library ) |
Specifies an library that provides expansion rules for the operation. The library has an extension expansionParameters that references a contained Parameters resource that contains additional $expand parameters. See the [CRMI specification description of manifests]https://hl7.org/fhir/uv/crmi/STU1/StructureDefinition-crmi-manifestlibrary.html) and CRMI expansion rules for a complete description of how manifest values are used to provide defaults for expansion parameters. Parameters specified directly in an $expand operation override behaviors specified by the manifest parameter. |
||
| IN | tx-resource | 0..* | Resource |
| ||
| OUT | result | 1..1 | boolean | True if the concept details supplied are valid | ||
| OUT | message | 0..1 | string | Error details, if result = false. If this is provided when result = true, the message carries hints and warnings | ||
| OUT | display | 0..1 | string |
A
valid
display
for
|
||
| OUT | code | 0..1 |
code
|
The code that was validated | ||
| OUT | system | 0..1 | uri |
The system for the code that was validated | ||
| OUT | version | 0..1 | string | The version of the system of the code that was validated | ||
| OUT | codeableConcept | 0..1 | CodeableConcept | A codeableConcept containing codings for all the validated codes | ||
| OUT | issues | 0..1 | OperationOutcome | List of itemised issues with paths constrained to simple FHIRPath. Examples are CodeableConcept, CodeableConcept.coding[0], CodeableConcept.coding[1].display, or Coding.display |
Note: the correct behavior of validation with regard to language for Coding.display items is currently undefined, and further development and testing may lead to specific requirements or recommendations in subsequent releases
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.