This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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

6.10 Resource OperationOutcome - Content

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

6.10.1 Scope and Usage

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:

6.10.2 Resource Content

OperationOutcome (Resource)IssueIndicates whether the issue indicates a variation from successful processing (this element modifies the meaning of other elements)severity : code 1..1 <<How the issue affects the success of the actionIssueSeverity>>A code indicating the type of error, warning or information messagetype : Coding 0..1 <<A coded expression of the type of issueIssueType>>Additional description of the issuedetails : string 0..1A 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 raisedlocation : string 0..*An error, warning or information message that results from a system actionissue1..*

This resource is referenced by [MessageHeader]

<OperationOutcome xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: extension, modifierExtension, language, text, and contained -->
 <issue>  <!-- 1..* A single issue associated with the action -->
  <severity value="[code]"/><!-- 1..1 fatal | 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

6.10.2.1 Terminology Bindings

PathDefinitionTypeReference
OperationOutcome.issue.severity How the issue affects the success of the actionFixedhttp://hl7.org/fhir/issue-severity
OperationOutcome.issue.type A coded expression of the type of issueFixedhttp://hl7.org/fhir/issue-type

6.10.3 Using Operation Outcome Resources

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:

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.

6.10.4 Search Parameters

Search parameters for this resource. The standard parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
_idtokenThe logical resource id associated with the resource (must be supported by all servers)
_languagetokenThe language of the resource
comments powered by Disqus