Please note:

This version of the UK Core is for C&TA Sprint 7 Review.
This version is not suitable for implementation. Other versions are available on the UK Core Version History Guide
Please follow the guidance on the Contact Us page if you need any assistance.
A summary of changes is available on the STU3 Sequence Change Log

Bindings

StructureDefinition-UKCore-OperationOutcome

Canonical_URL	Current_Version	Last_Updated	Description
https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome	1.2.0	2022-12-16	This profile defines the UK constraints and extensions on the International FHIR resource OperationOutcome.

Profile_Purpose
The purpose of this profile is to provide detailed information about the outcome of an attempted system operation. Operation outcomes are sets of error, warning and information messages provided as a direct system response, or part of one, and provide information about the outcome of the operation.

OperationOutcome	I		OperationOutcome	There are no (further) constraints on this element Element Id OperationOutcome Short description 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. Data Type OperationOutcome Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3: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 `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)
issue	Σ	1..*	BackboneElement	There are no (further) constraints on this element Element Id OperationOutcome.issue Short description A single issue associated with the action Definition An error, warning, or information message that results from a system action. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:ERR rim:AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]
severity	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id OperationOutcome.issue.severity Short description fatal \| error \| warning \| information 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. Comments This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors. Data Type code Binding How the issue affects the success of the action. IssueSeverity (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a 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"]
code	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id OperationOutcome.issue.code Short description 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. 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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding A code that describes the type of issue. IssueType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:ERR-3 rim:./code
details	Σ	0..1	CodeableConceptBinding	Element Id OperationOutcome.issue.details Short description 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. Data Type CodeableConcept Binding A set of codes that define details of the exact issue. UKCoreOperationOutcomeIssueDetails (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:ERR-5 rim:./code
diagnostics	Σ	0..1	string	There are no (further) constraints on this element Element Id OperationOutcome.issue.diagnostics Short description 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:ERR-8 rim:./text[parent::AcknowledgmentDetail]
location	Σ	0..*	string	Element Id OperationOutcome.issue.location Short description 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. Requirements Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:ERR-2 rim:./location[parent::AcknowledgmentDetail]
expression	Σ	0..*	string	There are no (further) constraints on this element Element Id OperationOutcome.issue.expression Short description 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. Requirements Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. Comments The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:ERR-2 rim:./location[parent::AcknowledgmentDetail]

Table View

OperationOutcome		..
OperationOutcome.issue		..
OperationOutcome.issue.details		..
OperationOutcome.issue.location		..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-OperationOutcome" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome" />
    <version value="1.2.0" />
    <name value="UKCoreOperationOutcome" />
    <title value="UK Core OperationOutcome" />
    <status value="active" />
    <date value="2022-12-16" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [OperationOutcome](https://hl7.org/fhir/R4/OperationOutcome.html)." />
    <purpose value="The purpose of this profile is to provide detailed information about the outcome of an attempted system operation. Operation outcomes are sets of error, warning and information messages provided as a direct system response, or part of one, and provide information about the outcome of the operation." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="OperationOutcome" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/OperationOutcome" />
    <derivation value="constraint" />
    <differential>
        <element id="OperationOutcome.issue.details">
            <path value="OperationOutcome.issue.details" />
            <binding>
                <strength value="preferred" />
                <description value="A set of codes that define details of the exact issue." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-OperationOutcomeIssueDetails" />
            </binding>
        </element>
        <element id="OperationOutcome.issue.location">
            <path value="OperationOutcome.issue.location" />
            <definition value="This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse.\nFor 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 &quot;http.&quot; + the parameter name." />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-OperationOutcome",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome",
    "version": "1.2.0",
    "name": "UKCoreOperationOutcome",
    "title": "UK Core OperationOutcome",
    "status": "active",
    "date": "2022-12-16",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [OperationOutcome](https://hl7.org/fhir/R4/OperationOutcome.html).",
    "purpose": "The purpose of this profile is to provide detailed information about the outcome of an attempted system operation. Operation outcomes are sets of error, warning and information messages provided as a direct system response, or part of one, and provide information about the outcome of the operation.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "OperationOutcome",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/OperationOutcome",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "OperationOutcome.issue.details",
                "path": "OperationOutcome.issue.details",
                "binding": {
                    "strength": "preferred",
                    "description": "A set of codes that define details of the exact issue.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-OperationOutcomeIssueDetails"
                }
            },
            {
                "id": "OperationOutcome.issue.location",
                "path": "OperationOutcome.issue.location",
                "definition": "This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse.\nFor 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."
            }
        ]
    }
}

Examples

DateError - An example to illustrate an error returned due to an error in a date.
Example UKCore-OperationOutcome-DateError

Usage

This Profile has the following derived profiles:

This Profile is referenced in the following Extensions:

This Profile is referenced in the following Profiles:

Profile Specific Implementation Guidance:

Minimum Viable Content

A minimum viable content that all provider and consumer systems SHALL support are the following elements.

Element	Reason
`OperationOutcome.issue`	A single issue associated with the action
`OperationOutcome.issue.severity`	Indicates how relevant the issue is to the overall success of the action. This is labelled as "Is Modifier" because applications should not confuse hints and warnings with errors.
`OperationOutcome.issue.code`	Error or warning code
`OperationOutcome.issue.expression`	FHIRPath of element(s) related to issue

Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context	Strength	Link
OperationOutcome.issue.details	Preferred	ValueSet UKCore-OperationOutcomeIssueDetails