2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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.13.4 Resource OperationOutcome - Detailed Descriptions

Detailed Descriptions for the elements in the OperationOutcome resource.

OperationOutcome
Definition

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

Control1..1
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
Definition

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

Control1..*
OperationOutcome.issue.severity
Definition

Indicates whether the issue indicates a variation from successful processing.

Control1..1
BindingIssueSeverity: Required: http://hl7.org/fhir/issue-severity (How the issue affects the success of the action)
Typecode
Is Modifiertrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.

OperationOutcome.issue.type
Definition

A code indicating the type of error, warning or information message.

Control0..1
BindingIssueType: Preferred: http://hl7.org/fhir/issue-type (A coded expression of the type of issue)
TypeCoding
Requirements

Expresses the issue in a computer-friendly way, allowing the requesting system to behave differently based on the type of issue.

Comments

Codes should only be defined at a level of granularity that reasonably allows distinct actions to be taken by the receiving system. If the response behavior of all systems is the same for two codes, the codes might as well be merged. The human-meaningful content of the issue is conveyed in .text.

OperationOutcome.issue.details
Definition

Additional description of the issue.

Control0..1
Typestring
Comments

typically this field is used to provide details human-readable information about the error.

OperationOutcome.issue.location
Definition

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.

Control0..*
Typestring
Requirements

Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

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 is expressed in XML or JSON.