Get patient $everything
Get patient $everything using Ovok’s Slim API.
| Method | Path |
|---|---|
GET | /v1/slim/patient/:id/$everything |
Authentication · Access policies
Returns a FHIR Bundle with the resident and every resource that references them, using the FHIR Patient/$everything operation. Use it to export or inspect a resident's full record.
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 must belong to the caller's project (from the token) or one of its sub-projects. A resident in the parent project is refused.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Patient id. |
Behaviour
- Read-only.
- The FHIR backend produces the bundle using the caller's token, so it contains only resources that token can read.
- The response is a raw FHIR
Bundle, not a Slim DTO.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/patient/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21/$everything' \
-H "Authorization: Bearer ${OVOK_TOKEN}"Successful response
200 — Patient $everything bundle retrieved successfully.
The body is a FHIR Bundle of type searchset, returned as the FHIR server produces it. The bundle holds the Patient and the resources that reference the resident, such as Observation, Device and EpisodeOfCare. Entries can be any FHIR resource type the token can read. Trimmed example:
{
"resourceType": "Bundle",
"type": "searchset",
"entry": [
{ "resource": { "resourceType": "Patient", "id": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21" } },
{ "resource": { "resourceType": "Device", "id": "8c5e7a21-4b9d-4f36-a1c8-0d2e6b9f3a54", "patient": { "reference": "Patient/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21" } } }
]
}| Field | Type | Description |
|---|---|---|
resourceType | "Bundle" | Always Bundle. |
type | string | Bundle type, as the FHIR server sets it. |
entry | object[] | The resident and every resource the caller can read that references them. Left out when the bundle is empty. |
entry[].fullUrl | string | FHIR URL of the entry, when the FHIR server sets one. |
entry[].resource | object | A FHIR resource. Its resourceType tells you which one. |
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, your session has no project, the request is not authorized to read the Patient, or the patient is outside your project and its sub-projects. |
404 | No patient with this id exists. |
422 | id is not a UUID. |
Last updated on