FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work GroupMaturity Level: N Normative (from v4.0.0)Security Category: N/A Compartments: No 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.

Short Display Information about the success/failure of an action
Cardinality 0..*
Type DomainResource
Summary false
Comments

Can result from the failure of a REST call or be part of the response message returned from a request message.

OperationOutcome.issue
Element Id OperationOutcome.issue
Definition

An error, warning, or information message that results from a system action.

Short Display A single issue associated with the action
Cardinality 1..*
Summary true
OperationOutcome.issue.severity
Element Id OperationOutcome.issue.severity
Definition

Indicates whether the issue indicates a variation from successful processing.

Short Display fatal | error | warning | information | success
Cardinality 1..1
Terminology Binding Issue Severity (Required)
Type code
Requirements

Indicates how relevant the issue is to the overall success of the action.

Summary true
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.

Short Display Error or warning code
Cardinality 1..1
Terminology Binding Issue Type (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
Comments

Code values should align with the severity. For example, a code of forbidden generally wouldn't make sense with a severity of information or warning. Similarly, a code of informational would generally not make sense with a severity of fatal or error. However, there are no strict rules about what severities must be used with which codes. For example, code-invalid might be a warning or error, depending on the context

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.

Short Display Additional details about the error
Cardinality 0..1
Terminology Binding Financial Resource Status 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.

Short Display Additional diagnostic information about the issue
Cardinality 0..1
Type string
Summary true
Comments

This may be a description of how a value is erroneous, a stack dump to help trace the 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

This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse.

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

Short Display Deprecated: Path of element(s) related to issue
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. This element is deprecated, and is being 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 accessor that identifies one of the elements in the resource that caused this issue to be raised.

Short Display FHIRPath of element(s) related to issue
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.