POST/transactional-api/find-patient

Find Patient

Free-text search for patients by name, NHS number, date of birth, or other demographics. Returns a list of matching patients.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/find-patient' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "query": "Smith",
    "includeInactivePatients": false
  }'

Body parameters

Field	Type	Required	Description
query	string	Yes	Free-text search term (e.g. name, NHS number).
includeInactivePatients	boolean	No	When true, inactive patients are included in the results.

Responses

200 Matching patients.

[
  {
    "patientId": "4d59c916-9726-11ec-af3f-0a58a9feac02",
    "displayName": "Frodo Baggins",
    "nhsNumber": "9693646525",
    "dateOfBirth": "1971-07-09",
    "address": {
      "line1": "Flat 6",
      "line2": "16-19",
      "line3": "Commercial Row",
      "locality": "Doc Penfro",
      "administrativeArea": "Pembrokeshire",
      "postalCode": "SA72 6LA",
      "country": "England"
    },
    "genderIdentity": "male",
    "active": true
  }
]

400 Validation error: query is missing.

Response fields

Field	Type	Description
errors[].code	string
errors[].description	string

{
  "errors": [
    {
      "code": "missing-query",
      "description": "No search query is specified"
    }
  ]
}