Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

ITK3 Response Codes

Response codes for ITK3 messaging

Response Code Types

There will be two types of response codes:

  • Positive Response codes
  • Negative Response codes

Note: All Negative response codes are deemed to be fatal and no further processing will be carried out on the message. There will be no further response message following the response message that contains the negative response code regardless of what acknowledgement flags are set.

The ITK3 Response Codes

The ITK3 Response Codes have three prefixes. The codes are returned in response to the handling specification acknowledgement flags in the header of the incoming message. The validation of the incoming message may vary from system to system however the following rules apply to the codes:

InfAckRequested=true

  • Prefix 1 and 2 (10001 to 20013) should be returned

BusAckRequested=true

  • Prefix 3 (30001 to 30003) must be returned
Response Code Type of Response Display Name Description
10001 Negative Handling Specification Error A generic error code which gives a minimum level of assurance that systems can share the minimum information relating to Handling Specification faults.
10002 Negative Infrastructure Level Response Value - Processing Error The handling specification for infrastructure level response is present but cannot be processed. For example, may be unreadable or contain an incorrect value.
10003 Negative Business Level Response Value - Processing Error The handling specification for Business level response is present but cannot be processed. For example, may be unreadable or contain an incorrect value.
10004 Negative Message Definition Value – Processing Error The handling specification for Message Definition is present but cannot be processed. For example, may be unreadable or contain an incorrect value. This may also be returned when the message type is not supported (known) by the receiving system.
10005 Negative Message Definition Version Value – Processing Error The handling specification for Message Definition is present but the version is not supported by the receiving system.
10007 Negative Sender Reference Value - Processing Error The handling specification for Sender Reference is present but cannot be processed. For example, may be unreadable, contain an incorrect value or the use of Sender Reference is not supported by receiving system
10008 Negative Handling Specification Business Rule Error The Handling Specification usage does not match business rules for included Payload. For example, an acknowledgement flag defined as mandatory to contain the value "true" by the Payload specification contains the value "false".
10009 Negative Unreadable message received A message has been received that is either corrupted or malformed and cannot be read by the receiving system.
10010 Negative Recipient Type - Processing Error The handling specification for Recipient Type is present but cannot be processed. For example, may be unreadable or contain an incorrect value.
20001 Negative Unrecognised Recipient Person The person referred to as the recipient in the ITK3 MessageHeader is not recognised.
20002 Negative Unrecognised Recipient Organisation The organization referred to as the recipient in the ITK3 MessageHeader is not recognised.
20003 Negative Unrecognised Sender The organization or person referred to as the sender in the ITK3 MessageHeader is not recognised. Note: This code should not be used where the domain makes use of the “GP look-up” functionality in MESH.
20004 Negative Non-Approved file type received as an attachment The Receiving system has received an attached file whose file type is not approved for the business domain.
20005 Negative Unsupported file type received as an attachment The Receiving system has received an attached file which it does not support.
20006 Negative ITK3 Header validation failure The ITK3 Header resources or elements are not correct or understandable. For example, ITK3 Bundle or ITK3 MessageHeader.
20007 Negative Duplicate Message received Bundle with this message identifier has already been processed. A Payload with this ITK3 MessageHeader identifier has already been received and processed by this recipient.
20008 Negative Duplicate Document received Bundle with this document identifier has already been processed. A Payload with this document identifier has already been received and processed by this recipient.
20009 Negative Payload validation failure Payload content validation has failed.
20010 Negative Unrecognised Payload Recipient Organisation The Recipient Organisation identified in the Payload, is not supported by this End Point (Receiving System).
20011 Negative Unrecognised Payload Recipient Person The Recipient person identified in the Payload, is not supported by this End Point (Receiving System).
20012 Negative Unauthorised Sender The Receiving system identified in the Payload is configured to reject messages from unauthorised senders. This code should not be used where the domain makes use of the “GP look-up” functionality in MESH.
20013 Positive Success The Message has been processed successfully at the infrastructure level. A response will be returned stating the fact. However, the message may still fail after further processing and result in another response if the business acknowledgement request flag has been sent to “true”.
30001 Positive Patient known here. (e.g. Patient is registered here)
30002 Negative Patient not known here. (aka ‘patient record not present in system’)
30003 Negative Patient no longer at this clinical setting
Tags: fhir

All content is available under the Open Government Licence v3.0, except where otherwise stated