type: resource-definitionsresource: OperationOutcome

OperationOutcome Definitions

OperationOutcome

Information about the success/failure of an action

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

Comments: Can result from the failure of a REST call or be part of the response message returned from a request message.

Cardinality: 0..*

Mappings: rim=Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required); w5=infrastructure.exchange

OperationOutcome.issue

A single issue associated with the action

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

Cardinality: 1..*

Type: BackboneElement

Summary: true

Mappings: v2=ERR; rim=AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]

OperationOutcome.issue.severity

fatal | error | warning | information | success

Definition: Indicates whether the issue indicates a variation from successful processing.

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

Cardinality: 1..1

Type: code

Binding: required:issue-severity

Summary: true

Mappings: v2=ERR-4; rim=./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode="OBS" and moodCode="EVN" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type="CD"]

OperationOutcome.issue.code

Error or warning code

Definition: Describes the type of 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.

Comments: Code values should align with the severity. For example, a code of forbidden generally wouldn't make sense with a severity of information or warning. Similarly, a code of informational would generally not make sense with a severity of fatal or error. However, there are no strict rules about what severities must be used with which codes. For example, code-invalid might be a warning or error, depending on the context

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

The required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned.

Cardinality: 1..1

Type: code

Binding: required:issue-type

Summary: true

Mappings: v2=ERR-3; rim=./code

OperationOutcome.issue.details

Additional details about the error

Definition: Additional details about the error. This may be a text description of the error or a system code that identifies the error.

Comments: A human readable description of the error issue SHOULD be placed in details.text.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:audit-event-outcome-detail-example

Summary: true

Mappings: v2=ERR-5; rim=./code

OperationOutcome.issue.diagnostics

Additional diagnostic information about the issue

Definition: Additional diagnostic information about the issue.

Comments: This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.

Cardinality: 0..1

Type: string

Summary: true

Mappings: v2=ERR-8; rim=./text[parent::AcknowledgmentDetail]

OperationOutcome.issue.location

Deprecated: Path of element(s) related to issue

Definition: This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse.

For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.

Comments: The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression.

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

Cardinality: 0..*

Type: string

Summary: true

Mappings: v2=ERR-2; rim=./location[parent::AcknowledgmentDetail]

OperationOutcome.issue.expression

FHIRPath of element(s) related to issue

Definition: A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.

Comments: The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.

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

Cardinality: 0..*

Type: string

Summary: true

Mappings: v2=ERR-2; rim=./location[parent::AcknowledgmentDetail]