List Patients (v2)

Retrieves a list of all patients, from either the EHR or HERO.

SecurityapiKeyAuth and practiceGroupId

Request

query Parameters

field	string
search	string
dataSource	string Enum: "hero" "ehr"

Responses

200

400

Validation error

401

Unauthorised

404

Not found

500

Unknown error

get/v2/patients

Request samples

curl
Node.js
Ruby

Response samples

application/json

{"data": [{"ehr_partner_id": "string",
"emis_id": "string",
"dob": "2019-08-24T14:15:22Z",
"title": "Baron",
"first_name": "string",
"last_name": "string",
"sex": "Not known",
"nhs_number": "string",
"email": "string",
"mobile": "string",
"last_sync_at": "2019-08-24T14:15:22Z",
"line_1": "string",
"line_2": "string",
"line_3": "string",
"town": "string",
"county": "string",
"postcode": "string",
"hero_id": "string",
"hero_uid": "string"
}
],
"count": 0
}