This
page
is
part
of
the
FHIR
Specification
(v0.0.82:
(v1.0.2:
DSTU
1).
2).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Formal
definitions
Detailed
Descriptions
for
the
elements
in
the
OperationOutcome
resource.
| OperationOutcome | |
| Definition |
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. |
| OperationOutcome.issue | |
| Definition |
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. |
| Control | 1..1 |
| Binding |
IssueSeverity:
How
the
issue
affects
the
success
of
the
|
| Type | code |
| Is Modifier | true |
| Requirements |
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. |
|
|
|
| Definition |
Describes
the
type
of
|
| Control |
|
| Binding |
IssueType:
A
|
| Type |
|
| Requirements |
Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue. |
|
|
|
| OperationOutcome.issue.details | |
| Definition |
Additional
details
about
the
error.
This
may
be
|
| Control | 0..1 |
| Binding |
Operation
Outcome
Codes:
A
code
that
provides
details
as
|
| Type | CodeableConcept |
| Summary | true |
| Comments |
A
human
readable
description
of
the
error
issue
|
|
|
|
| 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. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Comments |
Typically
this
field
is
used
to
provide
|
| 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. |
| 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. |
| 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. |