UK Core Implementation Guide 0.4.0 - STU1

StructureDefinition-UKCore-OperationOutcome

Defines the UK Core constraints and extensions on the OperationOutcome resource for the minimal set of data to query and retrieve information about the outcome of an attempted system operation.

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.

Snapshot View

severityΣ1..1codeBinding
codeΣ1..1codeBinding
detailsΣ0..1CodeableConceptBinding
diagnosticsΣ0..1string
locationΣ0..*string
expressionΣ0..*string

Differential View

severityΣ1..1codeBinding
codeΣ1..1codeBinding
detailsΣ0..1CodeableConceptBinding
diagnosticsΣ0..1string
locationΣ0..*string
expressionΣ0..*string

Hybrid View

severityΣ1..1codeBinding
codeΣ1..1codeBinding
detailsΣ0..1CodeableConceptBinding
diagnosticsΣ0..1string
locationΣ0..*string
expressionΣ0..*string

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.1.0" />
    <name value="UKCoreOperationOutcome" />
    <title value="UK Core OperationOutcome" />
    <status value="active" />
    <date value="2022-01-07" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints and extensions on the OperationOutcome resource for the minimal set of data to query and retrieve information about the outcome of an attempted system operation." />
    <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.1.0",
    "name": "UKCoreOperationOutcome",
    "title": "UK Core OperationOutcome",
    "status": "active",
    "date": "2022-01-07",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the OperationOutcome resource for the minimal set of data to query and retrieve information about the outcome of an attempted system operation.",
    "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."
            }
        ]
    }
}

Profile Minimum Viable Content

Each OperationOutcome resource must have:

  • An issue
  • An issue.severity
  • An issue.code

Each OperationOutcome resource must support:

  • An issue.details

Profile specific implementation guidance:

issue

Additional details about the error.

A binding to the following ValueSet has been suggested as a starting point for the UK Core (hence the "Preferred" binding strength): ValueSet UKCore-OperationOutcomeIssueDetails.


back to top