Ovok

OvokCopy Anchor Link

class Ovok

The Ovok API client: every namespace, such as auth, fhir or slim, hangs off it.

One client per tenant; no clientSecret, since anything shipped in an app can be extracted.

ConstructorsCopy Anchor Link

Ovok.newCopy Anchor Link

Ovok({
  required String baseUrl,
  required String tenantCode,
  required OvokSecureStore secureStore,
  String fhirPath = 'fhir',
  String? clientId,
  Client? httpClient,
  Duration timeout = const Duration(seconds: 30),
  int maxNetworkRetries = 2,
  UnauthenticatedListener? onUnauthenticated,
})

Creates a client for tenantCode on the Ovok API at baseUrl.

secureStore keeps the signed-in session. fhirPath is the FHIR API's path under baseUrl. clientId is the ClientApplication used for social sign-in, password resets and token refresh. httpClient replaces the default http.Client. timeout limits each request, and maxNetworkRetries is how many times a repeatable request is retried. onUnauthenticated is called when a refused refresh token signs the user out.

A bad option throws OvokConfigException here, not on the first request.

PropertiesCopy Anchor Link

Ovok.authCopy Anchor Link

final AuthResource auth

Sign-in, registration, passwords and the account.

Ovok.fhirCopy Anchor Link

final FhirResource fhir

Generic FHIR R4 reads, searches and writes under fhirPath.

Ovok.realtimeCopy Anchor Link

final RealtimeResource realtime

Live notifications for FHIR resources matching a subscription.

Ovok.patientCopy Anchor Link

final PatientResource patient

FHIR reads for patient apps, plus a one-call dashboard.

Ovok.measurementsCopy Anchor Link

final MeasurementsResource measurements

Builds and saves measurements as FHIR Observations, with an offline queue.

Ovok.questionnairesCopy Anchor Link

final QuestionnairesResource questionnaires

FHIR questionnaires.

Ovok.questionnaireResponsesCopy Anchor Link

final QuestionnaireResponsesResource questionnaireResponses

Answers to FHIR questionnaires.

Ovok.healthCopy Anchor Link

final HealthResource health

The API's health check; sent without a token.

Ovok.consentCopy Anchor Link

final ConsentResource consent

The signed-in user's consents.

Ovok.slimCopy Anchor Link

final SlimResource slim

The Slim care API for care-home operations.

Ovok.signalsCopy Anchor Link

final SignalsResource signals

Signals monitoring for patients.

Ovok.projectsCopy Anchor Link

final ProjectsResource projects

Projects, their members, settings and features.

Ovok.accountsCopy Anchor Link

final AccountsResource accounts

Accounts the signed-in user belongs to.

Ovok.localesCopy Anchor Link

final LocalesResource locales

Languages the project offers.

Ovok.localizationsCopy Anchor Link

final LocalizationsResource localizations

Translated strings, by language and key.

Ovok.emailCopy Anchor Link

final EmailResource email

The project's email setup.

Ovok.invitesCopy Anchor Link

final InvitesResource invites

Invites between patients, practitioners and carers.

Ovok.sharingCopy Anchor Link

final SharingResource sharing

A patient's record sharing.

Ovok.cmsCopy Anchor Link

final CmsResource cms

Published CMS documents, legal pages and translations.

Ovok.contentCopy Anchor Link

final ContentResource content

Project content items, by type, language and key.

Ovok.documentsCopy Anchor Link

final DocumentsResource documents

Uploaded documents and their download URLs.

Ovok.videoCallsCopy Anchor Link

final VideoCallsResource videoCalls

LiveKit video calls and their appointments.

Ovok.aiCopy Anchor Link

final AiResource ai

AI translation, FHIR search and chat.

Ovok.wearablesCopy Anchor Link

final WearablesResource wearables

Wearable providers and the patient's connections to them.

Ovok.botsCopy Anchor Link

final BotsResource bots

Project bots.

Ovok.storageCopy Anchor Link

final OvokSecureStore storage

The secure store shared by sessions, offline measurements, and device pairing.