OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
SlimSlim/Organization

Get organization

  • Sandbox: available
  • Staging: available
  • Production: unknown
GET
/v1/slim/organization/{id}

Returns one organization (a zone in the Slim dashboard) by id. Use it to show or edit a 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 Organization:read (an admin or super admin who holds no access policy skips this check). Scope: The organization is read with the caller's own token, so you get any organization your Medplum access lets you read. There is no extra project check on this route.

Behaviour

  • Read-only.
  • description is the organization's narrative text with the XHTML <div> wrapper removed. It is absent when the organization has no narrative.
  • parentOrganizationId is the id from Organization.partOf. It is absent for a top-level zone.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/organization/c3499c27-2973-0a7f-807e-fb8676a92dcb' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'
{  "id": "c3499c27-2973-0a7f-807e-fb8676a92dcb",  "name": "Ward A",  "parentOrganizationId": "87ea5dfc-8b8e-384d-8489-79496e706390",  "description": "Ground floor"}

Authorization

bearer
headerAuthorizationBearer <JWT>

Path Parameters

id*string
Formatuuid

Response Body

Organization retrieved successfully.

application/json
  1. response
id*string

Organization (zone) id.

name*string

Zone name. Empty string when the organization has no name.

parentOrganizationId?string

Id of the parent zone (Organization.partOf). Omitted for a top-level zone.

description?string

Narrative text without its XHTML wrapper. Omitted when the organization has none.

Example Request
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/organization/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "id": "string",  "name": "string",  "parentOrganizationId": "string",  "description": "string"}

Acknowledge notification PATCH

Acknowledges one notification stored as a CommunicationRequest (out-of-bed, device alarm, attention press) by setting its status to `completed`. For a medical notification, use `POST /v1/slim/notifications/medical/{episodeId}/ack` instead. **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). No `CommunicationRequest:update` grant is needed. **Scope:** The CommunicationRequest is read with your own credentials and must belong to your project (from the token). Sub-projects are not included. ## Behaviour - After those checks pass, Ovok writes the status change with its own credentials. - Acknowledging an already completed notification succeeds and changes nothing. - If the notification is updated at the same moment (for example by a new reading on the same episode), Ovok re-reads it and retries, keeping the newer content, up to three times. - The notification leaves the active lists and bells. The device's alert state in the live views is cleared. - Acknowledging a running out-of-bed episode stops that episode from raising the alert again. A new bed exit raises a new alert. - Answers 200 with the updated row, in the same shape as the list rows. - A 409 means the notification kept changing and all three attempts lost the race. Re-read it and call again. ## Example ```bash curl -X PATCH 'https://api.sandbox.ovok.com/v1/slim/notifications/c3499c27-2973-0a7f-807e-fb8676a92dcb/ack' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```

Delete organization DELETE

Deletes an organization (zone) and moves its residents, rooms and devices out of it. **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 `Organization:delete` and `Device:update` (an admin or super admin who holds no access policy skips this check). **Scope:** The organization must belong to the caller's project (from the token). ## Behaviour - The Organization resource is deleted. - Every patient, location and device that references the zone is re-pointed: - If the zone has a parent zone in your project, they move to the parent zone. - Otherwise their zone reference is removed. - Device use history is updated for any device whose assignment changes. - The writes run in one bundle. Because a large zone can exceed the size limit of an atomic write, this route does not take the atomic write lock. A very large zone is written as a checked batch, so a partial failure is reported as an error rather than rolled back. - A zone-deleted entry is added to the change history. A failure to write that entry does not fail the request. - The response has no body. ## Example ```bash curl -X DELETE 'https://api.sandbox.ovok.com/v1/slim/organization/c3499c27-2973-0a7f-807e-fb8676a92dcb' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```