SDK surface
Import public APIs from @ovok/core. The main entry point exports the client, hooks, types, observation utilities, capability requirements, and error helpers.
| Area | Examples |
|---|---|
| Client | OvokClient, getCapabilityStatement(), getPublicApiEndpoints() |
| Authentication | login, registration, social login, MFA, password recovery, session management |
| FHIR and observations | observation builders, measurement services, latest-observation helpers, transaction writes |
| Questionnaires | populate, extract, and submit response workflows |
| Offline | OfflineMeasurementQueueOptions, OfflineMeasurementFlushResult, flushOfflineMeasurementQueue() |
| Platform | project settings and features, memberships, locales, localization |
| Patient APIs | profile, dashboard, measurements, devices, notifications, care plans, scheduling |
| Slim | patient, device, telemetry, notification, alarm, and history workflows |
| Signals | enrollment, thresholds, alert episodes, raw alerts, notes, settings |
| Application APIs | CMS, email templates, consent, documents, invitations, video calls, AI, and bots |
| Conformance | OVOK_CORE_REQUIREMENTS, OVOK_CORE_API_REQUIREMENTS |
| Errors | Ovok API errors, rate limits, sign-in-required, Signals errors |
Types are the source of truth for parameters and return values. Use IDE autocomplete or the declarations shipped in dist when a method's complete signature matters. The backend route contract and prerequisites belong to the Ovok docs.
Check compatibility
The SDK exports FHIR capability and ordinary HTTP API requirements separately. A FHIR CapabilityStatement does not describe every non-FHIR endpoint. Compare the connected server's advertised capability with the SDK workflow you plan to use; roll out the backend release before depending on new routes.
Not included
The package intentionally does not define a billing contract. Avoid assuming that a nearby console feature implies a corresponding SDK method.