|
OperationOutcome
|
|
Definition
|
A
collection
of
error,
warning
or
information
messages
that
result
from
a
system
action.
A collection of error, warning or information messages that result from a system action.
|
|
Control
|
1..1
|
|
Summary
|
true
|
|
Comments
|
Can
result
from
the
failure
of
a
REST
call
or
be
part
of
the
response
message
returned
from
a
request
message.
If
sent
with
extensions
overriding
particular
issues,
might
even
appear
as
part
of
a
request
message.
Can result from the failure of a REST call or be part of the response message returned from a request message. If sent with extensions overriding particular issues, might even appear as part of a request message.
|
|
OperationOutcome.issue
|
|
Definition
|
An
error,
warning
or
information
message
that
results
from
a
system
action.
An error, warning or information message that results from a system action.
|
|
Control
|
1..*
|
|
Summary
|
true
|
|
OperationOutcome.issue.severity
|
|
Definition
|
Indicates
whether
the
issue
indicates
a
variation
from
successful
processing.
Indicates whether the issue indicates a variation from successful processing.
|
|
Control
|
1..1
|
|
Binding
|
IssueSeverity:
How
the
issue
affects
the
success
of
the
action.
(
IssueSeverity:
How the issue affects the success of the action.
(
Required
)
|
|
Type
|
code
|
Is
Modifier
Is Modifier
|
true
|
|
Requirements
|
Indicates
how
relevant
the
issue
is
to
the
overall
success
of
the
action.
Indicates how relevant the issue is to the overall success of the action.
|
|
Summary
|
true
|
|
Comments
|
This
is
labeled
as
"Is
Modifier"
because
applications
should
not
confuse
hints
and
warnings
with
errors.
This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.
|
|
OperationOutcome.issue.code
|
|
Definition
|
Describes
the
type
of
the
issue.
The
system
that
creates
an
OperationOutcome
SHALL
choose
the
most
applicable
code
from
the
IssueType
value
set,
and
may
additional
provide
its
own
code
for
the
error
in
the
details
element.
Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.
|
|
Control
|
1..1
|
|
Binding
|
IssueType:
A
code
that
describes
the
type
of
issue.
(
IssueType:
A code that describes the type of issue.
(
Required
)
|
|
Type
|
code
|
|
Requirements
|
Expresses
the
issue
in
a
human
and
computer-friendly
way,
allowing
the
requesting
system
to
behave
differently
based
on
the
type
of
issue.
Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.
|
|
Summary
|
true
|
|
OperationOutcome.issue.details
|
|
Definition
|
Additional
details
about
the
error.
This
may
be
a
text
description
of
the
error,
or
a
system
code
that
identifies
the
error.
Additional details about the error. This may be a text description of the error, or a system code that identifies the error.
|
|
Control
|
0..1
|
|
Binding
|
Operation
Outcome
Codes:
A
code
that
provides
details
as
the
exact
issue.
(
Operation Outcome Codes:
A code that provides details as the exact issue.
(
Example
)
|
|
Type
|
CodeableConcept
|
|
Summary
|
true
|
|
Comments
|
A
human
readable
description
of
the
error
issue
SHOULD
be
placed
in
details.text.
A human readable description of the error issue SHOULD be placed in details.text.
|
|
OperationOutcome.issue.diagnostics
|
|
Definition
|
Additional
diagnostic
information
about
the
issue.
Typically,
this
may
be
a
description
of
how
a
value
is
erroneous,
or
a
stack
dump
to
help
trace
the
issue.
Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Summary
|
true
|
|
Comments
|
Typically
this
field
is
used
to
provide
troubleshooting
information
about
the
error.
Typically this field is used to provide troubleshooting information about the error.
|
|
OperationOutcome.issue.location
|
|
Definition
|
A
simple
XPath
limited
to
element
names,
repetition
indicators
and
the
default
child
access
that
identifies
one
of
the
elements
in
the
resource
that
caused
this
issue
to
be
raised.
A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.
|
|
Control
|
0..*
|
|
Type
|
string
|
|
Requirements
|
Allows
systems
to
highlight
or
otherwise
guide
users
to
elements
implicated
in
issues
to
allow
them
to
be
fixed
more
easily.
Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.
|
|
Summary
|
true
|
|
Comments
|
The
root
of
the
XPath
is
the
resource
or
bundle
that
generated
OperationOutcome.
Each
XPath
SHALL
resolve
to
a
single
node.
The
XPath
syntax
is
used
whether
the
referenced
instance
is
expressed
in
XML
or
JSON.
The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. The XPath syntax is used whether the referenced instance is expressed in XML or JSON. Note that expression is being trialed as an alternative to XPath.
|
|
OperationOutcome.issue.expression
|
|
Definition
|
©
HL7.org
2011+.
FHIR
DSTU2
(v1.0.2-7202)
generated
on
Sat,
Oct
24,
2015
07:43+1100.
Links:
Search
A simple FluentPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.
|
Control
|
Version
History
|
Table
of
Contents
|
Compare
to
DSTU1
|
0..*
|
Type
|
|
string
|
Propose
a
change
|
|
Requirements
|
Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.
|
|
Summary
|
true
|
|
Comments
|
The root of the FluentPath is the resource or bundle that generated OperationOutcome. Each FluentPath SHALL resolve to a single node.
|