FHIR Release 3 (STU) Current Build
FHIR Infrastructure Work Group Maturity Level : 5 N   Trial Use Normative (from v4.0.0) 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 warning, or information messages that result from a system action.

Control Cardinality 1..1 0..*
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 warning, or information message that results from a system action.

Control Cardinality 1..*
Summary true
OperationOutcome.issue.severity
Element Id OperationOutcome.issue.severity
Definition

Indicates whether the issue indicates a variation from successful processing.

Control Cardinality 1..1
Terminology Binding IssueSeverity ( Required )
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.

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 Cardinality 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.

The required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned.

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, error or a system code that identifies the error.

Control Cardinality 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 Cardinality 0..1
Type string
Summary true
Comments

Typically this field This may be a description of how a value is used erroneous, a stack dump to provide troubleshooting information about help trace the error. issue or other troubleshooting information.

OperationOutcome.issue.location
Standards Status This element has a standards status of "Deprecated" which is different from the status of the whole resource
Element Id OperationOutcome.issue.location
Definition

This element is deprecated 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 accessor 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 Cardinality 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 This element is expressed in XML or JSON. Note that expression deprecated, and is being trialed as an alternative to XPath. replaced by expression.

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 accessor that identifies one of the elements in the resource that caused this issue to be raised.

Control Cardinality 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.