The following section describes error scenarios and associated error codes for this messaging use case.
ITK3 errors
| GPCM-SD-65 | Where the received message does not conform to the requirements stated for ITK3 header, or for the payload, the message MUST be considered invalid |
| GPCM-SD-66 | Where a received message is invalid, an ITK3 Response MUST be generated, with the corresponding Negative ITK3 Response Code which indicates the nature of the error, and the message MUST NOT be accepted for downstream processing |
Details are given below of the ITK3 Negative Response which is used per error scenario:
ITK3 Header errors
| GPCM-SD-67 | Mandated element not present (BusAck, InfAck, RecipientType, Priority, SenderReference, MessageDefinition, Timestamp, Event) - reponse code 10008 MUST be used |
| GPCM-SD-68 | InfAck element not set to true - response code 10002 MUST be used |
| GPCM-SD-69 | BusAck element not set to true - response code 10003 MUST be used |
| GPCM-SD-70 | RecipientType element not set to FA - response code 10010 MUST be used |
| GPCM-SD-71 | Priority element not set to routine - response code 10006 MUST be used |
| GPCM-SD-72 | Event element not set to ITK007C - response code 10008 MUST be used |
ITK3 Payload business rules errors
| GPCM-SD-73 | Payload content business rule violated - response code 10008 MUST be used |
Diagnostic information
| GPCM-SD-74 | Error context and description MUST be provided in the OperationOutcome.diagnostic element to enable the sender to correctly identify the error which has been found in their sent message. |
Errors from MESH Endpoint Lookup
The following table describes error codes returned from the MESH server as a result of issues encountered using the facility to route a message automatically to the registered practice.
| GPCM-SD-75 | The following errors, when encountered, MUST be handled gracefully by the message sending system |
| Status Code | MESH Error Code | Description |
|---|---|---|
| EPL-150 | ERROR_TOO_MANY_MAILBOX_MATCHES | Multiple mailboxes matches |
| EPL-151 | ERROR_NO_MAILBOX_MATCHES | No mailbox matched |
| EPL-152 | ERROR_INVALID_NHSNUMBER | Invalid NHS Number |
| EPL-153 | ERROR_NHSNUMBER_NOT_FOUND | NHS Number not found |
| EPL-154 | ERROR_NO_DEMOGRAPHICS_MATCH | NHS Number supplied does not match the demographics |
MESH will generate these errors in the form of error reports which will be placed in the sender’s mailbox to await collection and processing by the sending organisation.
MESH API errors
Please note that, when using the MESH API to send a message, errors encountered when using the automated registered practice routing will not be returned in the API response header or payload, but via a MESH error report .CTL file placed in the sending organisation MESH mailbox.
For example, where an invalid NHS Number has been supplied in the Mex_To HTTP header, an error report .CTL file will be returned with a <StatusRecord> section which provides error details as follows:
<StatusRecord>
<DateTime>20170926135509</DateTime>
<Event>SEND</Event>
<Status>ERROR</Status>
<StatusCode>EPL-152</StatusCode>
<Description>Invalid NHS Number</Description>
</StatusRecord>
