Get device

Method	Path
GET	/v1/slim/device/:id

Authentication · Access policies

Returns one device with its zone, location and resident assignments and its current connection status. Use it to show or edit a single device.

Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs Device:read. Scope: the device is read with your token, so Medplum's access policy limits which devices you can read.

Behaviour

• organizationId is the zone of the device's location. When the device has no location, it falls back to the device's own owner organization.
• organizationName, locationName and patientName are display names. Each is null when the resource has no name that can be shown.
• status is active only when the device was last seen recently enough. A device whose last-seen time is stale reads inactive, even if it was never marked offline. A device without an identifier reports its stored FHIR status.
• statusReason explains an inactive status when the platform recorded why.
• floor, room and bed come from the address of the device's location.
• Read-only. Nothing is written.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/device/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response

200 — The device.

Errors

Status	Meaning
401	Bearer token is missing, invalid or expired.
403	You are not a practitioner, admin or System Owner, or you lack Device:read.
404	No device with this id exists, or you cannot read it.
422	id is not a UUID.