ovok_sdk.resources.slim

The ovok.slim namespace: Ovok's compact care-facility API for patients, devices and alerts.

LiveReadsCopy Anchor Link

LiveReads(http: HttpClient)

Shares identical reads while they are in flight.

Parameters

clear()Copy Anchor Link

clear() -> None

Forget the reads in flight, so the next read sends a new request.

get()Copy Anchor Link

get(path: str) -> Any

Read a path, joining an identical read already in flight.

Parameters

Returns

• Any: The response body.

SlimPatientsResourceCopy Anchor Link

SlimPatientsResource(http: HttpClient)

Slim patients.

Access it as ovok.slim.patients; thresholds are under ovok.slim.patients.thresholds.

list()Copy Anchor Link

list(params: QueryParams | None = None) -> Page[Any]

List patients.

Parameters

Returns

• Page[Any]: A Page of items; page in params is the first page loaded (0-based).

retrieve()Copy Anchor Link

retrieve(patient_id: str) -> Any

Read one patient.

Parameters

Returns

• Any: The patient.

create()Copy Anchor Link

create(body: JsonObject) -> Any

Create a patient.

Parameters

Returns

• Any: The created patient.

update()Copy Anchor Link

update(patient_id: str, body: JsonObject) -> Any

Replace a patient.

Parameters

Returns

• Any: The updated patient.

delete()Copy Anchor Link

delete(patient_id: str) -> None

Delete a patient.

Parameters

everything()Copy Anchor Link

everything(patient_id: str) -> Any

Read everything recorded for a patient ($everything).

Parameters

Returns

• Any: The patient's records as the API returns them.

current_vitals()Copy Anchor Link

current_vitals(patient_id: str) -> Any

Read a patient's current vital signs.

Parameters

Returns

• Any: The current vitals as the API returns them.

SlimPatientThresholdsResourceCopy Anchor Link

SlimPatientThresholdsResource(http: HttpClient)

A patient's alert thresholds.

Access it as ovok.slim.patients.thresholds.

retrieve()Copy Anchor Link

retrieve(patient_id: str) -> Any

Read a patient's thresholds.

Parameters

Returns

• Any: The thresholds.

update()Copy Anchor Link

update(patient_id: str, body: JsonObject) -> Any

Replace a patient's thresholds; the write is never retried.

Parameters

Returns

• Any: The updated thresholds.

SlimDevicesResourceCopy Anchor Link

SlimDevicesResource(http: HttpClient, session: UserSession | None = None)

Slim devices, their live state and telemetry.

Access it as ovok.slim.devices. Identical concurrent live and telemetry reads share one request; signing in or out drops reads in flight.

list()Copy Anchor Link

list(params: QueryParams | None = None) -> Page[Any]

List devices.

Parameters

Returns

• Page[Any]: A Page of items; page in params is the first page loaded (0-based).

retrieve()Copy Anchor Link

retrieve(device_id: str) -> Any

Read one device.

Parameters

Returns

• Any: The device.

create()Copy Anchor Link

create(body: JsonObject) -> Any

Create a device.

Parameters

Returns

• Any: The created device.

update()Copy Anchor Link

update(device_id: str, body: JsonObject) -> Any

Replace a device.

Parameters

Returns

• Any: The updated device.

delete()Copy Anchor Link

delete(device_id: str) -> None

Delete a device.

Parameters

assign_to_project()Copy Anchor Link

assign_to_project(body: JsonObject) -> Any

Assign devices to a project.

Parameters

Returns

• Any: The API's response.

live()Copy Anchor Link

live(params: QueryParams | None = None) -> Page[Any]

List devices with their live state.

Parameters

Returns

• Page[Any]: A Page of live device rows.

Raises

• OvokValidationError: count is out of range.

live_telemetry()Copy Anchor Link

live_telemetry(params: QueryParams | None = None) -> Any

Read live telemetry for a page of devices, keyed by device.

Parameters

Returns

• Any: The telemetry as the API returns it.

Raises

• OvokValidationError: count is out of range.

telemetry()Copy Anchor Link

telemetry(device_id: str) -> Any

Read one device's telemetry.

Parameters

Returns

• Any: The telemetry as the API returns it.

effective_observation_ids()Copy Anchor Link

effective_observation_ids(device_id: str) -> Any

Read the observation IDs behind a device's effective values.

Parameters

Returns

• Any: The observation IDs as the API returns them.

effective_observation_ids_by_device()Copy Anchor Link

effective_observation_ids_by_device() -> Any

Read the effective observation IDs of every device.

Returns

• Any: The observation IDs keyed by device.

last_observation_ids()Copy Anchor Link

last_observation_ids(device_id: str) -> Any

Read the IDs of a device's last observations.

