UK Core Implementation Guide 0.3.0 STU1

UK Core ITK Response Code

HTML View

This code system https://fhir.hl7.org.uk/CodeSystem/UKCore-ITKResponseCode defines the following codes:

CodeDisplay
10001Handling Specification Error
10002Infrastructure Level Response Value - Processing Error
10003Business Level Response Value - Processing Error
10004Message Definition Value - Processing Error
10005Message Definition Version Value - Processing Error
10007Sender Reference Value - Processing Error
10008Handling Specification Business Rule Error
10009Unreadable message received
10010Recipient Type - Processing Error
20001Unrecognised Recipient Person
20002Unrecognised Recipient Organisation
20003Unrecognised Sender
20004Non-Approved file type received as an attachment
20005Unsupported file type received as an attachment
20006ITK header validation failure
20007Duplicate Message received
20008Duplicate Document received
20009Payload validation failure
20010Unrecognised Payload Recipient Organisation
20011Unrecognised Payload Recipient Person
20012Unauthorised Sender
20013Success
20014Unable to Process Replacement Document
20015Message too large
30001Patient known here. (e.g. Patient is registered here)
30002Patient not known here. (aka 'patient record not present in system')
30003Patient no longer at this clinical setting
30004Patient known here and recently deceased (i.e. patient record current in GP practice system at time of patient’s death and deduction subsequently occurred for this reason)

Table View

