ovok_sdk.resources.measurements

Measurement building, saving with an offline retry queue, and latest-value reads.

offline_measurement_storage_key()Copy Anchor Link

offline_measurement_storage_key(tenant_code: str, base_url: str) -> str

Return the storage key of the offline measurement queue for one tenant and API.

Parameters

Returns

• str: The storage key.

MeasurementsResourceCopy Anchor Link

MeasurementsResource(
    http: HttpClient,
    fhir: FhirResource,
    session: UserSession | None,
    settings: OvokSettings,
)

Builds, saves and reads measurements as FHIR Observations.

Created by Ovok; access it as ovok.measurements. Signed-in saves go through an offline queue in the client's storage, so a reading that fails to send is retried later.

Examples

result = ovok.measurements.save({
    "measurement": {
        "measurement_type_key": "blood-pressure",
        "systolic": 120,
        "diastolic": 80,
    },
})

build()Copy Anchor Link

build(params: Resource) -> list[Resource]

Build the Observations for a reading without saving them.

Parameters

Returns

• list[Resource]: The Observations, main one first.

Raises

• OvokValidationError: No patient is named and no user is signed in, or the reading is invalid.

save()Copy Anchor Link

save(params: Resource, options: Resource | None = None) -> Resource

Build and save a reading.

Parameters

Returns

• Resource: As for save_observations.

save_observations()Copy Anchor Link

save_observations(
    observations: list[Resource],
    options: Resource | None = None,
) -> Resource

Save Observations in a transaction, idempotently.

Later Observations are linked to the first with hasMember. When a user or machine client owns the save, it goes through the offline queue: a retryable failure keeps it queued for offline_queue.flush().

Parameters

Returns

• Resource: {"status": "saved", "response": bundle} or {"status": "queued", "queue_id": id}.

Raises

• OvokError: The server refused the save with a non-retryable error.

latest()Copy Anchor Link

latest(params: Resource) -> Bundle

Read the latest Observation per code with FHIR $lastn.

Parameters

Returns

• Bundle: A searchset Bundle.

Raises

• OvokValidationError: Neither a signed-in user nor patient_id is available.

last_for_patient()Copy Anchor Link

last_for_patient(patient_id: str, query: QueryParams) -> Bundle

Read a patient's last Observations through Ovok's patient route.

Parameters

Returns

• Bundle: The route's Bundle.

codes_for()Copy Anchor Link

codes_for(
    types: list[MeasurementTypeKey | str] | tuple[MeasurementTypeKey | str, ...],
) -> str

Return the LOINC codes for measurement types, for a code search.

Parameters

Returns

• str: Comma-separated, de-duplicated codes.

OfflineMeasurementQueueApiCopy Anchor Link

OfflineMeasurementQueueApi(queue: OfflineMeasurementQueue)

The offline measurement queue; access it as ovok.measurements.offline_queue.

Parameters

flush()Copy Anchor Link

flush(*, include_exhausted: bool = False, reset_exhausted: bool = False) -> Resource

Retry the current owner's queued saves that are due.

Parameters

Returns

• Resource: Counts (attempted, saved, queued, exhausted) and per-save
• Resource: responses and failures.

OfflineMeasurementQueueCopy Anchor Link

OfflineMeasurementQueue(
    storage: OvokStorage,
    storage_key: str,
    get_owner_key: Any,
    send: Any,
)

Persists pending measurement saves in storage and retries them with backoff.

Parameters

enqueue_and_flush()Copy Anchor Link

enqueue_and_flush(entries: list[BundleEntry], owner_key: str) -> Resource

Queue a save once, then flush the queue.

Parameters

Returns

• Resource: The save's queue id and the flush result.

Raises

• OvokError: This flush hit a non-retryable error; that save is dropped.

flush()Copy Anchor Link

flush(*, include_exhausted: bool = False, reset_exhausted: bool = False) -> Resource

Retry the current owner's queued saves that are due.

Parameters

Returns

• Resource: The flush counts, responses and failures.

BundleErrorCopy Anchor Link

BundleError(bundle: Bundle)

Bases: Exception

A Bundle response had an entry with a 4xx or 5xx status.

Parameters