Parameters

Returns

• Any: The observation IDs as the API returns them.

last_observation_ids_by_device()Copy Anchor Link

last_observation_ids_by_device() -> Any

Read the last observation IDs of every device.

Returns

• Any: The observation IDs keyed by device.

SlimNotificationsResourceCopy Anchor Link

SlimNotificationsResource(http: HttpClient)

Alert notifications.

Access it as ovok.slim.notifications; notes are under .notes.

list()Copy Anchor Link

list(params: QueryParams | None = None) -> Any

List notifications.

Parameters

Returns

• Any: The notifications as the API returns them.

recent()Copy Anchor Link

recent(params: QueryParams | None = None) -> Any

List recent notifications.

Parameters

Returns

• Any: The notifications as the API returns them.

SlimNotificationNotesResourceCopy Anchor Link

SlimNotificationNotesResource(http: HttpClient)

Notes on notifications.

Access it as ovok.slim.notifications.notes.

list()Copy Anchor Link

list(kind: str, target_id: str) -> Any

List the notes on a notification.

Parameters

Returns

• Any: The notes as the API returns them.

Raises

• KeyError: kind is not one of the four kinds.

create()Copy Anchor Link

create(body: JsonObject) -> Any

Create a note.

Parameters

Returns

• Any: The created note.

update()Copy Anchor Link

update(note_id: str, body: JsonObject) -> Any

Replace a note.

Parameters

Returns

• Any: The updated note.

patch()Copy Anchor Link

patch(note_id: str, body: JsonObject) -> Any

Update part of a note.

Parameters

Returns

• Any: The updated note.

delete()Copy Anchor Link

delete(note_id: str) -> None

Delete a note.

Parameters

SlimThresholdsResourceCopy Anchor Link

SlimThresholdsResource(http: HttpClient)

The project's alert thresholds.

Access it as ovok.slim.thresholds.

retrieve()Copy Anchor Link

retrieve() -> Any

Read the project's thresholds.

Returns

• Any: The thresholds.

update()Copy Anchor Link

update(body: JsonObject) -> Any

Replace the project's thresholds; the write is never retried.

Parameters

Returns

• Any: The updated thresholds.

SlimTrendsResourceCopy Anchor Link

SlimTrendsResource(http: HttpClient)

Vital-sign trends.

Access it as ovok.slim.trends.

graphs()Copy Anchor Link

graphs(params: QueryParams) -> Any

Read trend graphs.

Parameters

Returns

• Any: The graph data.

realtime()Copy Anchor Link

realtime(params: QueryParams) -> Any

Read realtime trend data.

Parameters

Returns

• Any: The realtime data.

SlimSleepResourceCopy Anchor Link

SlimSleepResource(http: HttpClient)

Sleep statistics.

Access it as ovok.slim.sleep.

statistics()Copy Anchor Link

statistics(params: QueryParams) -> Any

Read sleep statistics.

Parameters

Returns

• Any: The statistics.

SlimLocationsResourceCopy Anchor Link

SlimLocationsResource(http: HttpClient)

Locations, such as rooms and beds.

Access it as ovok.slim.locations.

list()Copy Anchor Link

list(params: QueryParams | None = None) -> Page[Any]

List locations.

Parameters

Returns

• Page[Any]: A Page of items; page in params is the first page loaded (0-based).

retrieve()Copy Anchor Link

retrieve(location_id: str) -> Any

Read one location.

Parameters

Returns

• Any: The location.

create()Copy Anchor Link

create(body: JsonObject) -> Any

Create a location.

Parameters

Returns

• Any: The created location.

update()Copy Anchor Link

update(location_id: str, body: JsonObject) -> Any

Replace a location.

Parameters

Returns

• Any: The updated location.

delete()Copy Anchor Link

delete(location_id: str) -> None

Delete a location.

Parameters

SlimZonesResourceCopy Anchor Link

SlimZonesResource(http: HttpClient)

Zones that group locations.

Access it as ovok.slim.zones.

list()Copy Anchor Link

list(params: QueryParams | None = None) -> Page[Any]

List zones.

Parameters

Returns

• Page[Any]: A Page of items; page in params is the first page loaded (0-based).

retrieve()Copy Anchor Link

retrieve(zone_id: str) -> Any

Read one zone.

Parameters

Returns

• Any: The zone.

device_counts()Copy Anchor Link

device_counts(params: QueryParams | None = None) -> Any

Count devices per zone.

Parameters

Returns

• Any: The counts.

SlimExportsResourceCopy Anchor Link

SlimExportsResource(http: HttpClient)

Exports.

Access it as ovok.slim.exports.

patient_pdf()Copy Anchor Link

patient_pdf(body: JsonObject) -> Any

