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.6 Resource OperationOutcome - Formal Definitions

Formal definitions for the elements in the OperationOutcome resource.

OperationOutcome
DefinitionA collection of error, warning or information messages that result from a system action.
Control1..1
CommentsCan 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
DefinitionAn error, warning or information message that results from a system action.
Control1..*
OperationOutcome.issue.severity
DefinitionIndicates whether the issue indicates a variation from successful processing.
Control1..1
BindingIssueSeverity: How the issue affects the success of the action (see http://hl7.org/fhir/issue-severity for values)
Typecode
Is Modifiertrue
RequirementsIndicates how relevant the issue is to the overall success of the action.
CommentsThis is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.
OperationOutcome.issue.type
DefinitionA code indicating the type of error, warning or information message.
Control0..1
BindingIssueType: A coded expression of the type of issue (see http://hl7.org/fhir/issue-type for values)
TypeCoding
RequirementsExpresses the issue in a computer-friendly way, allowing the requesting system to behave differently based on the type of issue.
CommentsCodes 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
DefinitionAdditional description of the issue.
Control0..1
Typestring
Commentstypically this field is used to provide details human-readable information about the error.
OperationOutcome.issue.location
DefinitionA 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
RequirementsAllows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.
CommentsThe 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.

comments powered by Disqus