Registration

Submit EHR Requests

This event logs when the EHR request has been sent to the sending practice.

Submitted by: Requesting practice

When to send: When the EHR request has been sent to the sending practice.

Notes: If a technical error or negative acknowledgment occurs, an Error event must be submitted, including the response code if applicable.

Request Body example:

{
  "conversationId": "4345-986959-4930-684038",
  "registrationEventDateTime": "2020-02-08T08:30:25Z",
  "reportingSystemSupplier": "SUPPLIER_ODS_CODE",
  "reportingPracticeOdsCode": "ABC1234",
  "requestingPracticeOdsCode": "ABC1234",
  "sendingPracticeOdsCode": "XYZ4567"
}

post/ehr-requests

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 required

The ODS code of the sending practice.

Example request

{
  "conversationId": "A1234BC5-6789-123D-EFGH-I45678910JK1",
  "registrationEventDateTime": "2020-02-08T08:30:27Z",
  "reportingSystemSupplier": "supplierOdsCode",
  "reportingPracticeOdsCode": "A12345",
  "requestingPracticeOdsCode": "A12345",
  "sendingPracticeOdsCode": "X12345"
}

Response

— unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.