CodeSystem.id[0]UKCore-ITKResponseCode
CodeSystem.url[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-ITKResponseCode
CodeSystem.version[0]1.0.0
CodeSystem.name[0]UKCoreITKResponseCode
CodeSystem.title[0]UK Core ITK Response Code
CodeSystem.status[0]active
CodeSystem.date[0]2022-01-07
CodeSystem.publisher[0]HL7 UK
CodeSystem.contact[0].name[0]HL7 UK
CodeSystem.contact[0].telecom[0].system[0]email
CodeSystem.contact[0].telecom[0].value[0]secretariat@hl7.org.uk
CodeSystem.contact[0].telecom[0].use[0]work
CodeSystem.contact[0].telecom[0].rank[0]1
CodeSystem.contact[1].name[0]NHS Digital
CodeSystem.contact[1].telecom[0].system[0]email
CodeSystem.contact[1].telecom[0].value[0]interoperabilityteam@nhs.net
CodeSystem.contact[1].telecom[0].use[0]work
CodeSystem.contact[1].telecom[0].rank[0]2
CodeSystem.description[0]A set of codes that define the ITK response returned to a sender.
CodeSystem.copyright[0]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.
CodeSystem.caseSensitive[0]True
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]10001
CodeSystem.concept[0].display[0]Handling Specification Error
CodeSystem.concept[1].code[0]10002
CodeSystem.concept[1].display[0]Infrastructure Level Response Value - Processing Error
CodeSystem.concept[2].code[0]10003
CodeSystem.concept[2].display[0]Business Level Response Value - Processing Error
CodeSystem.concept[3].code[0]10004
CodeSystem.concept[3].display[0]Message Definition Value - Processing Error
CodeSystem.concept[4].code[0]10005
CodeSystem.concept[4].display[0]Message Definition Version Value - Processing Error
CodeSystem.concept[5].code[0]10007
CodeSystem.concept[5].display[0]Sender Reference Value - Processing Error
CodeSystem.concept[6].code[0]10008
CodeSystem.concept[6].display[0]Handling Specification Business Rule Error
CodeSystem.concept[7].code[0]10009
CodeSystem.concept[7].display[0]Unreadable message received
CodeSystem.concept[8].code[0]10010
CodeSystem.concept[8].display[0]Recipient Type - Processing Error
CodeSystem.concept[9].code[0]20001
CodeSystem.concept[9].display[0]Unrecognised Recipient Person
CodeSystem.concept[10].code[0]20002
CodeSystem.concept[10].display[0]Unrecognised Recipient Organisation
CodeSystem.concept[11].code[0]20003
CodeSystem.concept[11].display[0]Unrecognised Sender
CodeSystem.concept[12].code[0]20004
CodeSystem.concept[12].display[0]Non-Approved file type received as an attachment
CodeSystem.concept[13].code[0]20005
CodeSystem.concept[13].display[0]Unsupported file type received as an attachment
CodeSystem.concept[14].code[0]20006
CodeSystem.concept[14].display[0]ITK header validation failure
CodeSystem.concept[15].code[0]20007
CodeSystem.concept[15].display[0]Duplicate Message received
CodeSystem.concept[16].code[0]20008
CodeSystem.concept[16].display[0]Duplicate Document received
CodeSystem.concept[17].code[0]20009
CodeSystem.concept[17].display[0]Payload validation failure
CodeSystem.concept[18].code[0]20010
CodeSystem.concept[18].display[0]Unrecognised Payload Recipient Organisation
CodeSystem.concept[19].code[0]20011
CodeSystem.concept[19].display[0]Unrecognised Payload Recipient Person
CodeSystem.concept[20].code[0]20012
CodeSystem.concept[20].display[0]Unauthorised Sender
CodeSystem.concept[21].code[0]20013
CodeSystem.concept[21].display[0]Success
CodeSystem.concept[22].code[0]20014
CodeSystem.concept[22].display[0]Unable to Process Replacement Document
CodeSystem.concept[23].code[0]20015
CodeSystem.concept[23].display[0]Message too large
CodeSystem.concept[24].code[0]30001
CodeSystem.concept[24].display[0]Patient known here. (e.g. Patient is registered here)
CodeSystem.concept[25].code[0]30002
CodeSystem.concept[25].display[0]Patient not known here. (aka 'patient record not present in system')
CodeSystem.concept[26].code[0]30003
CodeSystem.concept[26].display[0]Patient no longer at this clinical setting
CodeSystem.concept[27].code[0]30004
CodeSystem.concept[27].display[0]Patient known here and recently deceased (i.e. patient record current in GP practice system at time of patient’s death and deduction subsequently occurred for this reason)

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="UKCore-ITKResponseCode" />
    <url value="https://fhir.hl7.org.uk/CodeSystem/UKCore-ITKResponseCode" />
    <version value="1.0.0" />
    <name value="UKCoreITKResponseCode" />
    <title value="UK Core ITK Response 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 the ITK response returned to a sender." />
    <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="10001" />
        <display value="Handling Specification Error" />
    </concept>
    <concept>
        <code value="10002" />
        <display value="Infrastructure Level Response Value - Processing Error" />
    </concept>
    <concept>
        <code value="10003" />
        <display value="Business Level Response Value - Processing Error" />
    </concept>
    <concept>
        <code value="10004" />
        <display value="Message Definition Value - Processing Error" />
    </concept>
    <concept>
        <code value="10005" />
        <display value="Message Definition Version Value - Processing Error" />
    </concept>
    <concept>
        <code value="10007" />
        <display value="Sender Reference Value - Processing Error" />
    </concept>
    <concept>
        <code value="10008" />
        <display value="Handling Specification Business Rule Error" />
    </concept>
    <concept>
        <code value="10009" />
        <display value="Unreadable message received" />
    </concept>
    <concept>
        <code value="10010" />
        <display value="Recipient Type - Processing Error" />
    </concept>
    <concept>
        <code value="20001" />
        <display value="Unrecognised Recipient Person" />
    </concept>
    <concept>
        <code value="20002" />
        <display value="Unrecognised Recipient Organisation" />
    </concept>
    <concept>
        <code value="20003" />
        <display value="Unrecognised Sender" />
    </concept>
    <concept>
        <code value="20004" />
        <display value="Non-Approved file type received as an attachment" />
    </concept>
    <concept>
        <code value="20005" />
        <display value="Unsupported file type received as an attachment" />
    </concept>
    <concept>
        <code value="20006" />
        <display value="ITK header validation failure" />
    </concept>
    <concept>
        <code value="20007" />
        <display value="Duplicate Message received" />
    </concept>
    <concept>
        <code value="20008" />
        <display value="Duplicate Document received" />
    </concept>
    <concept>
        <code value="20009" />
        <display value="Payload validation failure" />
    </concept>
    <concept>
        <code value="20010" />
        <display value="Unrecognised Payload Recipient Organisation" />
    </concept>
    <concept>
        <code value="20011" />
        <display value="Unrecognised Payload Recipient Person" />
    </concept>
    <concept>
        <code value="20012" />
        <display value="Unauthorised Sender" />
    </concept>
    <concept>
        <code value="20013" />
        <display value="Success" />
    </concept>
    <concept>
        <code value="20014" />
        <display value="Unable to Process Replacement Document" />
    </concept>
    <concept>
        <code value="20015" />
        <display value="Message too large" />
    </concept>
    <concept>
        <code value="30001" />
        <display value="Patient known here. (e.g. Patient is registered here)" />
    </concept>
    <concept>
        <code value="30002" />
        <display value="Patient not known here. (aka &#39;patient record not present in system&#39;)" />
    </concept>
    <concept>
        <code value="30003" />
        <display value="Patient no longer at this clinical setting" />
    </concept>
    <concept>
        <code value="30004" />
        <display value="Patient known here and recently deceased (i.e. patient record current in GP practice system at time of patient’s death and deduction subsequently occurred for this reason)" />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "UKCore-ITKResponseCode",
    "url": "https://fhir.hl7.org.uk/CodeSystem/UKCore-ITKResponseCode",
    "version": "1.0.0",
    "name": "UKCoreITKResponseCode",
    "title": "UK Core ITK Response 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 the ITK response returned to a sender.",
    "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": "10001",
            "display": "Handling Specification Error"
        },
        {
            "code": "10002",
            "display": "Infrastructure Level Response Value - Processing Error"
        },
        {
            "code": "10003",
            "display": "Business Level Response Value - Processing Error"
        },
        {
            "code": "10004",
            "display": "Message Definition Value - Processing Error"
        },
        {
            "code": "10005",
            "display": "Message Definition Version Value - Processing Error"
        },
        {
            "code": "10007",
            "display": "Sender Reference Value - Processing Error"
        },
        {
            "code": "10008",
            "display": "Handling Specification Business Rule Error"
        },
        {
            "code": "10009",
            "display": "Unreadable message received"
        },
        {
            "code": "10010",
            "display": "Recipient Type - Processing Error"
        },
        {
            "code": "20001",
            "display": "Unrecognised Recipient Person"
        },
        {
            "code": "20002",
            "display": "Unrecognised Recipient Organisation"
        },
        {
            "code": "20003",
            "display": "Unrecognised Sender"
        },
        {
            "code": "20004",
            "display": "Non-Approved file type received as an attachment"
        },
        {
            "code": "20005",
            "display": "Unsupported file type received as an attachment"
        },
        {
            "code": "20006",
            "display": "ITK header validation failure"
        },
        {
            "code": "20007",
            "display": "Duplicate Message received"
        },
        {
            "code": "20008",
            "display": "Duplicate Document received"
        },
        {
            "code": "20009",
            "display": "Payload validation failure"
        },
        {
            "code": "20010",
            "display": "Unrecognised Payload Recipient Organisation"
        },
        {
            "code": "20011",
            "display": "Unrecognised Payload Recipient Person"
        },
        {
            "code": "20012",
            "display": "Unauthorised Sender"
        },
        {
            "code": "20013",
            "display": "Success"
        },
        {
            "code": "20014",
            "display": "Unable to Process Replacement Document"
        },
        {
            "code": "20015",
            "display": "Message too large"
        },
        {
            "code": "30001",
            "display": "Patient known here. (e.g. Patient is registered here)"
        },
        {
            "code": "30002",
            "display": "Patient not known here. (aka 'patient record not present in system')"
        },
        {
            "code": "30003",
            "display": "Patient no longer at this clinical setting"
        },
        {
            "code": "30004",
            "display": "Patient known here and recently deceased (i.e. patient record current in GP practice system at time of patient’s death and deduction subsequently occurred for this reason)"
        }
    ]
}


back to top