OperationOutcome | Medplum

Elements

Name	Required	Type	Description
issue	✓	OperationOutcomeIssue[]	A single issue associated with the action Details An error, warning, or information message that results from a system action.
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element.
...	...	...	...

Search Parameters

None

Inherited Elements

Name	Required	Type	Description
id		string	Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource.
meta		Meta	Metadata about the resource Details The metadata about the resource.
language		code	Language of the resource content Details The base language in which the resource is written.
text		Narrative	Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human.
...	...	...	...

Operation outcomes are sets of error, warning, and information messages that provide detailed information about the outcome of an attempted system operation. They are provided as a direct system response, or component of one, and provide information about the outcome of the operation.

The OperationOutcome resource is used in the following circumstances:

When a RESTful interaction or operation fails
As the response on a validation operation to provide information about the outcome
As part of a message response, usually when the message has not been processed correctly
As the response to a batch/transaction, when requested
As part of a search's Bundle response containing information about the search

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action; these would be handled using DetectedIssue or other resources. OperationOutcome is not designed to be persisted or referenced from other parts of the workflow.

It is possible to have both OperationOutcome and DetectedIssue together, where the OperationOutcome might indicate that a requested action was rejected due to a clinical issue and the DetectedIssue provides the details of the issue.