Namespaces

ovok.health

Check that the Ovok API and its dependencies are healthy.

A health probe. It needs no sign-in and grants no access to project data.

Check the API

const health = await ovok.health.check();

if (!health.ok) {
  throw new Error('Ovok API is not healthy');
}

The route always answers 200. Read ok, not the HTTP status.
dependencies holds an ok flag per dependency, by name.
version, buildEnv and commitHash are filled when the server reports them, and can be null.
Calls GET healthcheck.

Last updated on

ovok.fhir

Read, search, write and batch FHIR resources through the Ovok API.

ovok.invites

Send and accept record-share and care invitations.