Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-149039.3 KB
Registration

Submit Errors

This event gathers information about all errors and events that trigger the sending of a negative acknowledgement that occur during a registration. The error codes referenced should match the values described in NPFIT-PC-BLD-0083.08 GP2GP Response Codes.pdf which is found on GP2GP v6.0.0.

This is used to understand errors and prioritise their resolution to support the successful transfer of patient EHRs.

Submitted by: Requesting practice or Sending practice, whichever encounters the issue

When to send: When an issue occurs that prevents the successful processing of the patient EHR (or a component of the EHR) then this endpoint should be called.

Notes: All negative acknowledgement defined in the specification must be reported as errors. However, this endpoint is not limited to negative acknowledgements.

Anytime a technical error occurs that prevents the transfers from starting or completing, this must be reported using this endpoint.

Error events MUST NOT be submitted for failures or errors relating to Degrades.

Request Body example:

{
  "conversationId": "4345-986959-4930-684038",
  "registrationEventDateTime": "2020-02-08T08:30:26Z",
  "reportingSystemSupplier": "SUPPLIER_ODS_CODE",
  "reportingPracticeOdsCode": "ABC1234",
  "requestingPracticeOdsCode": "ABC1234",
  "sendingPracticeOdsCode": "XYZ4567",
  "payload": {
    "error": {
      "errorCode": "99",
      "errorDescription": "unexpected error",
      "failurePoint": "EHR_RESPONSE"
    }
  }
}
post/errors

Request body

conversationIdstring required

A uniqueID that is used throughout the registration including during the GP2GP or GP Connect transfer. This should be generated at the point of registration.

registrationEventDateTimestring date-time required

The ISO 8601 Date time in UTC that this event occurred.

reportingSystemSupplierstring required

The system supplier who generated the event. The ODS code assigned to you as a supplier by NHSD.

reportingPracticeOdsCodestring required

The ODS code of the practice generating this event. This could be the sending or requesting practice depending on who is submiting this event.

requestingPracticeOdsCodestring required

The ODS code of the requesting practice.

sendingPracticeOdsCodestring

The ODS code of the sending practice. This is optional as there may not be a previous practice.

Example request

{
  "conversationId": "A1234BC5-6789-123D-EFGH-I45678910JK1",
  "registrationEventDateTime": "2020-02-08T08:30:27Z",
  "reportingSystemSupplier": "supplierOdsCode",
  "reportingPracticeOdsCode": "A12345",
  "requestingPracticeOdsCode": "A12345",
  "sendingPracticeOdsCode": "X54321",
  "payload": {
    "error": {
      "errorCode": "FD34",
      "errorDescription": "unexpected error"
    }
  }
}

Response

OK. Expected response to a valid request

eventIdstring

Example response

{
  "eventId": "1234-1234-1234-1234"
}