HTML View

Table View

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="UKCore-SpineErrorOrWarningCode" />
    <url value="https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode" />
    <version value="1.0.0" />
    <name value="UKCoreSpineErrorOrWarningCode" />
    <title value="UK Core Spine Error Or Warning Code" />
    <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="A set of codes that define types of Spine error and warning." />
    <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." />
    <caseSensitive value="true" />
    <content value="complete" />
    <concept>
        <code value="ACCESS_DENIED" />
        <display value="Access has been denied to process this request" />
        <definition value="Used when the user does not have permission for a particular request. e.g. when their ASID does not have the correct interactions attached to it." />
    </concept>
    <concept>
        <code value="FAILURE_TO_PROCESS_MESSAGE" />
        <display value="Failure to process message" />
        <definition value="A default message when something really bad has happened that the system could not handle." />
    </concept>
    <concept>
        <code value="UNABLE_TO_CALL_SERVICE" />
        <display value="Unable to call service" />
        <definition value="For a synchronous request, the downstream domain processing has not completed within the configured timeout period." />
    </concept>
    <concept>
        <code value="UNSUPPORTED_SERVICE" />
        <display value="Unsupported service" />
        <definition value="The service the user requested is an endpoint that does not exist - so is unsupported. e.g. /Patient/9999999999/Pets" />
    </concept>
    <concept>
        <code value="RESOURCE_NOT_FOUND" />
        <display value="Resource not found" />
        <definition value="The resource was not found." />
    </concept>
    <concept>
        <code value="INVALID_RESOURCE_ID" />
        <display value="Invalid resource ID" />
        <definition value="The resource ID was not valid. For example a NHS Number is presented which is not a valid NHS Number." />
    </concept>
    <concept>
        <code value="INVALIDATED_RESOURCE" />
        <display value="Invalidated resource" />
        <definition value="The resource has been invalidated so could not be returned." />
    </concept>
    <concept>
        <code value="INVALID_SEARCH_DATA" />
        <display value="Invalid search data" />
        <definition value="The search parameters are invalid. A description of what exactly is at fault will be added to the display." />
    </concept>
    <concept>
        <code value="TOO_MANY_MATCHES" />
        <display value="Too many matches" />
        <definition value="Too many matches were found - user should refine their search parameters." />
    </concept>
    <concept>
        <code value="PRECONDITION_FAILED" />
        <display value="Precondition failed" />
        <definition value="Request missing basic requirements such as If-Match header (or invalid headers)." />
    </concept>
    <concept>
        <code value="RESOURCE_VERSION_MISMATCH" />
        <display value="Resource version mismatch" />
        <definition value="The resource version has changed since your last read, so the update has been rejected." />
    </concept>
    <concept>
        <code value="FORBIDDEN_UPDATE" />
        <display value="Forbidden update" />
        <definition value="The user is not permitted to update certain resources or elements - a detailed description will be added to the display. For example - updating a sensitive patient or adding a formal death notification is only permitted from certain systems." />
    </concept>
    <concept>
        <code value="VALIDATION_ERROR" />
        <display value="Validation error" />
        <definition value="This it the &#39;default&#39; error thrown when no others are applicable." />
    </concept>
    <concept>
        <code value="INVALID_UPDATE" />
        <display value="Invalid update" />
        <definition value="The update was invalid - a detailed description will be added to the display." />
    </concept>
    <concept>
        <code value="MISSING_VALUE" />
        <display value="Missing value" />
        <definition value="There was a missing value in the request. For example - a name update that is missing the surname. The missing value will be presented in the display." />
    </concept>
    <concept>
        <code value="INVALID_VALUE" />
        <display value="Invalid value" />
        <definition value="There was an invalid value in the request. For example - a name update where the surname is too long. The invalid value and field will be presented in the display." />
    </concept>
    <concept>
        <code value="UNSUPPORTED_VALUE" />
        <display value="Unsupported value" />
        <definition value="There was an unsupported value in the request. The value may be valid in the schema - however it could be a legacy value that we do not allow to be set anymore. For example - setting the death notification status to &#39;removed&#39;. The invalid value and field will be presented in the display." />
    </concept>
    <concept>
        <code value="TOO_FEW_VALUES_SUBMITTED" />
        <display value="Too few values submitted" />
        <definition value="The field in question has a minimum number of items and the user sent too few." />
    </concept>
    <concept>
        <code value="TOO_MANY_VALUES_SUBMITTED" />
        <display value="Too many values submitted" />
        <definition value="The field in question has a maximum number of items and the user sent too many." />
    </concept>
    <concept>
        <code value="ADDITIONAL_PROPERTIES" />
        <display value="Additional properties" />
        <definition value="The user sent additional properties within the dictionary. For example sending a patient patch and attempting to add &#39;pets&#39;, which is not an allowed field within the patient resource." />
    </concept>
    <concept>
        <code value="POLLING_ID_NOT_FOUND" />
        <display value="Polling ID not found" />
        <definition value="When polling the ID was not found - or it was not applicable such as a non polling ID." />
    </concept>
    <concept>
        <code value="POLLING_MESSAGE_FAILURE" />
        <display value="Polling message failure" />
        <definition value="When polling an ID, a message was found to be in a failed state, so there is nothing else to be done and should be considered a failure." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "UKCore-SpineErrorOrWarningCode",
    "url": "https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode",
    "version": "1.0.0",
    "name": "UKCoreSpineErrorOrWarningCode",
    "title": "UK Core Spine Error Or Warning Code",
    "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": "A set of codes that define types of Spine error and warning.",
    "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.",
    "caseSensitive": true,
    "content": "complete",
    "concept":  [
        {
            "code": "ACCESS_DENIED",
            "display": "Access has been denied to process this request",
            "definition": "Used when the user does not have permission for a particular request. e.g. when their ASID does not have the correct interactions attached to it."
        },
        {
            "code": "FAILURE_TO_PROCESS_MESSAGE",
            "display": "Failure to process message",
            "definition": "A default message when something really bad has happened that the system could not handle."
        },
        {
            "code": "UNABLE_TO_CALL_SERVICE",
            "display": "Unable to call service",
            "definition": "For a synchronous request, the downstream domain processing has not completed within the configured timeout period."
        },
        {
            "code": "UNSUPPORTED_SERVICE",
            "display": "Unsupported service",
            "definition": "The service the user requested is an endpoint that does not exist - so is unsupported. e.g. /Patient/9999999999/Pets"
        },
        {
            "code": "RESOURCE_NOT_FOUND",
            "display": "Resource not found",
            "definition": "The resource was not found."
        },
        {
            "code": "INVALID_RESOURCE_ID",
            "display": "Invalid resource ID",
            "definition": "The resource ID was not valid. For example a NHS Number is presented which is not a valid NHS Number."
        },
        {
            "code": "INVALIDATED_RESOURCE",
            "display": "Invalidated resource",
            "definition": "The resource has been invalidated so could not be returned."
        },
        {
            "code": "INVALID_SEARCH_DATA",
            "display": "Invalid search data",
            "definition": "The search parameters are invalid. A description of what exactly is at fault will be added to the display."
        },
        {
            "code": "TOO_MANY_MATCHES",
            "display": "Too many matches",
            "definition": "Too many matches were found - user should refine their search parameters."
        },
        {
            "code": "PRECONDITION_FAILED",
            "display": "Precondition failed",
            "definition": "Request missing basic requirements such as If-Match header (or invalid headers)."
        },
        {
            "code": "RESOURCE_VERSION_MISMATCH",
            "display": "Resource version mismatch",
            "definition": "The resource version has changed since your last read, so the update has been rejected."
        },
        {
            "code": "FORBIDDEN_UPDATE",
            "display": "Forbidden update",
            "definition": "The user is not permitted to update certain resources or elements - a detailed description will be added to the display. For example - updating a sensitive patient or adding a formal death notification is only permitted from certain systems."
        },
        {
            "code": "VALIDATION_ERROR",
            "display": "Validation error",
            "definition": "This it the 'default' error thrown when no others are applicable."
        },
        {
            "code": "INVALID_UPDATE",
            "display": "Invalid update",
            "definition": "The update was invalid - a detailed description will be added to the display."
        },
        {
            "code": "MISSING_VALUE",
            "display": "Missing value",
            "definition": "There was a missing value in the request. For example - a name update that is missing the surname. The missing value will be presented in the display."
        },
        {
            "code": "INVALID_VALUE",
            "display": "Invalid value",
            "definition": "There was an invalid value in the request. For example - a name update where the surname is too long. The invalid value and field will be presented in the display."
        },
        {
            "code": "UNSUPPORTED_VALUE",
            "display": "Unsupported value",
            "definition": "There was an unsupported value in the request. The value may be valid in the schema - however it could be a legacy value that we do not allow to be set anymore. For example - setting the death notification status to 'removed'. The invalid value and field will be presented in the display."
        },
        {
            "code": "TOO_FEW_VALUES_SUBMITTED",
            "display": "Too few values submitted",
            "definition": "The field in question has a minimum number of items and the user sent too few."
        },
        {
            "code": "TOO_MANY_VALUES_SUBMITTED",
            "display": "Too many values submitted",
            "definition": "The field in question has a maximum number of items and the user sent too many."
        },
        {
            "code": "ADDITIONAL_PROPERTIES",
            "display": "Additional properties",
            "definition": "The user sent additional properties within the dictionary. For example sending a patient patch and attempting to add 'pets', which is not an allowed field within the patient resource."
        },
        {
            "code": "POLLING_ID_NOT_FOUND",
            "display": "Polling ID not found",
            "definition": "When polling the ID was not found - or it was not applicable such as a non polling ID."
        },
        {
            "code": "POLLING_MESSAGE_FAILURE",
            "display": "Polling message failure",
            "definition": "When polling an ID, a message was found to be in a failed state, so there is nothing else to be done and should be considered a failure."
        }
    ]
}