DSTU2

This page is part of the FHIR Specification (v0.0.82: (v1.0.2: DSTU 1). 2). 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.6 6.12.7 Resource OperationOutcome - Formal Definitions Detailed Descriptions

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

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

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

Control 1..*
Summary true
OperationOutcome.issue.severity
Definition

Indicates whether the issue indicates a variation from successful processing.

Control 1..1
Binding IssueSeverity: How the issue affects the success of the action (see http://hl7.org/fhir/issue-severity action. for values) ( 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.type OperationOutcome.issue.code
Definition A code indicating

Describes the type of error, warning or information message. 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 0..1 1..1
Binding IssueType: A coded expression of code that describes the type of issue (see http://hl7.org/fhir/issue-type issue. for values) ( Required )
Type Coding 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.

Comments Summary Codes should only true
OperationOutcome.issue.details
Definition

Additional details about the error. This may be defined at a level of granularity that reasonably allows distinct actions to be taken by the receiving system. If the response behavior text description of all systems is the same for two codes, error, or a system code that identifies the codes might error.

Control 0..1
Binding Operation Outcome Codes: A code that provides details as well be merged. The human-meaningful content the exact issue. ( Example )
Type CodeableConcept
Summary true
Comments

A human readable description of the error issue is conveyed SHOULD be placed in .text. details.text.

OperationOutcome.issue.details 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 0..1
Type string
Summary true
Comments typically

Typically this field is used to provide details human-readable troubleshooting 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.

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

var disqus_shortname = 'fhirdstu';(function() {var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })(); Please enable JavaScript to view the comments powered by Disqus. comments powered by Disqus