Export a patient report as PDF.

Parameters

Returns

• Any: The API's response.

SlimChangeHistoryResourceCopy Anchor Link

SlimChangeHistoryResource(http: HttpClient)

The change history of Slim resources.

Access it as ovok.slim.change_history.

list()Copy Anchor Link

list(params: QueryParams | None = None) -> Page[Any]

List changes.

Parameters

Returns

• Page[Any]: A Page of changes.

SlimProjectsResourceCopy Anchor Link

SlimProjectsResource(http: HttpClient)

Projects and their users.

Access it as ovok.slim.projects; child projects are under .children.

retrieve()Copy Anchor Link

retrieve(project_id: str) -> Any

Read one project.

Parameters

Returns

• Any: The project.

update()Copy Anchor Link

update(project_id: str, body: JsonObject) -> Any

Replace a project.

Parameters

Returns

• Any: The updated project.

users()Copy Anchor Link

users(project_id: str, params: QueryParams | None = None) -> Page[Any]

List a project's users.

Parameters

Returns

• Page[Any]: A Page of users.

current_users()Copy Anchor Link

current_users(params: QueryParams | None = None) -> Page[Any]

List the current project's users.

Parameters

Returns

• Page[Any]: A Page of users.

device_counts()Copy Anchor Link

device_counts(project_id: str) -> Any

Count a project's devices.

Parameters

Returns

• Any: The counts.

patient_counts()Copy Anchor Link

patient_counts(project_id: str) -> Any

Count a project's patients.

Parameters

Returns

• Any: The counts.

SlimChildProjectsResourceCopy Anchor Link

SlimChildProjectsResource(http: HttpClient)

Child projects of the current project.

Access it as ovok.slim.projects.children.

list()Copy Anchor Link

list() -> Any

List child projects.

Returns

• Any: The child projects.

create()Copy Anchor Link

create(body: JsonObject) -> Any

Create a child project.

Parameters

Returns

• Any: The created project.

delete()Copy Anchor Link

delete(sub_project_id: str) -> Any

Delete a child project.

Parameters

Returns

• Any: The API's response.

SlimPoliciesResourceCopy Anchor Link

SlimPoliciesResource(http: HttpClient)

Access policies.

Access it as ovok.slim.policies.

list()Copy Anchor Link

list(params: QueryParams | None = None) -> Any

List access policies.

Parameters

Returns

• Any: The policies.

retrieve()Copy Anchor Link

retrieve(policy_id: str) -> Any

Read one policy.

Parameters

Returns

• Any: The policy.

create()Copy Anchor Link

create(body: JsonObject) -> Any

Create a policy.

Parameters

Returns

• Any: The created policy.

update()Copy Anchor Link

update(policy_id: str, body: JsonObject) -> Any

Replace a policy.

Parameters

Returns

• Any: The updated policy.

delete()Copy Anchor Link

delete(policy_id: str) -> None

Delete a policy.

Parameters

SlimOrganizationsResourceCopy Anchor Link

SlimOrganizationsResource(http: HttpClient)

Organizations.

Access it as ovok.slim.organizations.

retrieve()Copy Anchor Link

retrieve(organization_id: str) -> Any

Read one organization.

Parameters

Returns

• Any: The organization.

create()Copy Anchor Link

create(body: JsonObject) -> Any

Create a organization.

Parameters

Returns

• Any: The created organization.

update()Copy Anchor Link

update(organization_id: str, body: JsonObject) -> Any

Replace a organization.

Parameters

Returns

• Any: The updated organization.

delete()Copy Anchor Link

delete(organization_id: str) -> None

Delete a organization.

Parameters

SlimPractitionersResourceCopy Anchor Link

SlimPractitionersResource(http: HttpClient)

Practitioner invitations.

Access it as ovok.slim.practitioners.

invite()Copy Anchor Link

invite(body: JsonObject) -> Any

Invite a practitioner.

Parameters

Returns

• Any: The API's response.

SlimUsersResourceCopy Anchor Link

SlimUsersResource(http: HttpClient)

Project users.

Access it as ovok.slim.users.

delete()Copy Anchor Link

delete(profile_type: str, profile_id: str) -> Any

Delete a user by profile.

Parameters

Returns

• Any: The API's response.

SlimResourceCopy Anchor Link

SlimResource(http: HttpClient, session: UserSession | None = None)

Ovok's compact care-facility API: patients, devices, alerts, thresholds and projects.

Created by Ovok; access it as ovok.slim.

Examples

>>> page = ovok.slim.patients.list({"count": 20})
>>> for patient in page.auto_paging_iter():
...     print(patient["id"])

health()Copy Anchor Link

health() -> Any

Read the Slim API health response.

Returns

• Any: The health body.