Skip to content
API Docs/
API Reference
/
/
Get a Patient

Get a Patient

Request

Retrieve patient information.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/patients/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
ehr_partner_idstring or null
emis_idstring or null
deceased_atstring or null, (date-time)
ods_codestring or null
dobstring or null, (date-time)required
titlestring or null
Enum:"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
first_namestring or null
last_namestring or null
sexstring or null
Enum:"Not known""Not specified""Male""Female""Other"
nhs_numberstring or null
emailstring or null
mobilestring or null
last_sync_atstring or null, (date-time)
data_sourcestring or null
Enum:"hero""emis""pds""gha""systm_one"
restrictedboolean
Default:false
line_1string or null
line_2string or null
line_3string or null
townstring or null
countystring or null
postcodestring or null
hero_idstring or null^\d+$
hero_uidstring or null
identifiersArray of objectsrequired
ehr_registeredboolean or nullrequired
Response
{
  "ehr_partner_id": "string",
  "emis_id": "string",
  "deceased_at": "2019-08-24T14:15:22Z",
  "ods_code": "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",
  "data_source": "hero",
  "restricted": false,
  "line_1": "string",
  "line_2": "string",
  "line_3": "string",
  "town": "string",
  "county": "string",
  "postcode": "string",
  "hero_id": "string",
  "hero_uid": "string",
  "identifiers": [
    { … }
  ],
  "ehr_registered": true
}