Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

ITK3 Response Examples

Response code examples.

Error Scenario Examples

Infrastructure Level Response 10001: Fatal-Error - Handling Specification Error

Infrastructure Level Response 10002: Fatal-Error - Infrastructure Response Value Processing Error

Infrastructure Level Response 10003: Fatal-Error - Business Level Response Value Processing Error

Infrastructure Level Response 10004: Fatal-Error - Message Definition Value Processing Error

Infrastructure Level Response 10005: Fatal-Error - Message Definition Version Value – Processing Error

Infrastructure Level Response 10007: Sender Reference Value - Processing Error

Infrastructure Level Response 10008: Handling Specification Business Rule Error

Infrastructure Level Response 10009: Fatal-Error - Unreadable Message Received

When a system receives a message which is totally unreadable due to it being corrupted or malformed, there is a default behaviour defined which systems should support. This behaviour for information unobtainable from the handling keys and header elements is listed below:


Issue - Unable to ascertain if a response has been requested.

Default Behaviour - A response must always be returned to the sender.


Issue - Unable to ascertain sender person or organisation.

Default Behaviour - Return a response to MESH mailbox original message was sent from and original sending system will have to deal with response the best it can.


Issue - Unable to ascertain whether original message was for action or only for information.

Default Behaviour - Assume for action and return response.


Issue - Unable to ascertain any other information

Default Behaviour - Return response as soon as possible once error is detected.


Issue - Unable to ascertain the identifier of the original message.

Default Behaviour - return the fixed string of “UNREADABLE-IN-ORIGINAL-MESSAGE”

Note: If only certain elements are missing or unreadable then the error codes associated with that key or element should be returned instead wherever possible.

Infrastructure Level Response 20001: Fatal-Error - Unrecognised Recipient Person

Infrastructure Level Response 20002: Fatal-Error - Unrecognised Recipient Organisation

Infrastructure Level Response 20003: Fatal-Error - Unrecognised Sender

Infrastructure Level Response 20004: Fatal-Error - Non Approved File Type Received as an Attachment

Infrastructure Level Response 20005: Fatal-Error - Unsupported file type received as an attachment

Infrastructure Level Response 20006: Fatal-Error - ITK3 Header Validation Failure

Infrastructure Level Response 20007: Fatal-Error - Duplicate Message Received

Infrastructure Level Response 20008: Fatal-Error - Duplicate Document Received

Infrastructure Level Response 20009: Fatal-Error - Payload Validation Failure

Infrastructure Level Response 20010: Fatal-Error - Unrecognised Payload Recipient Organisation

Infrastructure Level Response 20011: Fatal-Error - Unrecognised Payload Recipient Person

Infrastructure Level Response 20012: Fatal-Error - Unauthorised Sender

Infrastructure Level Response 20013: OK


Business Level Response 30001: - Patient Known Here

Business Level Response 30002: Fatal-Error - Patient not Known Here

Business Level Response 30003: Fatal-Error - Patient no Longer at this Clinical Setting Error

Tags: fhir

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