Register a Patient using PDS

Sends minimal patient information to Hero to allow us to trace a patient against the Spine and return their Hero patient_id.If not existing in Hero, the patient record will also be created for that practice group as part of this request.

SecurityapiKeyAuth and practiceGroupId
Request
Request Body schema: application/json
required
One of:
nhs_number
required
string

A valid NHS number

dob
required
string or null <date-time>

ISO 8601 date format

ehr_partner
string non-empty
ehr_partner_id
string non-empty
Responses
200

Ok

400

Validation error

401

Unauthorised

404

No patient found

500

Unknown error

post/v1/patients/register_pds
Request samples
application/json
{
  • "dob": "1989-04-11",
  • "postcode": "string",
  • "forename": "string",
  • "surname": "string",
  • "ehr_partner": "string",
  • "ehr_partner_id": "string"
}
Response samples
application/json
{
  • "patient_id": "string"
}