This
page
is
part
of
the
FHIR
Specification
(v3.3.0:
(v3.5.0:
R4
Ballot
2).
#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
FHIR
Infrastructure
Work
Group
|
Maturity Level : 5 | Normative | Compartments : Not linked to any defined compartments |
Detailed Descriptions for the elements in the OperationOutcome resource.
| OperationOutcome | |
| Element Id | OperationOutcome |
| Definition |
A collection of error, warning or information messages that result from a system action. |
| Control | 1..1 |
| Type | DomainResource |
| 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 | |
| Element Id | OperationOutcome.issue |
| Definition |
An error, warning or information message that results from a system action. |
| Control | 1..* |
| Summary | true |
| OperationOutcome.issue.severity | |
| Element Id | OperationOutcome.issue.severity |
| Definition |
Indicates whether the issue indicates a variation from successful processing. |
| Control | 1..1 |
| Terminology Binding | IssueSeverity ( Required ) |
| Type | code |
|
|
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. |
| OperationOutcome.issue.code | |
| Element Id | 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. |
| Control | 1..1 |
| Terminology Binding | IssueType ( 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. |
| Summary | true |
| OperationOutcome.issue.details | |
| Element Id | 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. |
| Control | 0..1 |
| Terminology Binding | Operation Outcome Codes ( Example ) |
| Type | CodeableConcept |
| Summary | true |
| Comments |
A human readable description of the error issue SHOULD be placed in details.text. |
| OperationOutcome.issue.diagnostics | |
| Element Id | 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. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Comments |
Typically, this field is used to provide troubleshooting information about the error. |
| OperationOutcome.issue.location | |
| Element Id | OperationOutcome.issue.location |
| Definition |
This element is depracated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. For resource issues, this will be 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. For HTTP errors, will be "http." + the parameter name. |
| 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.
|
| OperationOutcome.issue.expression | |
| Element Id | OperationOutcome.issue.expression |
| Definition |
A simple subset of FHIRPath 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 FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node. |