---
title: "Submit Errors"
method: POST
path: "/errors"
tags: ["Registration"]
---

# Submit Errors

`POST /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](https://gpitbjss.atlassian.net/wiki/download/attachments/12665978882/NPFIT-PC-BLD-0083.08%20GP2GP%20Response%20Codes.pdf?version=1&modificationDate=1703173853480&cacheVersion=1&api=v2)
which is found on [GP2GP v6.0.0](https://gpitbjss.atlassian.net/wiki/spaces/DCSDCS/pages/12665978882/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:
```json
{
  "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"
    }
  }
}
```

## Request body

- object
  - `conversationId` string, 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.
  - `registrationEventDateTime` string, date-time, required — The ISO 8601 Date time in UTC that this event occurred.
  - `reportingSystemSupplier` string, required — The system supplier who generated the event. The ODS code assigned to you as a supplier by NHSD.
  - `reportingPracticeOdsCode` string, 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.
  - `requestingPracticeOdsCode` string, required — The ODS code of the requesting practice.
  - `sendingPracticeOdsCode` string — The ODS code of the sending practice. This is optional as there may not be a previous practice.
  - `payload` object, required — An object that contains the detailed payload of the event.
    - `error` object, required
      - `errorCode` string, required — The code associated with the error. All negative acknowledgements should have this populated with the acknowledgement response code. Other errors should have a code assigned that is understood by the reporting system supplier. This field should only contain letters, numbers and underscores and be no longer than 50 charachers in length.
      - `errorDescription` string, required — Human readable description of the error
      - `failurePoint` 'PATIENT_TRACE' | 'ENDPOINT_LOOKUP' | 'PATIENT_GENERAL_UPDATE' | 'EHR_REQUESTED' | 'EHR_RESPONSE' | 'EHR_READY_TO_INTEGRATE' | 'EHR_INTEGRATION' | 'OTHER', required — **PATIENT_TRACE** - currently PDS update **ENDPOINT_LOOKUP** - i.e. SDS **PATIENT_GENERAL_UPDATE** - currently PDS update **EHR_REQUESTED** - errors with requesting the EHR **EHR_RESPONSE** - errors with generating and sending the EHR **EHR_READY_TO_INTEGRATE** - errors in making EHR available to integrate **EHR_INTEGRATION** - errors on integration **OTHER** - errors at any other point not specified above
      - `otherFailurePoint` string — Complete if "OTHER" selected and the failure point is known. A description of the workflow failure location.

## Response `200`

OK. Expected response to a valid request

- object
  - `eventId` string

## Other responses

- `400` — Bad request
- `500` — Internal Server Error

---

[API](https://skmtc.dev/nhs/apis/gp-registrations-management-information-api.md) · [All operations](https://skmtc.dev/nhs/apis/gp-registrations-management-information-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nhs/gp-registrations-management-information-api/revisions/7cf053d3a232/schema)