Get patient
| Method | Path |
|---|---|
GET | /v1/slim/patient/:id |
Authentication · Access policies
Returns one resident (patient) by id, with their names, resident state and current placement. The response is the shape PUT /v1/slim/patient/{id} accepts back.
Auth: Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant Patient:read (admins and super admins skip this check).
Scope: The resident is read with the caller's own token, so you get any patient your Medplum access lets you read. There is no extra project check on this route.
Behaviour
- Read-only.
deviceIdis one device id, ornullwhen the resident has no device. If the resident is on several devices, it is the most recently updated one.locationId,floor,room,bedandorganizationIddescribe that same device's placement.residentStateisactive,discharged-recent(discharged within the last 30 days),dischargedorarchived.admissionDateanddischargeDateare returned as stored.- A
nameentry without auseis returned asofficial.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/patient/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
-H "Authorization: Bearer ${OVOK_TOKEN}"
Successful response
200 — Patient retrieved successfully.
Errors
| Status | Meaning |
|---|---|
401 | Bearer token is missing, invalid or expired. |
403 | You are not a practitioner, admin or System Owner, you lack Patient:read, or Medplum refuses you the patient. |
404 | No patient with this id exists. |
422 | id is not a UUID. |