API Hub

Explore and Make use of Nationally Defined Messaging APIs

This is a HL7 FHIR server, and as you appear to be accessing this page from a web browser you are seeing a HTML version of the requested resource(s). You can also access this URL from a FHIR client as a ReSTful API call. For more details please see the HL7 FHIR specification.
FHIR Version: STU3 Version History
Show Raw Profile: XML | JSON

Codes defined by ITK Response Codes

System: https://fhir.nhs.uk/STU3/CodeSystem/ITK-ResponseCodes-1

Code Description
10001 Handling Specification Error
10002 Infrastructure Level Response Value - Processing Error
10003 Business Level Response Value - Processing Error
10004 Message Definition Value - Processing Error
10005 Message Definition Version Value - Processing Error
10007 Sender Reference Value - Processing Error
10008 Handling Specification Business Rule Error
10009 Unreadable message received
10010 Recipient Type - Processing Error
20001 Unrecognised Recipient Person
20002 Unrecognised Recipient Organisation
20003 Unrecognised Sender
20004 Non-Approved file type received as an attachment
20005 Unsupported file type received as an attachment
20006 ITK header validation failure
20007 Duplicate Message received
20008 Duplicate Document received
20009 Payload validation failure
20010 Unrecognised Payload Recipient Organisation
20011 Unrecognised Payload Recipient Person
20012 Unauthorised Sender
20013 Success
20014 Unable to Process Replacement Document
20015 Message too large
30001 Patient known here. (e.g. Patient is registered here)
30002 Patient not known here. (aka 'patient record not present in system')
30003 Patient no longer at this clinical setting
30004 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)
30005 Referral open
30006 Referral completed
30007 Referral escalated back to GP
30008 Signposting to GP (non-urgent)
30009 Clinical escalation to UTC/111/GPOOH
30010 Clinical escalation to A&E or 999
30011 Advised to go elsewhere/self-referral
30012 Unable to contact the patient
30013 Closure (service not needed)
30014 Closure (service not accepted)
30015 Closure (duplicate referral)
30016 Referral accepted
30017 Referral rejected
30018 Did Not Attend
30019 GP Registration - Application accepted
30020 GP Registration - Application pending (contact practice)
30021 GP Registration - Application rejected (patient already registered)
30022 GP Registration - Application rejected (at capacity)
30023 GP Registration - Application rejected (out of boundary)
30024 GP Registration - Application rejected (Previously removed from this practice)
30025 GP Registration - Application rejected (Previously removed from another practice)