Summary
Request & Response
Diagnostics
Care Provision
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Terminology
Documents
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CanonicalResource
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
DocumentReference
Encounter
EpisodeOfCare
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
SpecimenDefinition
StructureDefinition
StructureMap
Subscription
ValueSet
default
A collection of error, warning, or information messages that result from a system action.
OperationOutcome
Path
OperationOutcome
Id
OperationOutcome
Cardinality
0 - *
Definition
A collection of error, warning, or information messages that result from a system action.
Comment
Can result from the failure of a REST call or be part of the response message returned from a request message.
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3 [error]
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5 [error]
If a resource is contained in another resource, it SHALL NOT have a security label
dom-6 [warning]
A resource should have narrative for robust management
Path
OperationOutcome.issue
Id
OperationOutcome.issue
Type
Cardinality
1 - *
Definition
An error, warning, or information message that results from a system action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationOutcome.issue.severity
Id
OperationOutcome.issue.severity
Type
Cardinality
1 - 1
Definition
Indicates whether the issue indicates a variation from successful processing.
Comment
Requirements
Indicates how relevant the issue is to the overall success of the action.
Binding
Strength
required
Description
How the issue affects the success of the action.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationOutcome.issue.code
Id
OperationOutcome.issue.code
Type
Cardinality
1 - 1
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.
Comment
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.
Binding
Strength
required
Description
A code that describes the type of issue.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationOutcome.issue.details
Id
OperationOutcome.issue.details
Type
Cardinality
0 - 1
Definition
Additional details about the error. This may be a text description of the error or a system code that identifies the error.
Comment
A human readable description of the error issue SHOULD be placed in details.text.
Binding
Strength
example
Description
A code that provides details as the exact issue.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationOutcome.issue.details.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
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 labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationOutcome.issue.details.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationOutcome.issue.details.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationOutcome.issue.details.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
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).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
OperationOutcome.issue.details.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
OperationOutcome.issue.details.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationOutcome.issue.diagnostics
Id
OperationOutcome.issue.diagnostics
Type
Cardinality
0 - 1
Definition
Additional diagnostic information about the issue.
Comment
This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationOutcome.issue.location
Id
OperationOutcome.issue.location
Type
Cardinality
0 - *
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
OperationOutcome.issue.expression
Id
OperationOutcome.issue.expression
Type
Cardinality
0 - *
Definition
A [simple subset of FHIRPath](fhirpath.html#simple) 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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children