6.10 OperationOutcome リソース

logo fhir

HomeInfrastructureOperationOutcome [operationoutcome]

Resource OperationOutcome - Content6.10

A collection of error, warning or information messages that result from a system action.

Operation Outcomes are sets of error, warning and information messages that provide detailed information about the outcome of some attempted system operation. They are provided as a direct system response, or component of one, where they provide information about the outcome of the operation.

Specifically, OperationOutcomes are used in the following circumstances:

  • When an RESTful operation fails
  • As the response on a validation operation, to provide information about the outcomes
  • As part of a message response, usually when the message has not been processed correctly

Resource Content6.10.1

<OperationOutcome xmlns="http://hl7.org/fhir"> <!-- from Resource: extension, narrative, and contained --> <issue> <!-- 1..* A single issue associated with the action --> <severity value="[code]"/><!-- 1..1 error | warning | information --> <type><!-- 0..1 Coding Error or warning code --></type> <details value="[string]"/><!-- 0..1 Additional description of the issue --> <location value="[string]"/><!-- 0..* XPath of element(s) related to issue --> </issue> </OperationOutcome>

Alternate definitions: Schema/Schematron, Resource Profile

Terminology Bindings 6.10.1.1

Using Operation Outcome Resources6.10.2

On the RESTful interface, operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by the HTTP response codes. This granularity could include:

  • more detail about the location of an issue
  • the ability to identify multiple distinct issues
  • provision of finer error codes that connect to known business failure states

Operation outcomes returned SHOULD be in alignment with the HTTP response code. For example, if the HTTP code indicates a failure (300+), at least one of the issues should have a severity of "error", indicating the reason for the failure.

Search Parameters 6.10.3

Search Parameters for RESTful searches. The standard parameters also apply. See Searching for more information.

Name / Type

_id : token

Description

The logical resource id associated with the resource (must be supported by all servers)

Paths