FGMRISQueryRequestResponse

Spine-OperationOutcome-1-0

Spine-OperationOutcome-1-0

OperationOutcome
Definition

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

Control 1..1
Type DomainResource
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..*
Type BackboneElement
Comments
OperationOutcome.issue.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control 0..*
Type Extension
Is Modifier True
Aliases extensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

OperationOutcome.issue.severity
Definition

Indicates whether the issue indicates a variation from successful processing.

Control 1..1
Binding

How the issue affects the success of the action.

The codes SHALL be taken from http://hl7.org/fhir/DSTU2/valueset-issue-severity

Type Code
Is Modifier True
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.code
Definition

Describes the type of the issue.

Control 1..1
Binding

A code that describes the type of issue.

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/issue-type

Type 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. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide it's own codes in other coding elements in the type. A human readable description of the type of the issue SHOULD be placed in code.text.

Comments
OperationOutcome.issue.details
Definition

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

Control 1..1
Binding

A coded expression of the type of issue

The codes SHALL be taken from http://fhir.nhs.net/ValueSet/spine-response-code-2-0

Type CodeableConcept
Comments

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

OperationOutcome.issue.details.coding
Definition

A reference to a code defined by a terminology system.

Control 1..1
Type Coding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

OperationOutcome.issue.details.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control 1..1
Type Uri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Value http://fhir.nhs.net/ValueSet/spine-response-code-2-0
OperationOutcome.issue.details.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control 1..1
Type Code
Requirements

Need to refer to a particular code in the system.

Comments
Example NO_RECORD_FOUND
OperationOutcome.issue.details.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control 0..1
Type String
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
OperationOutcome.issue.details.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control 0..1
Type String
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

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
Comments

Typically this field is used to provide troubleshooting information about the error.