SlimSlim/Patient

Get patient $everything

  • Sandbox: available
  • Staging: available
  • Production: unknown
GET
/v1/slim/patient/{id}/$everything

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 (an admin or super admin who holds no access policy skips 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.

Behaviour

  • Read-only.
  • The bundle is produced by Medplum and read with the caller's own 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/c3499c27-2973-0a7f-807e-fb8676a92dcb/$everything' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Authorization

bearer
headerAuthorizationBearer <JWT>

Path Parameters

id*string
Formatuuid

Response Body

Patient $everything bundle retrieved successfully.

application/json
  1. response
resourceType*"Bundle"

Always Bundle.

Value in"Bundle"
type*string

Bundle type, as Medplum sets it.

entry?array<>

The resident and every resource the caller can read that references them.

[key: string]?any
Example Request
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/patient/497f6eca-6276-4993-bfeb-53cbbbba6f08/$everything'
Example Response
{  "resourceType": "Bundle",  "type": "string",  "entry": [    {      "fullUrl": "string",      "resource": {        "resourceType": "string"      }    }  ]}

Get patient current vitals GET

Returns the latest live telemetry for a resident: one entry per device assigned to them, with the device, resident and zone. **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 `search` and `read` on `Patient`, `Device`, `Location`, `Observation` and `Organization` (an admin or super admin who holds no access policy skips this check). **Scope:** The caller's project (from the token). A resident outside that project returns `total: 0` and no entries. ## Behaviour - Read-only. - Returns one entry per device assigned to the resident, up to 100. A resident with no device returns `total: 0`. - The response is cached for up to 60 seconds, so `telemetry` can lag the latest reading by up to a minute. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/patient/c3499c27-2973-0a7f-807e-fb8676a92dcb/current-vitals' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```

Get patient GET

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` (an admin or super admin who holds no access policy skips 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. - `deviceId` is one device id, or `null` when the resident has no device. If the resident is on several devices, it is the most recently updated one. `locationId`, `floor`, `room`, `bed` and `organizationId` describe that same device's placement. - `residentState` is `active`, `discharged-recent` (discharged within the last 30 days), `discharged` or `archived`. - `admissionDate` and `dischargeDate` are returned as stored. - A `name` entry without a `use` is returned as `official`. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/patient/c3499c27-2973-0a7f-807e-fb8676a92dcb' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```