API reference

Java client for the Ovok API.

Build an OvokConfig, pass it to Ovok, and call the namespaces it exposes, such as ovok.fhir() or ovok.slim(). Calls return Jackson JsonNode bodies or a Page of them. Failures are thrown as OvokException subclasses, one per HTTP status class.

ClassesCopy Anchor Link

• AccountsResource: Lists Ovok accounts.
• AiResource: Calls the Ovok AI routes under /ai.
• AlarmsResource: Reads and acknowledges device alarm notifications.
• AuthResource: Signs users in and out and manages their account.
• AuthSessionsResource: Lists and revokes the signed-in user's sessions.
• BotsResource: Runs Ovok bots.
• ChangeHistoryResource: Reads the change history.
• ChildProjectsResource: Manages child projects of the current project.
• CmsResource: Reads published CMS content for the configured tenant.
• ConsentResource: Reads and records the signed-in user's consents and requests consent signatures.
• ContentResource: Manages localized content entries in the project's CMS.
• DevicesResource: Manages Slim devices, their live rows and telemetry.
• DocumentsResource: Lists, uploads and links to the project's documents.
• EmailResource: Reads project email settings.
• ExportsResource: Exports patient data.
• FhirResource: Reads and writes FHIR R4 resources under the configured FHIR path.
• HealthResource: Checks API health.
• InvitesResource: Creates and accepts invites.
• LocalesResource: Reads and changes the project locales.
• LocalizationsResource: Manages localization strings.
• LocationsResource: Manages locations through the slim API.
• LoginCredentials: Email and password for AuthResource.login(LoginCredentials).
• LoginResult: Result of a sign-in.
• MeasurementsResource: Builds, saves and reads measurement Observations.
• MedicalNotificationsResource: Reads and acknowledges medical notification episodes.
• MemoryStorage: In-memory OvokStorage; the session is lost when the process exits.
• MfaChallenge: Pending MFA sign-in, answered with AuthResource.verifyMfa(MfaChallenge, String).
• NotificationNotesResource: Manages notes on notifications.
• NotificationsResource: Reads Slim notifications and groups the alarm, out-of-bed, medical and note routes.
• OrganizationsResource: Manages organizations through the slim API.
• OutOfBedResource: Reads out-of-bed notifications.
• Ovok: Entry point of the Ovok SDK; exposes one resource per API namespace.
• OvokApiException: Thrown when the Ovok API answers with a non-2xx status that has no more specific subclass.
• OvokAuthenticationException: Thrown for HTTP 401: missing or invalid credentials.
• OvokClient: Minimal FHIR reader that uses a fixed access token.
• OvokConfig: Settings for an Ovok client; build one with builder().
• OvokConfigException: Thrown when the SDK configuration or a call's inputs are invalid before any request is sent.
• OvokConflictException: Thrown for HTTP 409: the request conflicts with the current state.
• OvokConnectionException: Thrown when the SDK cannot reach the Ovok API or a paged read is interrupted.
• OvokException: Base class of every exception the SDK throws; carries the API's error details when there is a response.
• OvokNotFoundException: Thrown for HTTP 404: the resource does not exist.
• OvokPermissionException: Thrown for HTTP 403: signed in but not allowed.
• OvokRateLimitException: Thrown for HTTP 429: rate limited; see retryAfter().
• OvokServiceException: Thrown for HTTP 5xx: the Ovok API failed.
• OvokStorage: Key-value store that keeps the signed-in session between runs.
• OvokValidationException: Thrown for HTTP 400 and 422, and when the SDK rejects an invalid argument.
• Page: One page of results that can iterate through every later page.
• PatientResource: Reads and writes the signed-in patient's FHIR records.
• PatientThresholdsResource: Reads and sets one patient's vital thresholds.
• PatientsResource: Manages Slim patients.
• PoliciesResource: Manages access policies through the slim API.
• PractitionersResource: Invites practitioners.
• ProfileType: FHIR profile type a user signs in as.
• ProjectsResource: Lists projects and manages the current project's members, features and settings.
• QuestionnaireResponsesResource: Submits QuestionnaireResponses and extracts data from them.
• QuestionnairesResource: Runs FHIR Questionnaire operations.
• RegisterResult: Result of AuthResource.register(Map).
• RequestOptions: Per-request options.
• SaveObservationsOptions: Options for saving observations through MeasurementsResource.
• Session: Signed-in user session.
• SharingResource: Shares patient records through invites.
• SignalsResource: Enables Signals for patients and repairs undeliverable Signals config.
• SleepResource: Reads sleep statistics.
• SlimProjectsResource: Reads and updates Slim projects and their users.
• SlimResource: Groups the Slim care-home routes (/v1/slim) by resource.
• ThresholdsResource: Reads and sets the project vital thresholds.
• TrendsResource: Reads vital trend graphs.
• UnauthenticatedReason: Why the SDK signed the user out; passed to OvokConfig.Builder.onUnauthenticated(Consumer).
• UsersResource: Deletes users.
• VideoCallsResource: Runs LiveKit video calls under /video-call/livekit.
• WearablesResource: Manages wearable providers and connections under /v1/wearables.
• ZonesResource: Reads zones.