228:T101a,Where a wearable provider tells ovok that one of its users has new data. Register it in the provider's developer portal where the provider asks for one; you never call it yourself. **Auth:** none. The provider's signature over the body, or the secret token at the end of the URL, is the proof. **Scope:** the project in the path. ## Behaviour - The URL is the provider's `webhookUrl` from `GET /v1/wearables/providers`: `/v1/wearables/webhooks//`, followed by `/` for a provider that does not sign its notifications. - The body is the provider's own, as JSON or as form fields, at most 64 KB. ovok reads only the provider's user ids from it. - A call without the provider's signature header, or without a URL token of the right shape, is refused before anything is looked up. - ovok writes no data here. For each patient connected to a named account, it queues one sync, which runs about 30 seconds later. Notifications about the same connection within one 30-second window join one sync; one arriving while that sync runs queues the next window's, so no notification is lost. - A sync that finds another sync of the same connection running is queued once more, 30 seconds later. - A notification about an account nobody in the project has connected is accepted too, with `outcome` `no_connection`: providers stop calling URLs that keep failing. ## Answers | Status | When | |---|---| | `202` | The notification is accepted; `outcome` is `queued`, or `no_connection` when no patient here is connected to the named accounts (nothing is queued). | | `200` | A setup call, such as Polar's `PING` when the webhook is created; `outcome` is `handshake`, nothing is queued. | | `400 MALFORMED_NOTIFICATION` | The body is neither a JSON object nor form fields, or does not parse. | | `401 INVALID_SIGNATURE` | The signature or the URL token is missing or does not match. `WWW-Authenticate` is sent. | | `404 PROJECT_NOT_FOUND` | There is no such project. | | `404 PROVIDER_NOT_AVAILABLE` | The project has not set up the provider, or has switched it off. | | `404 WEBHOOK_NOT_SUPPORTED` | ovok takes no notifications from this provider. | | `413` | The body is larger than 64 KB. | | `422` | The project id is not a UUID, or the provider is not one ovok supports. | | `429` | More than 300 calls a minute from one address. Retry after `Retry-After`. | | `503 SYNC_QUEUE_UNAVAILABLE` | The sync could not be queued. Retry after `Retry-After`. | ## Per provider - **Withings:** does not sign its notifications, so its URL ends with a token derived from a random secret ovok makes when the project saves its Withings credentials, keeps encrypted with them and never returns. ovok subscribes each patient at connect time with this URL, for measurements such as heart rate and SpO2 (`appli` 4), activity (16) and sleep (44); there is nothing to paste. Disconnecting revokes those three only. Changing the client secret keeps the URL; changing the client ID makes a new one. Until the secret exists, Withings has no `webhookUrl` and every call answers `401`. The body is form fields `userid`, `appli`, `startdate` and `enddate`; ovok reads `userid`. - **Polar:** ovok creates the webhook when the project saves its Polar credentials switched on, and deletes it when the project removes them; `webhookUrl` is for information only. Polar signs each notification with `Polar-Webhook-Signature`, an HMAC-SHA256 of the body under the webhook's signing key, which ovok keeps encrypted with the credentials. Notifications for `SLEEP` and `ACTIVITY_SUMMARY` queue a sync. - **Suunto:** in the Suunto developer portal, open your app's settings, paste `webhookUrl` as its notification URL and set a notification secret. Give ovok the same secret as `webhookSecret` with `POST` or `PATCH /v1/wearables/providers`. Suunto signs each notification with `X-HMAC-SHA256-Signature`, the HMAC-SHA256 of the body under that secret, and names the account in `username`. Until the secret is stored, every Suunto notification answers `401`. - **Ultrahuman:** sends no notifications; its data is synced daily and on demand. 22b:T520,Returns the thresholds in effect for one resident: their own limits where they have them, and the home's limits everywhere else. > **Deprecated.** Use `GET /v2/slim/threshold/patient/{patientId}`. This v1 route stays available, unchanged, until every client has moved. **Auth:** Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant `Goal:read` (an admin or super admin who holds no access policy skips this check). **Scope:** The caller's project (from the token). ## Behaviour - Read-only; nothing is created. - Each metric carries `mode`: `patient` (the resident's own limits) or `organization` (the home's limits, copied in). A few legacy records still read `patient-auto`; saves can no longer set it. - Medical limits are read from Signals, which evaluates them, where available. When Signals cannot answer, Ovok's stored copy is returned instead. - This route does not check that the resident exists; the v2 route does. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/threshold/patient/c3499c27-2973-0a7f-807e-fb8676a92dcb' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ``` 22d:T879,Saves one resident's own thresholds. > **Deprecated.** Use `PUT /v2/slim/threshold/patient/{patientId}`. This v1 route stays available, unchanged, until every client has moved. **Auth:** Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant `Goal:update` (an admin or super admin who holds no access policy skips this check). **Scope:** The resident must be in the caller's project (from the token) or one of its sub-projects. ## Behaviour - Each metric's `mode` decides what is stored: - `patient`: your `absolute` / `relative` limits. - `organization`: the home's limits. Sending `enabled: false` for a metric the home has enabled switches it to `patient` mode, disabled. - `patient-auto` is no longer accepted: a body that uses it is refused with 422. - `patientId` in the body is required but ignored; the path decides the resident. - `average` and `averageRange` are set by the server; values you send are ignored. - Enabling a relative heart-rate or respiratory-rate band for a resident with no baseline average answers 424, because the band would have nothing to be relative to. - Every limit is evaluated by Signals, so every save writes the resident's settings to Signals before it answers, all or nothing: Signals holds the saved limits once it answers, or it answers 502 with `saved: false` and nothing is changed (a 500 says putting the previous limits back failed too). Send the save again. - Change-history entries are written for each changed metric. - The response is the saved threshold. ## Example ```bash curl -X PUT 'https://api.sandbox.ovok.com/v1/slim/threshold/patient/c3499c27-2973-0a7f-807e-fb8676a92dcb' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "patientId": "c3499c27-2973-0a7f-807e-fb8676a92dcb", "status": "active", "settings": { "heartRate": { "mode": "patient", "enabled": true, "absolute": { "enabled": true, "min": 45, "max": 110 } } } }' ``` 22f:T632,Lists the bands the resident's own Signals settings hold for vitals other than the ones Ovok's thresholds cover. Signals is the certified service that evaluates readings. Ovok reads the stored limits from it and does not evaluate readings. **Auth:** Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant `Goal:read` (an admin or super admin who holds no access policy skips this check). **Scope:** The resident must be in the caller's project (from the token) or one of its sub-projects. A resident outside that scope answers 404, the same as an unknown id. ## Behaviour - Read-only. - Codes that the threshold routes own (`GET /v2/slim/threshold/patient/{patientId}`, for example SpO₂ and pulse rate) are left out of the list. - Each entry has `code`, `min` and `max` (each `null` for no bound on that side). `version` and `updatedAt` are always `null`: Signals keeps the band in the resident's settings, unversioned. - A resident with no Signals record, or with no such thresholds, gets `{ "vitals": [] }`. - A resident whose Signals record was left half-created by an interrupted create is completed by this read. - If Signals cannot be reached the route answers 502, never an empty list. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/threshold/patient/c3499c27-2973-0a7f-807e-fb8676a92dcb/vitals' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ``` 231:T444,Removes one resident's threshold for a single vital code in Signals, so that code no longer alerts for the resident. **Auth:** Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant `Goal:update` (an admin or super admin who holds no access policy skips this check). **Scope:** The resident must be in the caller's project (from the token) or one of its sub-projects; otherwise 404. ## Behaviour - Answers 204 with no body once Signals confirms the removal. A 502 means Signals did not confirm; the call is safe to repeat. - Codes the threshold routes own (for example SpO₂ and pulse rate) are refused with 400. - `code` must be 1 to 64 characters from letters, digits, `.`, `_` and `-`. ## Example ```bash curl -X DELETE 'https://api.sandbox.ovok.com/v1/slim/threshold/patient/c3499c27-2973-0a7f-807e-fb8676a92dcb/vitals/59408-5' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ``` 233:T669,Sets one resident's threshold for a single vital code, replacing any threshold already held for that code. The threshold is written to Signals, which evaluates it. Ovok stores and forwards the limits and never evaluates readings. **Auth:** Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant `Goal:update` (an admin or super admin who holds no access policy skips this check). **Scope:** The resident must be in the caller's project (from the token) or one of its sub-projects; otherwise 404. The threshold is filed under the resident's own project. ## Behaviour - The body needs `min`, `max`, or both; a missing bound is `null`. When both are set, `min` must be less than `max`. To remove a threshold, use the DELETE route. - `code` must be 1 to 64 characters from letters, digits, `.`, `_` and `-`. - Codes the threshold routes own (for example SpO₂ and pulse rate) are refused with 400. Set those on `PUT /v2/slim/threshold/patient/{patientId}`. - The write waits for Signals to confirm. A 2xx means Signals holds the threshold; a 502 means it does not, so nothing changed and the call is safe to repeat. - The response is the saved `code`, `min` and `max`. ## Example ```bash curl -X PUT 'https://api.sandbox.ovok.com/v1/slim/threshold/patient/c3499c27-2973-0a7f-807e-fb8676a92dcb/vitals/59408-5' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "min": 90, "max": null }' ``` 235:Tb91,Returns the home's threshold configuration in the v2 shape: the alert limits every resident follows unless they have limits of their own. **Auth:** Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant `PlanDefinition:read` (an admin or super admin who holds no access policy skips this check). **Scope:** The caller's project (from the token). ## Behaviour - Heart-rate and respiratory-rate limits (and the optional vitals below) are evaluated by Signals. Ovok stores them and forwards them to Signals. - `settings.heartRate` and `settings.respiratoryRate` carry `mode: 'organization'` with absolute `min` and `max`. A home stored on a baseline band before baseline bands became per-resident still reads back as `mode: 'baseline'` with `deviationPercent`. A PUT no longer accepts that, so such a home must send an absolute band. - `settings.outOfBed.maxDurationSeconds` is a non-negative multiple of 60. `deviationPercent` is the home's relative out-of-bed band, or `null`. `baselineAverage` and `effectiveMaxDurationSeconds` are per resident, so they are `null` here; see `GET /v2/slim/threshold/patient/{patientId}`. - `settings.bedTimePeriod` is a top-level field, separate from `outOfBed`. `timezone` is resolved by the server: the home's time zone (Europe/Berlin unless the home set one), in which `start` and `end` are wall-clock times. A window nobody stored reads as 19:00 to 09:00, and that is the window the out-of-bed check applies. A home created through `POST /v1/slim/project/child` stores its own start, picked once from 18:00 to 20:00, so it reads the same on every call. - `ranges` is the range each vital's limits may take in this home. It is always present: what the home set, else the default (heart rate 40–120, respiratory rate 4–60). - `settings.oxygenSaturation`, `pulseRate`, `perfusionIndex` and `bodyTemperature` are `null` until the home watches the vital, else `{ mode: 'organization', enabled, min, max }`, where `min` or `max` is `null` for a one-sided limit. - Not in v2: `sleepDuration`, `numberOfTimesGettingOutOfBed`, standalone `meanHeartRate` / `meanRespiratoryRate`, `status`, `date`, the `patient-auto` mode, and the deprecated `durationSeconds`. - A home with no thresholds yet gets the default template, with `id: null`: heart rate on at 40–110 and respiratory rate on at 8–25 (the limits a new home is seeded with), and out of bed off. Heart or respiratory rate is off only once someone saves it off. If the stored thresholds cannot be read, the route answers 502, never the default template. - The v1 route `GET /v1/slim/threshold` is deprecated in favour of this one. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v2/slim/threshold' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ``` 237:T1514,Saves the home's threshold configuration in the v2 shape. `mode` is required on every settings field; `patient` is not a valid mode here. **Auth:** Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant `PlanDefinition:update` (an admin or super admin who holds no access policy skips this check). **Scope:** The caller's project (from the token). ## Behaviour - `settings.heartRate` and `settings.respiratoryRate`: `mode: 'organization'` with `enabled`, `min` and `max`. The home's band is absolute; `mode: 'baseline'` answers 422, because a resident without a baseline of their own would get no alarm from it. Set baseline limits per resident with `PUT /v2/slim/threshold/patient/{patientId}`. - `settings.outOfBed`: `mode: 'organization'` with `enabled` and `maxDurationSeconds` (a multiple of 60, from 0 to 86400), plus an optional `deviationPercent` (an integer from 5 to 300, or `null` to switch it off). With it, every resident on the home's out-of-bed setting alerts once an exit runs that far past their own usual exit, if that is sooner than `maxDurationSeconds`. Omit it to keep the stored value. - `settings.bedTimePeriod`: `mode: 'organization'` with `start` and `end` (`HH:MM:SS`). `end` equal to `start` means 24 hours; `end` before `start` crosses midnight. - `settings.oxygenSaturation`, `pulseRate`, `perfusionIndex`, `bodyTemperature` (each optional): `{ mode: 'organization', enabled, min, max }`, the home's default for every resident. Either bound may be `null` for a one-sided limit. An enabled vital needs at least one bound, and `min` must be below `max`. Omitting one, or sending `null`, keeps what is stored. Disabling one removes its rules in Signals. - `ranges` (optional): the range each vital's limits may take, for the home and every resident. Per vital, `{ min, max }` with `min < max`, inside heart rate 20–300, respiratory rate 4–150, SpO₂ 50–100, pulse 20–300, perfusion index 0–20 and body temperature 30–45. A vital left out keeps its stored range, or the default: heart rate 40–120, respiratory rate 4–60, SpO₂ 70–100, pulse 40–120, perfusion index 0–20, body temperature 34–42. A range for SpO₂, pulse, perfusion index or temperature is kept with that vital's setting, so the home must have set the vital (it may be disabled); otherwise the PUT answers 422 on `ranges.`. - Every enabled limit must sit inside its range, counting `ranges` in the same request. One outside answers 422 naming the field (for example `settings.heartRate.max`) and nothing is saved. A disabled band is not checked. - Narrowing a range does not rewrite residents whose limits fall outside it. A resident's next change to such a limit must fit; their other edits still save. - Medical limits (heart rate, respiratory rate, the optional vitals, the out-of-bed limit and the bed-time window) are evaluated by Signals. Every save is all or nothing, one that changes nothing included: it writes the home's settings to Signals and answers only once Signals holds them, and nothing writes them later. Residents following the home follow it at once, the out-of-bed band included (Signals applies it to each resident's usual exit); a resident with limits of their own keeps them. - Homes with many residents take longer: the save gives up after about 25 seconds and puts back what it wrote. Putting back can take longer than the gateway allows, so the caller may get a 504 while it finishes. Read the limits (`GET /v2/slim/threshold`) before sending the save again: until the undo is done, another save answers 409. - If any of that fails, everything the save changed is put back and it answers an error with `saved: false`. Nothing is stored; send the save again: - 409: another save of this home's limits is running, the home is moving to another Signals tenant, or the home's limits were saved while this one ran. - 502: the save ran out of time, or Signals did not take the limits. - 500: putting the previous limits back failed too. The message says which side kept the new limits; save the home's limits again. - If the stored thresholds cannot be read, the PUT answers 502 and nothing is saved. - Unknown keys are stripped, so a GET response can be sent back as a PUT body, with two exceptions: a heart-rate or respiratory-rate field still stored on baseline (see above), and a range the GET reports for an optional vital the home has never set. - A change-history entry is written for a save that stands. The response is the saved configuration, with `signalsSync: { status: 'ok' }`. - The v1 route `PUT /v1/slim/threshold` is deprecated in favour of this one. ## Example ```bash curl -X PUT 'https://api.sandbox.ovok.com/v2/slim/threshold' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "settings": { "heartRate": { "mode": "organization", "enabled": true, "min": 40, "max": 120 }, "respiratoryRate": { "mode": "organization", "enabled": true, "min": 8, "max": 25 }, "outOfBed": { "mode": "organization", "enabled": true, "maxDurationSeconds": 900 }, "bedTimePeriod": { "mode": "organization", "start": "19:00:00", "end": "09:00:00" } } }' ``` 23b:X 23c:[["children",{"s":"__PAGE__","h":512,"d":{"r":"$L23d","p":false,"v":null}}]] 239:[["children",{"s":{"n":"slug","t":"c","k":"flutter-sdk/reference/ovok_sdk/url","s":["availability.json","llms","llms-full.txt","llms.mdx","llms.txt","search"]},"h":512,"d":{"r":"$L23a","p":false,"v":"$23b"},"c":"$Q23c"}]] 15:[["children",{"s":"(docs)","h":512,"d":{"r":["$","$1","c",{"children":[[["$","script","script-0",{"src":"/_next/static/chunks/3hdj6x5zynuvw.js","async":true,"nonce":"$undefined"}],["$","script","script-1",{"src":"/_next/static/chunks/1qj9e83t7ijga.js","async":true,"nonce":"$undefined"}],["$","script","script-2",{"src":"/_next/static/chunks/2kakllpejehcz.js","async":true,"nonce":"$undefined"}],["$","script","script-3",{"src":"/_next/static/chunks/26xwnq_qcerhs.js","async":true,"nonce":"$undefined"}],["$","script","script-4",{"src":"/_next/static/chunks/3c1_4krvmo62j.js","async":true,"nonce":"$undefined"}],["$","script","script-5",{"src":"/_next/static/chunks/0n2c4bn-1u93z.js","async":true,"nonce":"$undefined"}]],["$","$L16",null,{"links":[{"type":"menu","text":"APIs & SDKs","items":[{"text":"API reference","url":"/api","description":"Every public Ovok route"},{"text":"FHIR R4 reference","url":"/api/fhir/r4","description":"Resources and operations"},{"text":"JavaScript SDK","url":"/web-sdk","description":"@ovok/core"},{"text":"React Native SDK","url":"/native-sdk","description":"@ovok/native"},{"text":"Java SDK","url":"/java-sdk"},{"text":"Python SDK","url":"/python-sdk"},{"text":"Flutter SDK","url":"/flutter-sdk"},{"text":"CLI","url":"/cli","description":"create-ovok and @ovok/cli"},{"text":"Errors","url":"/errors"},{"text":"Changelog","url":"/changelog"}]},{"type":"menu","text":"Help","items":[{"text":"Troubleshooting","url":"/errors"},{"text":"Support","url":"https://actimi.com/contact#contact-form","external":true},{"text":"llms.txt","url":"/llms.txt","description":"The docs for AI agents"}]},{"type":"custom","secondary":true,"children":"$L17"}],"nav":{"title":"$L18","url":"/","mode":"top"},"tabMode":"navbar","tree":{"type":"root","$ref":{"folder":"","meta":"meta.json"},"$id":"root","name":"Docs","description":"$undefined","children":[{"type":"folder","name":"Get started","root":true,"defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(get-started)/get-started/index.mdx","type":"page","name":"Overview","description":"Learn what Ovok does, create your first app, and pick the path that fits what you're building.","icon":"$undefined","url":"/get-started","$ref":"(get-started)/get-started/index.mdx"},{"$id":"(get-started)/get-started/quickstart.mdx","type":"page","name":"Quickstart","description":"Scaffold a web and mobile workspace connected to the Ovok sandbox, sign in, and list your project's patients.","icon":"$undefined","url":"/get-started/quickstart","$ref":"(get-started)/get-started/quickstart.mdx"},{"$id":"_0","type":"separator","icon":"$undefined","name":"Start building"},{"$id":"_1","type":"page","icon":"$undefined","name":"Set up your project","url":"/authentication/project-setup","external":"$undefined"},{"$id":"(get-started)/fhir-basics.mdx","type":"page","name":"FHIR Basics","description":"Learn the FHIR concepts used to represent and connect healthcare data in Ovok.","icon":"$undefined","url":"/fhir-basics","$ref":"(get-started)/fhir-basics.mdx"},{"type":"folder","name":"Example RPM Apps","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"rpm-web-dashboard","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"_2","type":"separator","icon":"$undefined","name":"Get started"},{"$id":"(get-started)/example-rpm-app/web-dashboard/getting-started.mdx","type":"page","name":"Run the demo","description":"Clone and run the synthetic clinician dashboard locally.","icon":"$undefined","url":"/example-rpm-app/web-dashboard/getting-started","$ref":"(get-started)/example-rpm-app/web-dashboard/getting-started.mdx"},{"$id":"(get-started)/example-rpm-app/web-dashboard/sandbox-setup.mdx","type":"page","name":"Connect a sandbox","description":"Configure a local dashboard build for one Ovok sandbox project and practitioner account.","icon":"$undefined","url":"/example-rpm-app/web-dashboard/sandbox-setup","$ref":"(get-started)/example-rpm-app/web-dashboard/sandbox-setup.mdx"},{"$id":"_3","type":"separator","icon":"$undefined","name":"Explore the code"},{"$id":"(get-started)/example-rpm-app/web-dashboard/app-shell.mdx","type":"page","name":"App shell and navigation","description":"Trace page selection, workspace mode, patient selection, and the main clinician dashboard shell.","icon":"$undefined","url":"/example-rpm-app/web-dashboard/app-shell","$ref":"(get-started)/example-rpm-app/web-dashboard/app-shell.mdx"},{"$id":"(get-started)/example-rpm-app/web-dashboard/patient-data.mdx","type":"page","name":"Patient data flow","description":"Trace patient, measurement, and questionnaire reads from the Ovok SDK into the clinician review UI.","icon":"$undefined","url":"/example-rpm-app/web-dashboard/patient-data","$ref":"(get-started)/example-rpm-app/web-dashboard/patient-data.mdx"},{"$id":"(get-started)/example-rpm-app/web-dashboard/signals-and-support.mdx","type":"page","name":"Signals and support","description":"See how the dashboard reads project Signals status and alerts through Ovok and keeps the screen read-only.","icon":"$undefined","url":"/example-rpm-app/web-dashboard/signals-and-support","$ref":"(get-started)/example-rpm-app/web-dashboard/signals-and-support.mdx"},{"$id":"(get-started)/example-rpm-app/web-dashboard/demo-and-tests.mdx","type":"page","name":"Demo data and tests","description":"Understand the synthetic clinician workspace and the focused checks for dashboard data mapping.","icon":"$undefined","url":"/example-rpm-app/web-dashboard/demo-and-tests","$ref":"(get-started)/example-rpm-app/web-dashboard/demo-and-tests.mdx"}],"$id":"(get-started)/example-rpm-app/web-dashboard","$ref":{"folder":"(get-started)/example-rpm-app/web-dashboard","meta":"(get-started)/example-rpm-app/web-dashboard/meta.json"},"index":{"$id":"(get-started)/example-rpm-app/web-dashboard/index.mdx","type":"page","name":"rpm-web-dashboard","description":"Start and explore the public Ovok clinician dashboard example built with React, Vite, TypeScript, and the Ovok SDK.","icon":"$undefined","url":"/example-rpm-app/web-dashboard","$ref":"(get-started)/example-rpm-app/web-dashboard/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"rpm-ehr-example-app","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"_4","type":"separator","icon":"$undefined","name":"Get started"},{"$id":"(get-started)/example-rpm-app/ehr/getting-started.mdx","type":"page","name":"Run the EHR","description":"Clone and run the synthetic Ovok clinic EHR example locally.","icon":"$undefined","url":"/example-rpm-app/ehr/getting-started","$ref":"(get-started)/example-rpm-app/ehr/getting-started.mdx"},{"$id":"(get-started)/example-rpm-app/ehr/sandbox-setup.mdx","type":"page","name":"Connect a sandbox","description":"Configure the EHR example for an authorized Ovok sandbox project and Practitioner account.","icon":"$undefined","url":"/example-rpm-app/ehr/sandbox-setup","$ref":"(get-started)/example-rpm-app/ehr/sandbox-setup.mdx"},{"$id":"_5","type":"separator","icon":"$undefined","name":"Explore the code"},{"$id":"(get-started)/example-rpm-app/ehr/clinic-workflow.mdx","type":"page","name":"Clinic workflow","description":"Follow the EHR example's patient intake, Practitioner authorization, FHIR reads and writes, Signals view, and synthetic relay boundaries.","icon":"$undefined","url":"/example-rpm-app/ehr/clinic-workflow","$ref":"(get-started)/example-rpm-app/ehr/clinic-workflow.mdx"}],"$id":"(get-started)/example-rpm-app/ehr","$ref":{"folder":"(get-started)/example-rpm-app/ehr","meta":"(get-started)/example-rpm-app/ehr/meta.json"},"index":{"$id":"(get-started)/example-rpm-app/ehr/index.mdx","type":"page","name":"rpm-ehr-example-app","description":"Run and explore the public Ovok EHR example for clinic intake, CHF RPM enrollment, patient charts, and FHIR workflows.","icon":"$undefined","url":"/example-rpm-app/ehr","$ref":"(get-started)/example-rpm-app/ehr/index.mdx"},"icon":"$undefined"},{"$id":"_6","type":"separator","icon":"$undefined","name":"rpm-mobile-app"},{"$id":"(get-started)/example-rpm-app/mobile-app.mdx","type":"page","name":"rpm-mobile-app","description":"Start and explore Ovok's public patient-facing RPM example built with Expo, React Native, and the Ovok SDK.","icon":"$undefined","url":"/example-rpm-app/mobile-app","$ref":"(get-started)/example-rpm-app/mobile-app.mdx"},{"$id":"_7","type":"separator","icon":"$undefined","name":"Get started"},{"$id":"(get-started)/example-rpm-app/getting-started.mdx","type":"page","name":"Run it from scratch","description":"Clone Ovok Care, install its dependencies, and run its synthetic-data demo in an iOS simulator.","icon":"$undefined","url":"/example-rpm-app/getting-started","$ref":"(get-started)/example-rpm-app/getting-started.mdx"},{"$id":"(get-started)/example-rpm-app/sandbox-setup.mdx","type":"page","name":"Connect a sandbox project","description":"Configure Ovok Care for an authorized sandbox Patient account without placing credentials in the mobile app.","icon":"$undefined","url":"/example-rpm-app/sandbox-setup","$ref":"(get-started)/example-rpm-app/sandbox-setup.mdx"},{"type":"folder","name":"Explore the app","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(get-started)/example-rpm-app/app-tabs/home.mdx","type":"page","name":"Home","description":"Explore the daily measurement and check-in workflow in Ovok Care.","icon":"$undefined","url":"/example-rpm-app/app-tabs/home","$ref":"(get-started)/example-rpm-app/app-tabs/home.mdx"},{"$id":"(get-started)/example-rpm-app/app-tabs/diary.mdx","type":"page","name":"Diary","description":"Understand the local reading and check-in history shown by the RPM example app.","icon":"$undefined","url":"/example-rpm-app/app-tabs/diary","$ref":"(get-started)/example-rpm-app/app-tabs/diary.mdx"},{"$id":"(get-started)/example-rpm-app/app-tabs/support.mdx","type":"page","name":"Support","description":"Find device instructions and troubleshooting in the Ovok Care example.","icon":"$undefined","url":"/example-rpm-app/app-tabs/support","$ref":"(get-started)/example-rpm-app/app-tabs/support.mdx"},{"$id":"(get-started)/example-rpm-app/app-tabs/settings.mdx","type":"page","name":"Settings","description":"Explore appearance, device management, and Patient sign-in in the RPM example app.","icon":"$undefined","url":"/example-rpm-app/app-tabs/settings","$ref":"(get-started)/example-rpm-app/app-tabs/settings.mdx"}],"$id":"(get-started)/example-rpm-app/app-tabs","$ref":{"folder":"(get-started)/example-rpm-app/app-tabs","meta":"(get-started)/example-rpm-app/app-tabs/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Explore the code","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(get-started)/example-rpm-app/integrations/authentication.mdx","type":"page","name":"Patient authentication","description":"See how the example configures tenant context and signs in an existing Patient account.","icon":"$undefined","url":"/example-rpm-app/integrations/authentication","$ref":"(get-started)/example-rpm-app/integrations/authentication.mdx"},{"$id":"(get-started)/example-rpm-app/integrations/fhir-persistence.mdx","type":"page","name":"FHIR persistence","description":"Follow the example's Patient-scoped QuestionnaireResponse and measurement writes through Ovok.","icon":"$undefined","url":"/example-rpm-app/integrations/fhir-persistence","$ref":"(get-started)/example-rpm-app/integrations/fhir-persistence.mdx"},{"$id":"(get-started)/example-rpm-app/integrations/bluetooth.mdx","type":"page","name":"Bluetooth measurements","description":"Trace discovery, pairing, normalized device results, and save handoff in Ovok Care.","icon":"$undefined","url":"/example-rpm-app/integrations/bluetooth","$ref":"(get-started)/example-rpm-app/integrations/bluetooth.mdx"},{"$id":"(get-started)/example-rpm-app/integrations/local-data-and-sync.mdx","type":"page","name":"Local data and sync","description":"Understand demo isolation, local persistence, foreground sync, and retry states in Ovok Care.","icon":"$undefined","url":"/example-rpm-app/integrations/local-data-and-sync","$ref":"(get-started)/example-rpm-app/integrations/local-data-and-sync.mdx"}],"$id":"(get-started)/example-rpm-app/integrations","$ref":{"folder":"(get-started)/example-rpm-app/integrations","meta":"(get-started)/example-rpm-app/integrations/meta.json"},"icon":"$undefined"},{"type":"folder","name":"rpm-example-app","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"_8","type":"separator","icon":"$undefined","name":"Get started"},{"$id":"(get-started)/example-rpm-app/monorepo/getting-started.mdx","type":"page","name":"Run both apps","description":"Install the Ovok RPM example monorepo and start its mobile and web workspaces.","icon":"$undefined","url":"/example-rpm-app/monorepo/getting-started","$ref":"(get-started)/example-rpm-app/monorepo/getting-started.mdx"},{"$id":"_9","type":"separator","icon":"$undefined","name":"Explore the code"},{"$id":"(get-started)/example-rpm-app/monorepo/workspaces.mdx","type":"page","name":"Workspaces and commands","description":"Understand the monorepo's npm workspaces, app boundaries, and Turborepo commands.","icon":"$undefined","url":"/example-rpm-app/monorepo/workspaces","$ref":"(get-started)/example-rpm-app/monorepo/workspaces.mdx"},{"$id":"(get-started)/example-rpm-app/monorepo/mobile-app.mdx","type":"page","name":"Patient mobile app","description":"Find the mobile app entry point, patient screens, device integration, and persistence in rpm-example-app.","icon":"$undefined","url":"/example-rpm-app/monorepo/mobile-app","$ref":"(get-started)/example-rpm-app/monorepo/mobile-app.mdx"},{"$id":"(get-started)/example-rpm-app/monorepo/web-dashboard.mdx","type":"page","name":"Clinician dashboard","description":"Find the dashboard entry point, patient review screens, data mapper, and read-only Signals view in rpm-example-app.","icon":"$undefined","url":"/example-rpm-app/monorepo/web-dashboard","$ref":"(get-started)/example-rpm-app/monorepo/web-dashboard.mdx"},{"$id":"(get-started)/example-rpm-app/monorepo/data-flow.mdx","type":"page","name":"End-to-end data flow","description":"Trace a patient reading from the mobile app into Ovok and into the clinician dashboard review.","icon":"$undefined","url":"/example-rpm-app/monorepo/data-flow","$ref":"(get-started)/example-rpm-app/monorepo/data-flow.mdx"}],"$id":"(get-started)/example-rpm-app/monorepo","$ref":{"folder":"(get-started)/example-rpm-app/monorepo","meta":"(get-started)/example-rpm-app/monorepo/meta.json"},"index":{"$id":"(get-started)/example-rpm-app/monorepo/index.mdx","type":"page","name":"rpm-example-app","description":"Run the patient mobile app, clinician dashboard, and clinic EHR together from Ovok's public Turborepo example monorepo.","icon":"$undefined","url":"/example-rpm-app/monorepo","$ref":"(get-started)/example-rpm-app/monorepo/index.mdx"},"icon":"$undefined"}],"$id":"(get-started)/example-rpm-app","$ref":{"folder":"(get-started)/example-rpm-app","meta":"(get-started)/example-rpm-app/meta.json"},"index":{"$id":"(get-started)/example-rpm-app/index.mdx","type":"page","name":"Example RPM Apps","description":"Choose a public Ovok RPM example repository: patient mobile app, clinician dashboard, clinic EHR, or the monorepo that runs them together.","icon":"$undefined","url":"/example-rpm-app","$ref":"(get-started)/example-rpm-app/index.mdx"},"icon":"$undefined"},{"$id":"_10","type":"page","icon":"$undefined","name":"Build with AI agents","url":"/working-with-ai-agents","external":"$undefined"},{"$id":"_11","type":"separator","icon":"$undefined","name":"Choose your SDK"},{"$id":"_12","type":"page","icon":"$undefined","name":"JavaScript SDK","url":"/web-sdk","external":"$undefined"},{"$id":"_13","type":"page","icon":"$undefined","name":"React Native SDK","url":"/native-sdk","external":"$undefined"},{"$id":"_14","type":"page","icon":"$undefined","name":"Java SDK","url":"/java-sdk","external":"$undefined"},{"$id":"_15","type":"page","icon":"$undefined","name":"Python SDK","url":"/python-sdk","external":"$undefined"},{"$id":"_16","type":"page","icon":"$undefined","name":"Flutter SDK","url":"/flutter-sdk","external":"$undefined"},{"$id":"_17","type":"separator","icon":"$undefined","name":"Follow a guide"},{"$id":"_18","type":"page","icon":"$undefined","name":"Blood-pressure monitoring","url":"/guides/chf-remote-monitoring","external":"$undefined"},{"$id":"_19","type":"page","icon":"$undefined","name":"Medication reminders","url":"/guides/medication-reminder","external":"$undefined"},{"$id":"_20","type":"page","icon":"$undefined","name":"Type 2 diabetes care","url":"/guides/type-2-diabetes","external":"$undefined"},{"$id":"_21","type":"page","icon":"$undefined","name":"Whole-person wellness","url":"/guides/whole-person-wellness","external":"$undefined"}],"$id":"(get-started)","$ref":{"folder":"(get-started)","meta":"(get-started)/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Ovok","root":true,"defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"_22","type":"separator","icon":"$undefined","name":"Authentication"},{"$id":"(ovok)/authentication/index.mdx","type":"page","name":"Authentication","description":"Sign patients and practitioners in to an Ovok project with tenant authentication, and learn which project settings control it.","icon":"$undefined","url":"/authentication","$ref":"(ovok)/authentication/index.mdx"},{"$id":"(ovok)/authentication/project-setup.mdx","type":"page","name":"Set up your project","description":"Configure the project settings and AccessPolicies that patient and practitioner sign-in and registration depend on, then check that it works.","icon":"$undefined","url":"/authentication/project-setup","$ref":"(ovok)/authentication/project-setup.mdx"},{"$id":"(ovok)/authentication/patient-login.mdx","type":"page","name":"Patient sign-in","description":"Sign a patient in to one tenant with the three-step PKCE flow, and the setting that controls it.","icon":"$undefined","url":"/authentication/patient-login","$ref":"(ovok)/authentication/patient-login.mdx"},{"$id":"(ovok)/authentication/practitioner-login.mdx","type":"page","name":"Practitioner sign-in","description":"Sign a practitioner in, choose which tenant to enter, and the setting that controls it.","icon":"$undefined","url":"/authentication/practitioner-login","$ref":"(ovok)/authentication/practitioner-login.mdx"},{"$id":"(ovok)/authentication/patient-registration.mdx","type":"page","name":"Patient registration","description":"Let a patient create their own account in a tenant, the project settings it needs, and business-email sign-up.","icon":"$undefined","url":"/authentication/patient-registration","$ref":"(ovok)/authentication/patient-registration.mdx"},{"$id":"(ovok)/authentication/practitioner-registration.mdx","type":"page","name":"Practitioner registration","description":"Let a practitioner create their own account in a tenant, why it is off by default, and what the project must configure first.","icon":"$undefined","url":"/authentication/practitioner-registration","$ref":"(ovok)/authentication/practitioner-registration.mdx"},{"$id":"(ovok)/authentication/carers.mdx","type":"page","name":"Carers","description":"How a carer (a FHIR RelatedPerson) gets an Ovok account, signs in, resets a password, and what a carer can and cannot do.","icon":"$undefined","url":"/authentication/carers","$ref":"(ovok)/authentication/carers.mdx"},{"type":"folder","name":"Your account","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/authentication/account/get-account-information.mdx","type":"page","name":"Get account information","description":"Read who an access token belongs to with GET /auth/me, including the project, profile, access policy and sessions.","icon":"$undefined","url":"/authentication/account/get-account-information","$ref":"(ovok)/authentication/account/get-account-information.mdx"},{"$id":"(ovok)/authentication/account/list-sessions.mdx","type":"page","name":"List sessions","description":"List the signed-in user's sessions with GET /auth/session to build a \"where you are signed in\" screen.","icon":"$undefined","url":"/authentication/account/list-sessions","$ref":"(ovok)/authentication/account/list-sessions.mdx"},{"$id":"(ovok)/authentication/account/revoke-sessions.mdx","type":"page","name":"Revoke sessions","description":"Sign the caller out of the current session, all other sessions, all sessions, or one session id with DELETE /auth/session/{option}.","icon":"$undefined","url":"/authentication/account/revoke-sessions","$ref":"(ovok)/authentication/account/revoke-sessions.mdx"},{"$id":"(ovok)/authentication/account/refresh-token.mdx","type":"page","name":"Refresh an access token","description":"Exchange a refresh token for a new access token and a new refresh token with POST /auth/refresh-token.","icon":"$undefined","url":"/authentication/account/refresh-token","$ref":"(ovok)/authentication/account/refresh-token.mdx"},{"$id":"(ovok)/authentication/account/log-out.mdx","type":"page","name":"Log out","description":"End an access token on the server with POST /v1/auth/logout so it stops working before it expires.","icon":"$undefined","url":"/authentication/account/log-out","$ref":"(ovok)/authentication/account/log-out.mdx"},{"$id":"(ovok)/authentication/account/change-password.mdx","type":"page","name":"Change password","description":"Change the password of the signed-in user with PATCH /v2/auth/change-password, using the current password as proof.","icon":"$undefined","url":"/authentication/account/change-password","$ref":"(ovok)/authentication/account/change-password.mdx"},{"$id":"(ovok)/authentication/account/reset-password.mdx","type":"page","name":"Send a password reset email","description":"Email a patient, carer or practitioner a password reset link with POST /v2/auth/reset-password, without revealing whether the account exists.","icon":"$undefined","url":"/authentication/account/reset-password","$ref":"(ovok)/authentication/account/reset-password.mdx"},{"$id":"(ovok)/authentication/account/process-password-reset.mdx","type":"page","name":"Set a new password from a reset email","description":"Set a new password with the id and secret from a reset or invitation email using POST /v2/auth/reset-password/process.","icon":"$undefined","url":"/authentication/account/process-password-reset","$ref":"(ovok)/authentication/account/process-password-reset.mdx"},{"$id":"(ovok)/authentication/account/delete-account.mdx","type":"page","name":"Schedule account deletion","description":"Schedule the deletion of the signed-in user's own account with DELETE /auth/delete, and how signing in again cancels it.","icon":"$undefined","url":"/authentication/account/delete-account","$ref":"(ovok)/authentication/account/delete-account.mdx"},{"$id":"(ovok)/authentication/account/get-medical-consent.mdx","type":"page","name":"Get medical consent","description":"Read the signed-in practitioner's medical settings notifications consent with GET /v1/me/consent/medical, or null when it is not given.","icon":"$undefined","url":"/authentication/account/get-medical-consent","$ref":"(ovok)/authentication/account/get-medical-consent.mdx"},{"$id":"(ovok)/authentication/account/update-medical-consent.mdx","type":"page","name":"Give or withdraw the medical consent","description":"Give or withdraw the medical settings notifications consent of the signed-in practitioner with POST /v1/me/consent/medical.","icon":"$undefined","url":"/authentication/account/update-medical-consent","$ref":"(ovok)/authentication/account/update-medical-consent.mdx"},{"$id":"(ovok)/authentication/account/get-legal-consent.mdx","type":"page","name":"Get legal consent","description":"Read which terms the signed-in practitioner accepted, when, and whether the acceptance is still active, with GET /v1/me/consent/legal.","icon":"$undefined","url":"/authentication/account/get-legal-consent","$ref":"(ovok)/authentication/account/get-legal-consent.mdx"},{"$id":"(ovok)/authentication/account/update-legal-consent.mdx","type":"page","name":"Accept or withdraw the terms","description":"Accept or withdraw the terms for the signed-in practitioner with POST /v1/me/consent/legal and get the resulting legal consent back.","icon":"$undefined","url":"/authentication/account/update-legal-consent","$ref":"(ovok)/authentication/account/update-legal-consent.mdx"}],"$id":"(ovok)/authentication/account","$ref":{"folder":"(ovok)/authentication/account","meta":"(ovok)/authentication/account/meta.json"},"icon":"$undefined"},{"$id":"(ovok)/authentication/troubleshooting.mdx","type":"page","name":"Errors and troubleshooting","description":"The error format of the tenant authentication routes, every message you can meet, and what to check and change when sign-in or registration does not behave as expected.","icon":"$undefined","url":"/authentication/troubleshooting","$ref":"(ovok)/authentication/troubleshooting.mdx"},{"$id":"_23","type":"separator","icon":"$undefined","name":"Access policies"},{"$id":"(ovok)/access-policies/index.mdx","type":"page","name":"Overview","description":"Learn how Ovok AccessPolicies shape project membership access, how default policies are assigned, and how Signals routes use custom policy rows.","icon":"$undefined","url":"/access-policies","$ref":"(ovok)/access-policies/index.mdx"},{"$id":"(ovok)/access-policies/policy-model.mdx","type":"page","name":"Policy model","description":"Understand AccessPolicy resource rules, interactions, criteria, and how a project membership receives policies.","icon":"$undefined","url":"/access-policies/policy-model","$ref":"(ovok)/access-policies/policy-model.mdx"},{"$id":"(ovok)/access-policies/defaults.mdx","type":"page","name":"Default policies","description":"Learn where Ovok gets the default AccessPolicy for a new patient or practitioner, which routes use it, and what defaults do not do.","icon":"$undefined","url":"/access-policies/defaults","$ref":"(ovok)/access-policies/defaults.mdx"},{"$id":"(ovok)/access-policies/signals.mdx","type":"page","name":"Signals policies","description":"The signals_* AccessPolicy rows that authorize Signals routes through Ovok, what each one opens, and which app types hold it.","icon":"$undefined","url":"/access-policies/signals","$ref":"(ovok)/access-policies/signals.mdx"},{"$id":"_24","type":"separator","icon":"$undefined","name":"Projects"},{"$id":"(ovok)/projects/index.mdx","type":"page","name":"Projects","description":"Understand projects and sub-projects on Ovok, and choose between the routes that list the projects you administer and create or delete sub-projects.","icon":"$undefined","url":"/projects","$ref":"(ovok)/projects/index.mdx"},{"$id":"(ovok)/projects/list-projects.mdx","type":"page","name":"List administered projects","description":"List every project you administer, with the tenant code you need to enter it, to build a project picker.","icon":"$undefined","url":"/projects/list-projects","$ref":"(ovok)/projects/list-projects.mdx"},{"$id":"(ovok)/projects/list-sub-projects.mdx","type":"page","name":"List sub-projects","description":"Read where your current project sits in the hierarchy, with its parent and its direct sub-projects.","icon":"$undefined","url":"/projects/list-sub-projects","$ref":"(ovok)/projects/list-sub-projects.mdx"},{"$id":"(ovok)/projects/create-sub-project.mdx","type":"page","name":"Create a sub-project","description":"Create a sub-project under your current project: what is created, who owns it, and what the response contains for a user or a client application.","icon":"$undefined","url":"/projects/create-sub-project","$ref":"(ovok)/projects/create-sub-project.mdx"},{"$id":"(ovok)/projects/delete-sub-project.mdx","type":"page","name":"Delete a sub-project","description":"Delete an empty direct sub-project of your project together with the setup Ovok created for it, and how to retry a delete that ended in a 502.","icon":"$undefined","url":"/projects/delete-sub-project","$ref":"(ovok)/projects/delete-sub-project.mdx"},{"$id":"_25","type":"separator","icon":"$undefined","name":"Invitations"},{"$id":"(ovok)/invitations/index.mdx","type":"page","name":"Invitations","description":"Bring people into an Ovok project with invitations, and choose between adding a team member, sharing a patient's record with a practitioner or a carer, and inviting a patient into care.","icon":"$undefined","url":"/invitations","$ref":"(ovok)/invitations/index.mdx"},{"$id":"(ovok)/invitations/team-members.mdx","type":"page","name":"Invite a team member","description":"Add a practitioner to your project with POST /v1/projects/me/members, the required fields, access policies, and the cases that surprise people.","icon":"$undefined","url":"/invitations/team-members","$ref":"(ovok)/invitations/team-members.mdx"},{"$id":"(ovok)/invitations/share-with-practitioner.mdx","type":"page","name":"Share a record with a practitioner","description":"Let a signed-in patient share their whole record with a practitioner by email, and how the practitioner accepts it.","icon":"$undefined","url":"/invitations/share-with-practitioner","$ref":"(ovok)/invitations/share-with-practitioner.mdx"},{"$id":"(ovok)/invitations/share-with-a-carer.mdx","type":"page","name":"Share readings with a carer","description":"Let a signed-in patient share chosen readings with a carer by email, how the carer accepts and gets an account, and what the carer can then read.","icon":"$undefined","url":"/invitations/share-with-a-carer","$ref":"(ovok)/invitations/share-with-a-carer.mdx"},{"$id":"(ovok)/invitations/invite-a-patient.mdx","type":"page","name":"Invite a patient into care","description":"Let a practitioner invite a patient by email and see their record, and how the patient accepts it.","icon":"$undefined","url":"/invitations/invite-a-patient","$ref":"(ovok)/invitations/invite-a-patient.mdx"},{"$id":"_26","type":"separator","icon":"$undefined","name":"Settings and features"},{"$id":"(ovok)/settings-and-features/index.mdx","type":"page","name":"Settings and features","description":"Understand project features, settings, defaults, and the APIs that control them in Ovok.","icon":"$undefined","url":"/settings-and-features","$ref":"(ovok)/settings-and-features/index.mdx"},{"type":"folder","name":"Features","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/settings-and-features/features/bots.mdx","type":"page","name":"bots","description":"Run, deploy and subscribe to Bots in a project, and which other features depend on it.","icon":"$undefined","url":"/settings-and-features/features/bots","$ref":"(ovok)/settings-and-features/features/bots.mdx"},{"$id":"(ovok)/settings-and-features/features/cron.mdx","type":"page","name":"cron","description":"Run Bots on a schedule, and why turning the feature on or off does not change schedules that already exist.","icon":"$undefined","url":"/settings-and-features/features/cron","$ref":"(ovok)/settings-and-features/features/cron.mdx"},{"$id":"(ovok)/settings-and-features/features/email.mdx","type":"page","name":"email","description":"Let Bots send email, and what this feature does not control, including the emails Ovok sends itself.","icon":"$undefined","url":"/settings-and-features/features/email","$ref":"(ovok)/settings-and-features/features/email.mdx"},{"$id":"(ovok)/settings-and-features/features/websocket-subscriptions.mdx","type":"page","name":"websocket-subscriptions","description":"Receive live updates over a WebSocket Subscription channel, what the feature gates, and what it does not.","icon":"$undefined","url":"/settings-and-features/features/websocket-subscriptions","$ref":"(ovok)/settings-and-features/features/websocket-subscriptions.mdx"},{"$id":"(ovok)/settings-and-features/features/transaction-bundles.mdx","type":"page","name":"transaction-bundles","description":"Write several resources all-or-nothing with a FHIR transaction Bundle, and what happens silently when the feature is off.","icon":"$undefined","url":"/settings-and-features/features/transaction-bundles","$ref":"(ovok)/settings-and-features/features/transaction-bundles.mdx"},{"$id":"(ovok)/settings-and-features/features/ai.mdx","type":"page","name":"ai","description":"Call a language model through the API with your own key, what leaves your project when you do, and what the feature does not cover.","icon":"$undefined","url":"/settings-and-features/features/ai","$ref":"(ovok)/settings-and-features/features/ai.mdx"},{"$id":"(ovok)/settings-and-features/features/aws-comprehend.mdx","type":"page","name":"aws-comprehend","description":"What the aws-comprehend flag does today, and where Comprehend Medical analysis actually comes from.","icon":"$undefined","url":"/settings-and-features/features/aws-comprehend","$ref":"(ovok)/settings-and-features/features/aws-comprehend.mdx"},{"$id":"(ovok)/settings-and-features/features/aws-textract.mdx","type":"page","name":"aws-textract","description":"Extract text from a stored document with AWS Textract, what it needs and costs, and how it relates to aws-comprehend.","icon":"$undefined","url":"/settings-and-features/features/aws-textract","$ref":"(ovok)/settings-and-features/features/aws-textract.mdx"},{"$id":"(ovok)/settings-and-features/features/google-auth-required.mdx","type":"page","name":"google-auth-required","description":"Require Google as the only sign-in method, which sign-in paths enforce it, and how to avoid locking yourself out.","icon":"$undefined","url":"/settings-and-features/features/google-auth-required","$ref":"(ovok)/settings-and-features/features/google-auth-required.mdx"},{"$id":"(ovok)/settings-and-features/features/graphql-introspection.mdx","type":"page","name":"graphql-introspection","description":"The graphql-introspection flag has no effect today. Introspection is controlled platform-wide and works in the sandbox with the flag off.","icon":"$undefined","url":"/settings-and-features/features/graphql-introspection","$ref":"(ovok)/settings-and-features/features/graphql-introspection.mdx"},{"$id":"(ovok)/settings-and-features/features/validate-terminology.mdx","type":"page","name":"validate-terminology","description":"Reject coded values that do not satisfy a required terminology binding when a resource is written, and what this feature does not affect.","icon":"$undefined","url":"/settings-and-features/features/validate-terminology","$ref":"(ovok)/settings-and-features/features/validate-terminology.mdx"}],"$id":"(ovok)/settings-and-features/features","$ref":{"folder":"(ovok)/settings-and-features/features","meta":"(ovok)/settings-and-features/features/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Settings","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/settings-and-features/settings/patient-login-enabled.mdx","type":"page","name":"PATIENT_LOGIN_ENABLED","description":"Pause or resume patient sign-in for a project without affecting practitioners.","icon":"$undefined","url":"/settings-and-features/settings/patient-login-enabled","$ref":"(ovok)/settings-and-features/settings/patient-login-enabled.mdx"},{"$id":"(ovok)/settings-and-features/settings/practitioner-login-enabled.mdx","type":"page","name":"PRACTITIONER_LOGIN_ENABLED","description":"Pause or resume practitioner sign-in for a project, and what the switch does and does not cover.","icon":"$undefined","url":"/settings-and-features/settings/practitioner-login-enabled","$ref":"(ovok)/settings-and-features/settings/practitioner-login-enabled.mdx"},{"$id":"(ovok)/settings-and-features/settings/patient-invitation-enabled.mdx","type":"page","name":"PATIENT_INVITATION_ENABLED","description":"Allow or stop patient invitations, and what an invitation needs before it can be sent.","icon":"$undefined","url":"/settings-and-features/settings/patient-invitation-enabled","$ref":"(ovok)/settings-and-features/settings/patient-invitation-enabled.mdx"},{"$id":"(ovok)/settings-and-features/settings/practitioner-invitation-enabled.mdx","type":"page","name":"PRACTITIONER_INVITATION_ENABLED","description":"Allow or stop practitioner invitations, which routes it covers, and which access policy an invited practitioner gets.","icon":"$undefined","url":"/settings-and-features/settings/practitioner-invitation-enabled","$ref":"(ovok)/settings-and-features/settings/practitioner-invitation-enabled.mdx"},{"$id":"(ovok)/settings-and-features/settings/related-person-login-enabled.mdx","type":"page","name":"RELATED_PERSON_LOGIN_ENABLED","description":"Pause or resume carer (RelatedPerson) sign-in for a project without affecting patients or practitioners.","icon":"$undefined","url":"/settings-and-features/settings/related-person-login-enabled","$ref":"(ovok)/settings-and-features/settings/related-person-login-enabled.mdx"},{"$id":"(ovok)/settings-and-features/settings/related-person-invitation-enabled.mdx","type":"page","name":"RELATED_PERSON_INVITATION_ENABLED","description":"Allow or stop patients inviting carers (RelatedPerson), for both sending and accepting an invite.","icon":"$undefined","url":"/settings-and-features/settings/related-person-invitation-enabled","$ref":"(ovok)/settings-and-features/settings/related-person-invitation-enabled.mdx"},{"$id":"(ovok)/settings-and-features/settings/patient-registration-enabled.mdx","type":"page","name":"PATIENT_REGISTRATION_ENABLED","description":"Let patients create their own account, what the project must have in place first, and the sign-up paths the switch does not cover.","icon":"$undefined","url":"/settings-and-features/settings/patient-registration-enabled","$ref":"(ovok)/settings-and-features/settings/patient-registration-enabled.mdx"},{"$id":"(ovok)/settings-and-features/settings/practitioner-registration-enabled.mdx","type":"page","name":"PRACTITIONER_REGISTRATION_ENABLED","description":"Let practitioners create their own account in a project, which access policy they get, and why this is off by default.","icon":"$undefined","url":"/settings-and-features/settings/practitioner-registration-enabled","$ref":"(ovok)/settings-and-features/settings/practitioner-registration-enabled.mdx"},{"$id":"(ovok)/settings-and-features/settings/default-practitioner-access-policy.mdx","type":"page","name":"DEFAULT_PRACTITIONER_ACCESS_POLICY","description":"The AccessPolicy Ovok gives to new practitioners, which routes read it, and what happens when it is missing or invalid.","icon":"$undefined","url":"/settings-and-features/settings/default-practitioner-access-policy","$ref":"(ovok)/settings-and-features/settings/default-practitioner-access-policy.mdx"},{"$id":"(ovok)/settings-and-features/settings/clinician-invite-on-business-email.mdx","type":"page","name":"CLINICIAN_INVITE_ON_BUSINESS_EMAIL","description":"Turn a patient registration with a work email into a practitioner invitation, what it needs, and when it silently falls back to a patient account.","icon":"$undefined","url":"/settings-and-features/settings/clinician-invite-on-business-email","$ref":"(ovok)/settings-and-features/settings/clinician-invite-on-business-email.mdx"},{"$id":"(ovok)/settings-and-features/settings/patient-app-url.mdx","type":"page","name":"PATIENT_APP_URL","description":"The address Ovok puts in links it emails to patients, how it is resolved, and what is accepted.","icon":"$undefined","url":"/settings-and-features/settings/patient-app-url","$ref":"(ovok)/settings-and-features/settings/patient-app-url.mdx"},{"$id":"(ovok)/settings-and-features/settings/practitioner-app-url.mdx","type":"page","name":"PRACTITIONER_APP_URL","description":"The address Ovok puts in links it emails to practitioners, which routes read it, and the routes that do not.","icon":"$undefined","url":"/settings-and-features/settings/practitioner-app-url","$ref":"(ovok)/settings-and-features/settings/practitioner-app-url.mdx"},{"$id":"(ovok)/settings-and-features/settings/patient-sharing-enabled.mdx","type":"page","name":"PATIENT_SHARING_ENABLED","description":"Let patients share chosen readings with another patient or a carer, how to turn it on, and why it is not in the project settings record.","icon":"$undefined","url":"/settings-and-features/settings/patient-sharing-enabled","$ref":"(ovok)/settings-and-features/settings/patient-sharing-enabled.mdx"},{"$id":"(ovok)/settings-and-features/settings/mailing-enabled.mdx","type":"page","name":"MAILING_ENABLED","description":"A reserved project setting. It is accepted and stored, but no Ovok route reads it today; here is what controls email instead.","icon":"$undefined","url":"/settings-and-features/settings/mailing-enabled","$ref":"(ovok)/settings-and-features/settings/mailing-enabled.mdx"},{"$id":"(ovok)/settings-and-features/settings/content-enabled.mdx","type":"page","name":"CONTENT_ENABLED","description":"A marker the Ovok Console sets when you enable the CMS. It is stored, but no Ovok route reads it.","icon":"$undefined","url":"/settings-and-features/settings/content-enabled","$ref":"(ovok)/settings-and-features/settings/content-enabled.mdx"}],"$id":"(ovok)/settings-and-features/settings","$ref":{"folder":"(ovok)/settings-and-features/settings","meta":"(ovok)/settings-and-features/settings/meta.json"},"icon":"$undefined"},{"$id":"_27","type":"separator","icon":"$undefined","name":"Files and documents"},{"$id":"(ovok)/files-and-documents/index.mdx","type":"page","name":"Files and documents","description":"Store, list, download, replace, update and delete files with the document routes, and choose between the private and public download.","icon":"$undefined","url":"/files-and-documents","$ref":"(ovok)/files-and-documents/index.mdx"},{"$id":"(ovok)/files-and-documents/create-document.mdx","type":"page","name":"Create document","description":"Create a document and get a signed form to upload its file straight to file storage.","icon":"$undefined","url":"/files-and-documents/create-document","$ref":"(ovok)/files-and-documents/create-document.mdx"},{"$id":"(ovok)/files-and-documents/replace-document.mdx","type":"page","name":"Replace document file","description":"Replace the file of an existing document: update its metadata and get a new signed upload form.","icon":"$undefined","url":"/files-and-documents/replace-document","$ref":"(ovok)/files-and-documents/replace-document.mdx"},{"$id":"(ovok)/files-and-documents/search-documents.mdx","type":"page","name":"Search documents","description":"List the documents you can read, newest first, with paging and sorting.","icon":"$undefined","url":"/files-and-documents/search-documents","$ref":"(ovok)/files-and-documents/search-documents.mdx"},{"$id":"(ovok)/files-and-documents/get-document.mdx","type":"page","name":"Download document","description":"Download a document's file by redirect to a short-lived signed URL, with optional image resizing.","icon":"$undefined","url":"/files-and-documents/get-document","$ref":"(ovok)/files-and-documents/get-document.mdx"},{"$id":"(ovok)/files-and-documents/get-public-document.mdx","type":"page","name":"Download public document","description":"Download the file of a public document without a bearer token, using its public token.","icon":"$undefined","url":"/files-and-documents/get-public-document","$ref":"(ovok)/files-and-documents/get-public-document.mdx"},{"$id":"(ovok)/files-and-documents/update-document.mdx","type":"page","name":"Update document metadata","description":"Change a document's file name, content type or public status without uploading a new file.","icon":"$undefined","url":"/files-and-documents/update-document","$ref":"(ovok)/files-and-documents/update-document.mdx"},{"$id":"(ovok)/files-and-documents/delete-document.mdx","type":"page","name":"Delete document","description":"Delete a document and its stored file. This cannot be undone.","icon":"$undefined","url":"/files-and-documents/delete-document","$ref":"(ovok)/files-and-documents/delete-document.mdx"},{"$id":"(ovok)/files-and-documents/upload-binary.mdx","type":"page","name":"Upload binary file (deprecated)","description":"Deprecated. Upload one file in a multipart request and get its document record back. Use POST /document instead.","icon":"$undefined","url":"/files-and-documents/upload-binary","$ref":"(ovok)/files-and-documents/upload-binary.mdx"},{"$id":"(ovok)/files-and-documents/download-binary.mdx","type":"page","name":"Download binary file (deprecated)","description":"Deprecated. Download a file by redirect to a short-lived signed URL, with a bearer token or a public token. Use GET /document/:id or GET /document/public/:token instead.","icon":"$undefined","url":"/files-and-documents/download-binary","$ref":"(ovok)/files-and-documents/download-binary.mdx"},{"$id":"_28","type":"separator","icon":"$undefined","name":"Data ingestion"},{"$id":"(ovok)/data-ingestion/index.mdx","type":"page","name":"Data ingestion","description":"Send device and connected-system data into Ovok through the OVOK IoT Service.","icon":"$undefined","url":"/data-ingestion","$ref":"(ovok)/data-ingestion/index.mdx"},{"$id":"(ovok)/data-ingestion/ovok-iot-service.mdx","type":"page","name":"OVOK IoT Service","description":"Ingest device data through iot.ovok.com, protected by mutual TLS with setup support from the Ovok team.","icon":"$undefined","url":"/data-ingestion/ovok-iot-service","$ref":"(ovok)/data-ingestion/ovok-iot-service.mdx"},{"$id":"_29","type":"separator","icon":"$undefined","name":"Cloud wearables"},{"$id":"(ovok)/wearables/index.mdx","type":"page","name":"Cloud wearables","description":"Let patients connect their Oura, WHOOP, Strava, Withings, Polar, Ultrahuman or Suunto accounts to your project and receive the readings as FHIR Observations.","icon":"$undefined","url":"/wearables","$ref":"(ovok)/wearables/index.mdx"},{"$id":"(ovok)/wearables/set-up-providers.mdx","type":"page","name":"Set up providers","description":"Register an OAuth app at Oura, WHOOP, Strava, Withings, Polar, Suunto or Ultrahuman, then save it in the Ovok Console or through the API so your patients can connect.","icon":"$undefined","url":"/wearables/set-up-providers","$ref":"(ovok)/wearables/set-up-providers.mdx"},{"$id":"(ovok)/wearables/connect-a-patient.mdx","type":"page","name":"Connect a patient","description":"Send a signed-in patient through the provider's consent page and back to your app, with @ovok/core, React hooks or plain HTTP.","icon":"$undefined","url":"/wearables/connect-a-patient","$ref":"(ovok)/wearables/connect-a-patient.mdx"},{"$id":"(ovok)/wearables/sync-and-read-data.mdx","type":"page","name":"Sync and read the data","description":"When wearable data reaches your project, what each provider syncs, what the Observations look like, and how to query them apart from device readings.","icon":"$undefined","url":"/wearables/sync-and-read-data","$ref":"(ovok)/wearables/sync-and-read-data.mdx"},{"$id":"(ovok)/wearables/api-reference.mdx","type":"page","name":"API reference","description":"Every cloud wearables route in full, with its caller, parameters, request, answer, status codes, side effects and per-provider behaviour.","icon":"$undefined","url":"/wearables/api-reference","$ref":"(ovok)/wearables/api-reference.mdx"},{"$id":"_30","type":"separator","icon":"$undefined","name":"Email templates"},{"$id":"(ovok)/email-templates/index.mdx","type":"page","name":"Email templates","description":"Choose which email template Ovok sends for each message in your project, with Brevo, SendGrid, Resend or SMTP, and manage the mapping through the API.","icon":"$undefined","url":"/email-templates","$ref":"(ovok)/email-templates/index.mdx"},{"$id":"(ovok)/email-templates/set-up-email.mdx","type":"page","name":"Set up email sending","description":"Take a project from no email to a mapped, ready template for each provider, then add languages and domains.","icon":"$undefined","url":"/email-templates/set-up-email","$ref":"(ovok)/email-templates/set-up-email.mdx"},{"$id":"(ovok)/email-templates/template-catalogue.mdx","type":"page","name":"Template catalogue","description":"Every email Ovok can send, who receives it, when it is sent, which parameters it carries, and how each provider writes a parameter.","icon":"$undefined","url":"/email-templates/template-catalogue","$ref":"(ovok)/email-templates/template-catalogue.mdx"},{"$id":"(ovok)/email-templates/map-templates.mdx","type":"page","name":"Map templates with the API","description":"List, read, create, replace and remove email template mappings with /v1/projects/me/email-templates, with every error and the cases that surprise people.","icon":"$undefined","url":"/email-templates/map-templates","$ref":"(ovok)/email-templates/map-templates.mdx"},{"$id":"(ovok)/email-templates/troubleshooting.mdx","type":"page","name":"Troubleshooting","description":"Why an Ovok email was not sent or looks wrong, and what to check in the template mapping and the project settings.","icon":"$undefined","url":"/email-templates/troubleshooting","$ref":"(ovok)/email-templates/troubleshooting.mdx"},{"$id":"_31","type":"separator","icon":"$undefined","name":"CMS"},{"$id":"(ovok)/cms/index.mdx","type":"page","name":"CMS","description":"Store legal pages, UI translations, release notes and your own content in the Ovok CMS, and read it from your apps with the public delivery API.","icon":"$undefined","url":"/cms","$ref":"(ovok)/cms/index.mdx"},{"$id":"(ovok)/cms/list-collection-items.mdx","type":"page","name":"List collection items","description":"Read the published documents of a CMS collection, in one language, one page at a time, with your content and Ovok's shared content merged.","icon":"$undefined","url":"/cms/list-collection-items","$ref":"(ovok)/cms/list-collection-items.mdx"},{"$id":"(ovok)/cms/get-collection-item.mdx","type":"page","name":"Get an item by slug","description":"Read one published document of a CMS collection by its slug, with a fallback to Ovok's shared content.","icon":"$undefined","url":"/cms/get-collection-item","$ref":"(ovok)/cms/get-collection-item.mdx"},{"$id":"(ovok)/cms/list-content-type-items.mdx","type":"page","name":"List content type items","description":"Read the published items of a content type you defined yourself, up to 100 at a time, with a CMS API key or a signed-in session.","icon":"$undefined","url":"/cms/list-content-type-items","$ref":"(ovok)/cms/list-content-type-items.mdx"},{"$id":"(ovok)/cms/use-ovok-cms-with-i18n.mdx","type":"page","name":"Use Ovok CMS with i18n","description":"Keep your app's UI text in the Ovok CMS and load it into i18next on the web and on mobile, with per-string fallback and a clear precedence.","icon":"$undefined","url":"/cms/use-ovok-cms-with-i18n","$ref":"(ovok)/cms/use-ovok-cms-with-i18n.mdx"},{"$id":"_32","type":"separator","icon":"$undefined","name":"Video Calls"},{"$id":"(ovok)/video-calls/index.mdx","type":"page","name":"Video calls","description":"Schedule video-call appointments, notify participants, and issue LiveKit join access with Ovok.","icon":"$undefined","url":"/video-calls","$ref":"(ovok)/video-calls/index.mdx"},{"$id":"(ovok)/video-calls/appointments.mdx","type":"page","name":"Appointments","description":"Create, update, and list video-call FHIR Appointments in Ovok.","icon":"$undefined","url":"/video-calls/appointments","$ref":"(ovok)/video-calls/appointments.mdx"},{"$id":"(ovok)/video-calls/join-access.mdx","type":"page","name":"Join access","description":"Request LiveKit join credentials for guests, Practitioners, and Patients.","icon":"$undefined","url":"/video-calls/join-access","$ref":"(ovok)/video-calls/join-access.mdx"},{"$id":"(ovok)/video-calls/notifications-and-email.mdx","type":"page","name":"Notifications and email","description":"Grant participant access, queue active-call notifications, and send video-call emails.","icon":"$undefined","url":"/video-calls/notifications-and-email","$ref":"(ovok)/video-calls/notifications-and-email.mdx"},{"$id":"_33","type":"separator","icon":"$undefined","name":"Ovok primitives"},{"$id":"(ovok)/primitives/index.mdx","type":"page","name":"Ovok primitives","description":"Core platform routes and FHIR operations available in Ovok.","icon":"$undefined","url":"/primitives","$ref":"(ovok)/primitives/index.mdx"},{"$id":"(ovok)/primitives/health-and-discovery.mdx","type":"page","name":"Health and discovery","description":"Check Ovok API availability and discover OAuth, SMART, FHIR, and server capabilities.","icon":"$undefined","url":"/primitives/health-and-discovery","$ref":"(ovok)/primitives/health-and-discovery.mdx"},{"$id":"(ovok)/primitives/last-observations.mdx","type":"page","name":"Get last observations","description":"Retrieve recent FHIR Observation resources with the Ovok last-observations operation.","icon":"$undefined","url":"/primitives/last-observations","$ref":"(ovok)/primitives/last-observations.mdx"},{"$id":"(ovok)/primitives/populate-questionnaire.mdx","type":"page","name":"Populate a Questionnaire","description":"Pre-populate a FHIR QuestionnaireResponse with patient, observation, and supplied context data.","icon":"$undefined","url":"/primitives/populate-questionnaire","$ref":"(ovok)/primitives/populate-questionnaire.mdx"},{"$id":"(ovok)/primitives/extract-observations.mdx","type":"page","name":"Extract observations","description":"Generate FHIR Observation resources from a saved QuestionnaireResponse.","icon":"$undefined","url":"/primitives/extract-observations","$ref":"(ovok)/primitives/extract-observations.mdx"},{"$id":"(ovok)/primitives/expand-valueset.mdx","type":"page","name":"Expand a ValueSet","description":"Expand a FHIR ValueSet into the codes available for selection or validation.","icon":"$undefined","url":"/primitives/expand-valueset","$ref":"(ovok)/primitives/expand-valueset.mdx"},{"$id":"(ovok)/primitives/validate-valueset-code.mdx","type":"page","name":"Validate ValueSet code","description":"Check whether a code or Coding belongs to a FHIR ValueSet.","icon":"$undefined","url":"/primitives/validate-valueset-code","$ref":"(ovok)/primitives/validate-valueset-code.mdx"},{"$id":"(ovok)/primitives/lookup-codesystem.mdx","type":"page","name":"Look up a CodeSystem concept","description":"Retrieve display, designation, and property details for a CodeSystem concept.","icon":"$undefined","url":"/primitives/lookup-codesystem","$ref":"(ovok)/primitives/lookup-codesystem.mdx"},{"$id":"(ovok)/primitives/validate-codesystem-code.mdx","type":"page","name":"Validate CodeSystem code","description":"Check whether a code exists in a FHIR CodeSystem and whether its display is correct.","icon":"$undefined","url":"/primitives/validate-codesystem-code","$ref":"(ovok)/primitives/validate-codesystem-code.mdx"},{"$id":"(ovok)/primitives/subsumes-codesystem.mdx","type":"page","name":"Test CodeSystem subsumption","description":"Determine the hierarchy relationship between two codes in a CodeSystem.","icon":"$undefined","url":"/primitives/subsumes-codesystem","$ref":"(ovok)/primitives/subsumes-codesystem.mdx"},{"$id":"(ovok)/primitives/import-codesystem.mdx","type":"page","name":"Import a CodeSystem","description":"Add concepts, properties, and designations to a CodeSystem through the Ovok import operation.","icon":"$undefined","url":"/primitives/import-codesystem","$ref":"(ovok)/primitives/import-codesystem.mdx"},{"$id":"(ovok)/primitives/translate-concept.mdx","type":"page","name":"Translate a concept","description":"Translate a coded concept between code systems or value sets using a ConceptMap.","icon":"$undefined","url":"/primitives/translate-concept","$ref":"(ovok)/primitives/translate-concept.mdx"},{"$id":"(ovok)/primitives/validate-resource.mdx","type":"page","name":"Validate a resource","description":"Validate a FHIR resource against the server's supported profiles and rules.","icon":"$undefined","url":"/primitives/validate-resource","$ref":"(ovok)/primitives/validate-resource.mdx"},{"$id":"(ovok)/primitives/expunge-resource.mdx","type":"page","name":"Expunge a resource","description":"Permanently remove a resource and its history from an Ovok project.","icon":"$undefined","url":"/primitives/expunge-resource","$ref":"(ovok)/primitives/expunge-resource.mdx"},{"$id":"(ovok)/primitives/export-csv.mdx","type":"page","name":"Export a resource type as CSV","description":"Export matching FHIR resources as a CSV file.","icon":"$undefined","url":"/primitives/export-csv","$ref":"(ovok)/primitives/export-csv.mdx"},{"$id":"(ovok)/primitives/reindex-resource.mdx","type":"page","name":"Reindex a resource","description":"Rebuild the search index entries for one FHIR resource.","icon":"$undefined","url":"/primitives/reindex-resource","$ref":"(ovok)/primitives/reindex-resource.mdx"},{"$id":"(ovok)/primitives/resource-graph.mdx","type":"page","name":"Get a resource graph","description":"Follow a GraphDefinition from a resource and return related resources in a Bundle.","icon":"$undefined","url":"/primitives/resource-graph","$ref":"(ovok)/primitives/resource-graph.mdx"},{"$id":"(ovok)/primitives/patient-everything.mdx","type":"page","name":"Get everything for a Patient","description":"Retrieve Patient compartment resources and resolved references in a searchset Bundle.","icon":"$undefined","url":"/primitives/patient-everything","$ref":"(ovok)/primitives/patient-everything.mdx"},{"$id":"(ovok)/primitives/enable-signals-patient.mdx","type":"page","name":"Enable Signals for a Patient","description":"Enroll an existing Ovok Patient in Signals with POST /fhir/R4/Patient/:id/$enable-signals.","icon":"$undefined","url":"/primitives/enable-signals-patient","$ref":"(ovok)/primitives/enable-signals-patient.mdx"},{"$id":"(ovok)/primitives/set-accounts-patient.mdx","type":"page","name":"Set accounts for a Patient","description":"Update Account references on a Patient and optionally propagate changes through its compartment.","icon":"$undefined","url":"/primitives/set-accounts-patient","$ref":"(ovok)/primitives/set-accounts-patient.mdx"},{"$id":"(ovok)/primitives/set-accounts-resource.mdx","type":"page","name":"Set accounts for a resource","description":"Set Account references on an individual FHIR resource.","icon":"$undefined","url":"/primitives/set-accounts-resource","$ref":"(ovok)/primitives/set-accounts-resource.mdx"},{"$id":"(ovok)/primitives/resend-resource.mdx","type":"page","name":"Resend a resource","description":"Replay subscription delivery for a stored FHIR resource.","icon":"$undefined","url":"/primitives/resend-resource","$ref":"(ovok)/primitives/resend-resource.mdx"},{"$id":"(ovok)/primitives/merge-resources-by-type.mdx","type":"page","name":"Merge resources by type","description":"Route reference and current contract status for the resource-type merge operation.","icon":"$undefined","url":"/primitives/merge-resources-by-type","$ref":"(ovok)/primitives/merge-resources-by-type.mdx"},{"$id":"(ovok)/primitives/merge-resource-by-id.mdx","type":"page","name":"Merge a resource by id","description":"Route reference and current contract status for the instance-level merge operation.","icon":"$undefined","url":"/primitives/merge-resource-by-id","$ref":"(ovok)/primitives/merge-resource-by-id.mdx"},{"$id":"(ovok)/primitives/execute-bot-by-id.mdx","type":"page","name":"Execute a Bot by id","description":"Run a stored Bot using its FHIR resource ID.","icon":"$undefined","url":"/primitives/execute-bot-by-id","$ref":"(ovok)/primitives/execute-bot-by-id.mdx"},{"$id":"(ovok)/primitives/deploy-bot.mdx","type":"page","name":"Deploy a Bot","description":"Deploy code for a stored Bot resource.","icon":"$undefined","url":"/primitives/deploy-bot","$ref":"(ovok)/primitives/deploy-bot.mdx"},{"$id":"(ovok)/primitives/execute-bot-by-identifier.mdx","type":"page","name":"Execute a Bot by identifier","description":"Run a Bot selected by its FHIR identifier.","icon":"$undefined","url":"/primitives/execute-bot-by-identifier","$ref":"(ovok)/primitives/execute-bot-by-identifier.mdx"},{"$id":"(ovok)/primitives/clone-project.mdx","type":"page","name":"Clone a Project","description":"Create a Project by cloning selected resources from an existing Project.","icon":"$undefined","url":"/primitives/clone-project","$ref":"(ovok)/primitives/clone-project.mdx"},{"$id":"(ovok)/primitives/apply-plan-definition.mdx","type":"page","name":"Apply a PlanDefinition","description":"Apply a FHIR PlanDefinition for a subject and create care-planning resources.","icon":"$undefined","url":"/primitives/apply-plan-definition","$ref":"(ovok)/primitives/apply-plan-definition.mdx"},{"$id":"(ovok)/primitives/apply-activity-definition.mdx","type":"page","name":"Apply an ActivityDefinition","description":"Apply a FHIR ActivityDefinition to a subject and create its defined activity resource.","icon":"$undefined","url":"/primitives/apply-activity-definition","$ref":"(ovok)/primitives/apply-activity-definition.mdx"},{"$id":"(ovok)/primitives/export-system-data.mdx","type":"page","name":"Export system data","description":"Start an asynchronous bulk export of the FHIR resources available in the current Ovok project.","icon":"$undefined","url":"/primitives/export-system-data","$ref":"(ovok)/primitives/export-system-data.mdx"},{"$id":"(ovok)/primitives/export-patient-data.mdx","type":"page","name":"Export Patient data","description":"Start an asynchronous bulk export of Patient resources and supported Patient-compartment data.","icon":"$undefined","url":"/primitives/export-patient-data","$ref":"(ovok)/primitives/export-patient-data.mdx"},{"$id":"(ovok)/primitives/export-group-data.mdx","type":"page","name":"Export Group data","description":"Start a bulk export for the resources associated with members of a FHIR Group.","icon":"$undefined","url":"/primitives/export-group-data","$ref":"(ovok)/primitives/export-group-data.mdx"},{"$id":"(ovok)/primitives/check-bulk-export-status.mdx","type":"page","name":"Check bulk export status","description":"Poll an export status URL and retrieve the completed Bulk Data manifest.","icon":"$undefined","url":"/primitives/check-bulk-export-status","$ref":"(ovok)/primitives/check-bulk-export-status.mdx"},{"$id":"(ovok)/primitives/import-data.mdx","type":"page","name":"Import data","description":"Route reference and support status for the listed bulk data import endpoint.","icon":"$undefined","url":"/primitives/import-data","$ref":"(ovok)/primitives/import-data.mdx"},{"$id":"(ovok)/primitives/check-async-job-status.mdx","type":"page","name":"Check asynchronous job status","description":"Read the status of a FHIR AsyncJob created by an asynchronous Ovok operation.","icon":"$undefined","url":"/primitives/check-async-job-status","$ref":"(ovok)/primitives/check-async-job-status.mdx"},{"$id":"_34","type":"separator","icon":"$undefined","name":"Slim APIs"},{"$id":"(ovok)/slim-apis/index.mdx","type":"page","name":"Slim APIs","description":"Reference for Ovok Slim API operations, organized by workflow.","icon":"$undefined","url":"/slim-apis","$ref":"(ovok)/slim-apis/index.mdx"},{"type":"folder","name":"Health","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/health/get-health-status.mdx","type":"page","name":"Get health status","description":"Get health status using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/health/get-health-status","$ref":"(ovok)/slim-apis/health/get-health-status.mdx"}],"$id":"(ovok)/slim-apis/health","$ref":{"folder":"(ovok)/slim-apis/health","meta":"(ovok)/slim-apis/health/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Patients","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/patient/check-patient-name-exists.mdx","type":"page","name":"Check patient name exists","description":"Check patient name exists using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/patient/check-patient-name-exists","$ref":"(ovok)/slim-apis/patient/check-patient-name-exists.mdx"},{"$id":"(ovok)/slim-apis/patient/create-patient.mdx","type":"page","name":"Create patient","description":"Create patient using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/patient/create-patient","$ref":"(ovok)/slim-apis/patient/create-patient.mdx"},{"$id":"(ovok)/slim-apis/patient/delete-patient.mdx","type":"page","name":"Delete patient","description":"Delete patient using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/patient/delete-patient","$ref":"(ovok)/slim-apis/patient/delete-patient.mdx"},{"$id":"(ovok)/slim-apis/patient/get-patient.mdx","type":"page","name":"Get patient","description":"Get patient using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/patient/get-patient","$ref":"(ovok)/slim-apis/patient/get-patient.mdx"},{"$id":"(ovok)/slim-apis/patient/get-patient-everything.mdx","type":"page","name":"Get patient $everything","description":"Get patient $everything using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/patient/get-patient-everything","$ref":"(ovok)/slim-apis/patient/get-patient-everything.mdx"},{"$id":"(ovok)/slim-apis/patient/get-patient-current-vitals.mdx","type":"page","name":"Get patient current vitals","description":"Get patient current vitals using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/patient/get-patient-current-vitals","$ref":"(ovok)/slim-apis/patient/get-patient-current-vitals.mdx"},{"$id":"(ovok)/slim-apis/patient/list-patients.mdx","type":"page","name":"List patients","description":"List patients using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/patient/list-patients","$ref":"(ovok)/slim-apis/patient/list-patients.mdx"},{"$id":"(ovok)/slim-apis/patient/update-patient.mdx","type":"page","name":"Update patient","description":"Update patient using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/patient/update-patient","$ref":"(ovok)/slim-apis/patient/update-patient.mdx"}],"$id":"(ovok)/slim-apis/patient","$ref":{"folder":"(ovok)/slim-apis/patient","meta":"(ovok)/slim-apis/patient/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Devices","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/device/create-device.mdx","type":"page","name":"Create device","description":"Create device using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/device/create-device","$ref":"(ovok)/slim-apis/device/create-device.mdx"},{"$id":"(ovok)/slim-apis/device/delete-device.mdx","type":"page","name":"Delete device","description":"Delete device using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/device/delete-device","$ref":"(ovok)/slim-apis/device/delete-device.mdx"},{"$id":"(ovok)/slim-apis/device/get-device.mdx","type":"page","name":"Get device","description":"Get device using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/device/get-device","$ref":"(ovok)/slim-apis/device/get-device.mdx"},{"$id":"(ovok)/slim-apis/device/list-devices.mdx","type":"page","name":"List devices","description":"List devices using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/device/list-devices","$ref":"(ovok)/slim-apis/device/list-devices.mdx"},{"$id":"(ovok)/slim-apis/device/list-live-device-rows.mdx","type":"page","name":"List live device rows","description":"List live device rows using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/device/list-live-device-rows","$ref":"(ovok)/slim-apis/device/list-live-device-rows.mdx"},{"$id":"(ovok)/slim-apis/device/list-live-telemetry-and-alerts-by-device.mdx","type":"page","name":"List live telemetry and alerts by device","description":"List live telemetry and alerts by device using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/device/list-live-telemetry-and-alerts-by-device","$ref":"(ovok)/slim-apis/device/list-live-telemetry-and-alerts-by-device.mdx"},{"$id":"(ovok)/slim-apis/device/list-projects-for-device-assignment.mdx","type":"page","name":"List projects for device assignment","description":"List projects for device assignment using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/device/list-projects-for-device-assignment","$ref":"(ovok)/slim-apis/device/list-projects-for-device-assignment.mdx"},{"$id":"(ovok)/slim-apis/device/move-device-to-another-project.mdx","type":"page","name":"Move device to another project","description":"Move device to another project using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/device/move-device-to-another-project","$ref":"(ovok)/slim-apis/device/move-device-to-another-project.mdx"},{"$id":"(ovok)/slim-apis/device/resolve-how-ingest-routes-device-serials.mdx","type":"page","name":"Resolve how ingest routes device serials","description":"Resolve how ingest routes device serials using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/device/resolve-how-ingest-routes-device-serials","$ref":"(ovok)/slim-apis/device/resolve-how-ingest-routes-device-serials.mdx"},{"$id":"(ovok)/slim-apis/device/update-device.mdx","type":"page","name":"Update device","description":"Update device using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/device/update-device","$ref":"(ovok)/slim-apis/device/update-device.mdx"}],"$id":"(ovok)/slim-apis/device","$ref":{"folder":"(ovok)/slim-apis/device","meta":"(ovok)/slim-apis/device/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Locations","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/location/create-location.mdx","type":"page","name":"Create location","description":"Create location using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/location/create-location","$ref":"(ovok)/slim-apis/location/create-location.mdx"},{"$id":"(ovok)/slim-apis/location/create-location-in-a-project-admin.mdx","type":"page","name":"Create location in a project (admin)","description":"Create location in a project (admin) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/location/create-location-in-a-project-admin","$ref":"(ovok)/slim-apis/location/create-location-in-a-project-admin.mdx"},{"$id":"(ovok)/slim-apis/location/delete-location.mdx","type":"page","name":"Delete location","description":"Delete location using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/location/delete-location","$ref":"(ovok)/slim-apis/location/delete-location.mdx"},{"$id":"(ovok)/slim-apis/location/get-location.mdx","type":"page","name":"Get location","description":"Get location using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/location/get-location","$ref":"(ovok)/slim-apis/location/get-location.mdx"},{"$id":"(ovok)/slim-apis/location/list-location-assignment-candidates.mdx","type":"page","name":"List location assignment candidates","description":"List location assignment candidates using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/location/list-location-assignment-candidates","$ref":"(ovok)/slim-apis/location/list-location-assignment-candidates.mdx"},{"$id":"(ovok)/slim-apis/location/list-locations.mdx","type":"page","name":"List locations","description":"List locations using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/location/list-locations","$ref":"(ovok)/slim-apis/location/list-locations.mdx"},{"$id":"(ovok)/slim-apis/location/list-locations-in-a-project-admin.mdx","type":"page","name":"List locations in a project (admin)","description":"List locations in a project (admin) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/location/list-locations-in-a-project-admin","$ref":"(ovok)/slim-apis/location/list-locations-in-a-project-admin.mdx"},{"$id":"(ovok)/slim-apis/location/update-location.mdx","type":"page","name":"Update location","description":"Update location using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/location/update-location","$ref":"(ovok)/slim-apis/location/update-location.mdx"}],"$id":"(ovok)/slim-apis/location","$ref":{"folder":"(ovok)/slim-apis/location","meta":"(ovok)/slim-apis/location/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Zones","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/zones/create-location-in-zone.mdx","type":"page","name":"Create location in zone","description":"Create location in zone using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/zones/create-location-in-zone","$ref":"(ovok)/slim-apis/zones/create-location-in-zone.mdx"},{"$id":"(ovok)/slim-apis/zones/delete-location-in-zone.mdx","type":"page","name":"Delete location in zone","description":"Delete location in zone using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/zones/delete-location-in-zone","$ref":"(ovok)/slim-apis/zones/delete-location-in-zone.mdx"},{"$id":"(ovok)/slim-apis/zones/get-zone-detail.mdx","type":"page","name":"Get zone detail","description":"Get zone detail using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/zones/get-zone-detail","$ref":"(ovok)/slim-apis/zones/get-zone-detail.mdx"},{"$id":"(ovok)/slim-apis/zones/get-zone-device-counts.mdx","type":"page","name":"Get zone device counts","description":"Get zone device counts using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/zones/get-zone-device-counts","$ref":"(ovok)/slim-apis/zones/get-zone-device-counts.mdx"},{"$id":"(ovok)/slim-apis/zones/list-zones.mdx","type":"page","name":"List zones","description":"List zones using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/zones/list-zones","$ref":"(ovok)/slim-apis/zones/list-zones.mdx"},{"$id":"(ovok)/slim-apis/zones/update-location-in-zone.mdx","type":"page","name":"Update location in zone","description":"Update location in zone using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/zones/update-location-in-zone","$ref":"(ovok)/slim-apis/zones/update-location-in-zone.mdx"}],"$id":"(ovok)/slim-apis/zones","$ref":{"folder":"(ovok)/slim-apis/zones","meta":"(ovok)/slim-apis/zones/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Organizations","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/organization/create-organization.mdx","type":"page","name":"Create organization","description":"Create organization using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/organization/create-organization","$ref":"(ovok)/slim-apis/organization/create-organization.mdx"},{"$id":"(ovok)/slim-apis/organization/delete-organization.mdx","type":"page","name":"Delete organization","description":"Delete organization using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/organization/delete-organization","$ref":"(ovok)/slim-apis/organization/delete-organization.mdx"},{"$id":"(ovok)/slim-apis/organization/get-organization.mdx","type":"page","name":"Get organization","description":"Get organization using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/organization/get-organization","$ref":"(ovok)/slim-apis/organization/get-organization.mdx"},{"$id":"(ovok)/slim-apis/organization/update-organization.mdx","type":"page","name":"Update organization","description":"Update organization using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/organization/update-organization","$ref":"(ovok)/slim-apis/organization/update-organization.mdx"}],"$id":"(ovok)/slim-apis/organization","$ref":{"folder":"(ovok)/slim-apis/organization","meta":"(ovok)/slim-apis/organization/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Projects","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/project/create-a-child-project.mdx","type":"page","name":"Create a child project","description":"Create a child project using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/project/create-a-child-project","$ref":"(ovok)/slim-apis/project/create-a-child-project.mdx"},{"$id":"(ovok)/slim-apis/project/delete-a-child-project.mdx","type":"page","name":"Delete a child project","description":"Delete a child project using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/project/delete-a-child-project","$ref":"(ovok)/slim-apis/project/delete-a-child-project.mdx"},{"$id":"(ovok)/slim-apis/project/get-a-project.mdx","type":"page","name":"Get a project","description":"Get a project using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/project/get-a-project","$ref":"(ovok)/slim-apis/project/get-a-project.mdx"},{"$id":"(ovok)/slim-apis/project/get-project-device-counts.mdx","type":"page","name":"Get project device counts","description":"Get project device counts using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/project/get-project-device-counts","$ref":"(ovok)/slim-apis/project/get-project-device-counts.mdx"},{"$id":"(ovok)/slim-apis/project/get-project-patient-counts.mdx","type":"page","name":"Get project patient counts","description":"Get project patient counts using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/project/get-project-patient-counts","$ref":"(ovok)/slim-apis/project/get-project-patient-counts.mdx"},{"$id":"(ovok)/slim-apis/project/list-child-project-relationships.mdx","type":"page","name":"List child project relationships","description":"List child project relationships using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/project/list-child-project-relationships","$ref":"(ovok)/slim-apis/project/list-child-project-relationships.mdx"},{"$id":"(ovok)/slim-apis/project/list-child-projects-with-device-counts.mdx","type":"page","name":"List child projects with device counts","description":"List child projects with device counts using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/project/list-child-projects-with-device-counts","$ref":"(ovok)/slim-apis/project/list-child-projects-with-device-counts.mdx"},{"$id":"(ovok)/slim-apis/project/list-current-project-users.mdx","type":"page","name":"List current project users","description":"List current project users using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/project/list-current-project-users","$ref":"(ovok)/slim-apis/project/list-current-project-users.mdx"},{"$id":"(ovok)/slim-apis/project/list-project-users.mdx","type":"page","name":"List project users","description":"List project users using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/project/list-project-users","$ref":"(ovok)/slim-apis/project/list-project-users.mdx"},{"$id":"(ovok)/slim-apis/project/update-a-project.mdx","type":"page","name":"Update a project","description":"Update a project using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/project/update-a-project","$ref":"(ovok)/slim-apis/project/update-a-project.mdx"}],"$id":"(ovok)/slim-apis/project","$ref":{"folder":"(ovok)/slim-apis/project","meta":"(ovok)/slim-apis/project/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Access policies","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/policy/create-access-policy.mdx","type":"page","name":"Create access policy","description":"Create access policy using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/policy/create-access-policy","$ref":"(ovok)/slim-apis/policy/create-access-policy.mdx"},{"$id":"(ovok)/slim-apis/policy/delete-access-policy.mdx","type":"page","name":"Delete access policy","description":"Delete access policy using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/policy/delete-access-policy","$ref":"(ovok)/slim-apis/policy/delete-access-policy.mdx"},{"$id":"(ovok)/slim-apis/policy/get-access-policy.mdx","type":"page","name":"Get access policy","description":"Get access policy using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/policy/get-access-policy","$ref":"(ovok)/slim-apis/policy/get-access-policy.mdx"},{"$id":"(ovok)/slim-apis/policy/list-access-policies.mdx","type":"page","name":"List access policies","description":"List access policies using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/policy/list-access-policies","$ref":"(ovok)/slim-apis/policy/list-access-policies.mdx"},{"$id":"(ovok)/slim-apis/policy/update-access-policy.mdx","type":"page","name":"Update access policy","description":"Update access policy using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/policy/update-access-policy","$ref":"(ovok)/slim-apis/policy/update-access-policy.mdx"}],"$id":"(ovok)/slim-apis/policy","$ref":{"folder":"(ovok)/slim-apis/policy","meta":"(ovok)/slim-apis/policy/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Practitioners","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/practitioner/get-practitioner.mdx","type":"page","name":"Get practitioner","description":"Get practitioner using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/practitioner/get-practitioner","$ref":"(ovok)/slim-apis/practitioner/get-practitioner.mdx"},{"$id":"(ovok)/slim-apis/practitioner/update-practitioner.mdx","type":"page","name":"Update practitioner","description":"Update practitioner using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/practitioner/update-practitioner","$ref":"(ovok)/slim-apis/practitioner/update-practitioner.mdx"}],"$id":"(ovok)/slim-apis/practitioner","$ref":{"folder":"(ovok)/slim-apis/practitioner","meta":"(ovok)/slim-apis/practitioner/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Invitations","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/invite/invite-practitioner.mdx","type":"page","name":"Invite practitioner","description":"Invite practitioner using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/invite/invite-practitioner","$ref":"(ovok)/slim-apis/invite/invite-practitioner.mdx"}],"$id":"(ovok)/slim-apis/invite","$ref":{"folder":"(ovok)/slim-apis/invite","meta":"(ovok)/slim-apis/invite/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Notifications","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/notifications/a-medical-notifications-notes.mdx","type":"page","name":"A medical notification's notes","description":"A medical notification's notes using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/a-medical-notifications-notes","$ref":"(ovok)/slim-apis/notifications/a-medical-notifications-notes.mdx"},{"$id":"(ovok)/slim-apis/notifications/a-raw-signals-alerts-notes.mdx","type":"page","name":"A raw Signals alert's notes","description":"A raw Signals alert's notes using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/a-raw-signals-alerts-notes","$ref":"(ovok)/slim-apis/notifications/a-raw-signals-alerts-notes.mdx"},{"$id":"(ovok)/slim-apis/notifications/acknowledge-medical-notification.mdx","type":"page","name":"Acknowledge medical notification","description":"Acknowledge medical notification using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/acknowledge-medical-notification","$ref":"(ovok)/slim-apis/notifications/acknowledge-medical-notification.mdx"},{"$id":"(ovok)/slim-apis/notifications/acknowledge-notification.mdx","type":"page","name":"Acknowledge notification","description":"Acknowledge notification using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/acknowledge-notification","$ref":"(ovok)/slim-apis/notifications/acknowledge-notification.mdx"},{"$id":"(ovok)/slim-apis/notifications/an-alarm-notifications-notes.mdx","type":"page","name":"An alarm notification's notes","description":"An alarm notification's notes using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/an-alarm-notifications-notes","$ref":"(ovok)/slim-apis/notifications/an-alarm-notifications-notes.mdx"},{"$id":"(ovok)/slim-apis/notifications/an-out-of-bed-notifications-notes.mdx","type":"page","name":"An out-of-bed notification's notes","description":"An out-of-bed notification's notes using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/an-out-of-bed-notifications-notes","$ref":"(ovok)/slim-apis/notifications/an-out-of-bed-notifications-notes.mdx"},{"$id":"(ovok)/slim-apis/notifications/delete-a-note.mdx","type":"page","name":"Delete a note","description":"Delete a note using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/delete-a-note","$ref":"(ovok)/slim-apis/notifications/delete-a-note.mdx"},{"$id":"(ovok)/slim-apis/notifications/edit-a-notes-text.mdx","type":"page","name":"Edit a note's text","description":"Edit a note's text using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/edit-a-notes-text","$ref":"(ovok)/slim-apis/notifications/edit-a-notes-text.mdx"},{"$id":"(ovok)/slim-apis/notifications/get-medical-notification.mdx","type":"page","name":"Get medical notification","description":"Get medical notification using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/get-medical-notification","$ref":"(ovok)/slim-apis/notifications/get-medical-notification.mdx"},{"$id":"(ovok)/slim-apis/notifications/leave-a-note-on-a-notification.mdx","type":"page","name":"Leave a note on a notification","description":"Leave a note on a notification using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/leave-a-note-on-a-notification","$ref":"(ovok)/slim-apis/notifications/leave-a-note-on-a-notification.mdx"},{"$id":"(ovok)/slim-apis/notifications/list-alarm-notifications.mdx","type":"page","name":"List alarm notifications","description":"List alarm notifications using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/list-alarm-notifications","$ref":"(ovok)/slim-apis/notifications/list-alarm-notifications.mdx"},{"$id":"(ovok)/slim-apis/notifications/list-medical-notifications.mdx","type":"page","name":"List medical notifications","description":"List medical notifications using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/list-medical-notifications","$ref":"(ovok)/slim-apis/notifications/list-medical-notifications.mdx"},{"$id":"(ovok)/slim-apis/notifications/list-out-of-bed-notifications.mdx","type":"page","name":"List out-of-bed notifications","description":"List out-of-bed notifications using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/list-out-of-bed-notifications","$ref":"(ovok)/slim-apis/notifications/list-out-of-bed-notifications.mdx"},{"$id":"(ovok)/slim-apis/notifications/list-recent-alarm-notifications.mdx","type":"page","name":"List recent alarm notifications","description":"List recent alarm notifications using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/list-recent-alarm-notifications","$ref":"(ovok)/slim-apis/notifications/list-recent-alarm-notifications.mdx"},{"$id":"(ovok)/slim-apis/notifications/list-recent-medical-notifications.mdx","type":"page","name":"List recent medical notifications","description":"List recent medical notifications using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/list-recent-medical-notifications","$ref":"(ovok)/slim-apis/notifications/list-recent-medical-notifications.mdx"},{"$id":"(ovok)/slim-apis/notifications/list-recent-notifications.mdx","type":"page","name":"List recent notifications","description":"List recent notifications using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/list-recent-notifications","$ref":"(ovok)/slim-apis/notifications/list-recent-notifications.mdx"},{"$id":"(ovok)/slim-apis/notifications/list-recent-out-of-bed-notifications.mdx","type":"page","name":"List recent out-of-bed notifications","description":"List recent out-of-bed notifications using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/list-recent-out-of-bed-notifications","$ref":"(ovok)/slim-apis/notifications/list-recent-out-of-bed-notifications.mdx"},{"$id":"(ovok)/slim-apis/notifications/replace-a-notes-text.mdx","type":"page","name":"Replace a note's text","description":"Replace a note's text using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/notifications/replace-a-notes-text","$ref":"(ovok)/slim-apis/notifications/replace-a-notes-text.mdx"}],"$id":"(ovok)/slim-apis/notifications","$ref":{"folder":"(ovok)/slim-apis/notifications","meta":"(ovok)/slim-apis/notifications/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Thresholds","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/threshold/get-current-org-threshold-v2.mdx","type":"page","name":"Get current org threshold (v2)","description":"Get current org threshold (v2) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/get-current-org-threshold-v2","$ref":"(ovok)/slim-apis/threshold/get-current-org-threshold-v2.mdx"},{"$id":"(ovok)/slim-apis/threshold/get-current-threshold.mdx","type":"page","name":"Get current threshold","description":"Get current threshold using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/get-current-threshold","$ref":"(ovok)/slim-apis/threshold/get-current-threshold.mdx"},{"$id":"(ovok)/slim-apis/threshold/get-patient-effective-threshold.mdx","type":"page","name":"Get patient effective threshold","description":"Get patient effective threshold using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/get-patient-effective-threshold","$ref":"(ovok)/slim-apis/threshold/get-patient-effective-threshold.mdx"},{"$id":"(ovok)/slim-apis/threshold/get-patient-effective-threshold-v2.mdx","type":"page","name":"Get patient effective threshold (v2)","description":"Get patient effective threshold (v2) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/get-patient-effective-threshold-v2","$ref":"(ovok)/slim-apis/threshold/get-patient-effective-threshold-v2.mdx"},{"$id":"(ovok)/slim-apis/threshold/get-patient-vital-thresholds.mdx","type":"page","name":"Get patient vital thresholds","description":"Get patient vital thresholds using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/get-patient-vital-thresholds","$ref":"(ovok)/slim-apis/threshold/get-patient-vital-thresholds.mdx"},{"$id":"(ovok)/slim-apis/threshold/remove-a-patient-vital-threshold.mdx","type":"page","name":"Remove a patient vital threshold","description":"Remove a patient vital threshold using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/remove-a-patient-vital-threshold","$ref":"(ovok)/slim-apis/threshold/remove-a-patient-vital-threshold.mdx"},{"$id":"(ovok)/slim-apis/threshold/set-a-patient-vital-threshold.mdx","type":"page","name":"Set a patient vital threshold","description":"Set a patient vital threshold using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/set-a-patient-vital-threshold","$ref":"(ovok)/slim-apis/threshold/set-a-patient-vital-threshold.mdx"},{"$id":"(ovok)/slim-apis/threshold/update-org-threshold-v2.mdx","type":"page","name":"Update org threshold (v2)","description":"Update org threshold (v2) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/update-org-threshold-v2","$ref":"(ovok)/slim-apis/threshold/update-org-threshold-v2.mdx"},{"$id":"(ovok)/slim-apis/threshold/update-patient-threshold.mdx","type":"page","name":"Update patient threshold","description":"Update patient threshold using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/update-patient-threshold","$ref":"(ovok)/slim-apis/threshold/update-patient-threshold.mdx"},{"$id":"(ovok)/slim-apis/threshold/update-patient-threshold-v2.mdx","type":"page","name":"Update patient threshold (v2)","description":"Update patient threshold (v2) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/update-patient-threshold-v2","$ref":"(ovok)/slim-apis/threshold/update-patient-threshold-v2.mdx"},{"$id":"(ovok)/slim-apis/threshold/update-threshold.mdx","type":"page","name":"Update threshold","description":"Update threshold using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/threshold/update-threshold","$ref":"(ovok)/slim-apis/threshold/update-threshold.mdx"}],"$id":"(ovok)/slim-apis/threshold","$ref":{"folder":"(ovok)/slim-apis/threshold","meta":"(ovok)/slim-apis/threshold/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Telemetry","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/telemetry/get-device-telemetry-and-alerts.mdx","type":"page","name":"Get device telemetry and alerts","description":"Get device telemetry and alerts using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/telemetry/get-device-telemetry-and-alerts","$ref":"(ovok)/slim-apis/telemetry/get-device-telemetry-and-alerts.mdx"},{"$id":"(ovok)/slim-apis/telemetry/get-effective-observation-ids-for-a-device.mdx","type":"page","name":"Get effective observation ids for a device","description":"Get effective observation ids for a device using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/telemetry/get-effective-observation-ids-for-a-device","$ref":"(ovok)/slim-apis/telemetry/get-effective-observation-ids-for-a-device.mdx"},{"$id":"(ovok)/slim-apis/telemetry/get-last-received-observation-ids-for-a-device.mdx","type":"page","name":"Get last-received observation ids for a device","description":"Get last-received observation ids for a device using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/telemetry/get-last-received-observation-ids-for-a-device","$ref":"(ovok)/slim-apis/telemetry/get-last-received-observation-ids-for-a-device.mdx"},{"$id":"(ovok)/slim-apis/telemetry/list-effective-observation-ids-by-device.mdx","type":"page","name":"List effective observation ids by device","description":"List effective observation ids by device using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/telemetry/list-effective-observation-ids-by-device","$ref":"(ovok)/slim-apis/telemetry/list-effective-observation-ids-by-device.mdx"},{"$id":"(ovok)/slim-apis/telemetry/list-last-received-observation-ids-by-device.mdx","type":"page","name":"List last-received observation ids by device","description":"List last-received observation ids by device using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/telemetry/list-last-received-observation-ids-by-device","$ref":"(ovok)/slim-apis/telemetry/list-last-received-observation-ids-by-device.mdx"}],"$id":"(ovok)/slim-apis/telemetry","$ref":{"folder":"(ovok)/slim-apis/telemetry","meta":"(ovok)/slim-apis/telemetry/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Trends","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/trends/get-realtime-trends-graphs.mdx","type":"page","name":"Get realtime trends graphs","description":"Get realtime trends graphs using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/trends/get-realtime-trends-graphs","$ref":"(ovok)/slim-apis/trends/get-realtime-trends-graphs.mdx"},{"$id":"(ovok)/slim-apis/trends/get-trends-graphs.mdx","type":"page","name":"Get trends graphs","description":"Get trends graphs using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/trends/get-trends-graphs","$ref":"(ovok)/slim-apis/trends/get-trends-graphs.mdx"}],"$id":"(ovok)/slim-apis/trends","$ref":{"folder":"(ovok)/slim-apis/trends","meta":"(ovok)/slim-apis/trends/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Sleep","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/sleep/get-sleep-statistics.mdx","type":"page","name":"Get sleep statistics","description":"Get sleep statistics using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/sleep/get-sleep-statistics","$ref":"(ovok)/slim-apis/sleep/get-sleep-statistics.mdx"}],"$id":"(ovok)/slim-apis/sleep","$ref":{"folder":"(ovok)/slim-apis/sleep","meta":"(ovok)/slim-apis/sleep/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Reports and exports","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/export/create-night-report-pdf.mdx","type":"page","name":"Create night report PDF","description":"Create night report PDF using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/export/create-night-report-pdf","$ref":"(ovok)/slim-apis/export/create-night-report-pdf.mdx"}],"$id":"(ovok)/slim-apis/export","$ref":{"folder":"(ovok)/slim-apis/export","meta":"(ovok)/slim-apis/export/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Queries","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/query/count-devices-per-zone-compatibility.mdx","type":"page","name":"Count devices per zone (compatibility)","description":"Count devices per zone (compatibility) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/query/count-devices-per-zone-compatibility","$ref":"(ovok)/slim-apis/query/count-devices-per-zone-compatibility.mdx"},{"$id":"(ovok)/slim-apis/query/get-resident-devices-with-telemetry-compatibility.mdx","type":"page","name":"Get resident devices with telemetry (compatibility)","description":"Get resident devices with telemetry (compatibility) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/query/get-resident-devices-with-telemetry-compatibility","$ref":"(ovok)/slim-apis/query/get-resident-devices-with-telemetry-compatibility.mdx"},{"$id":"(ovok)/slim-apis/query/list-devices-with-telemetry-compatibility.mdx","type":"page","name":"List devices with telemetry (compatibility)","description":"List devices with telemetry (compatibility) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/query/list-devices-with-telemetry-compatibility","$ref":"(ovok)/slim-apis/query/list-devices-with-telemetry-compatibility.mdx"},{"$id":"(ovok)/slim-apis/query/list-telemetry-and-alerts-compatibility.mdx","type":"page","name":"List telemetry and alerts (compatibility)","description":"List telemetry and alerts (compatibility) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/query/list-telemetry-and-alerts-compatibility","$ref":"(ovok)/slim-apis/query/list-telemetry-and-alerts-compatibility.mdx"},{"$id":"(ovok)/slim-apis/query/list-users-compatibility.mdx","type":"page","name":"List users (compatibility)","description":"List users (compatibility) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/query/list-users-compatibility","$ref":"(ovok)/slim-apis/query/list-users-compatibility.mdx"},{"$id":"(ovok)/slim-apis/query/list-users-across-projects-compatibility.mdx","type":"page","name":"List users across projects (compatibility)","description":"List users across projects (compatibility) using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/query/list-users-across-projects-compatibility","$ref":"(ovok)/slim-apis/query/list-users-across-projects-compatibility.mdx"}],"$id":"(ovok)/slim-apis/query","$ref":{"folder":"(ovok)/slim-apis/query","meta":"(ovok)/slim-apis/query/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Users","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/user/delete-user.mdx","type":"page","name":"Delete user","description":"Delete user using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/user/delete-user","$ref":"(ovok)/slim-apis/user/delete-user.mdx"},{"$id":"(ovok)/slim-apis/user/get-all-user-consents.mdx","type":"page","name":"Get all user consents","description":"Get all user consents using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/user/get-all-user-consents","$ref":"(ovok)/slim-apis/user/get-all-user-consents.mdx"},{"$id":"(ovok)/slim-apis/user/get-medical-settings-notifications-consent.mdx","type":"page","name":"Get medical settings notifications consent (deprecated)","description":"Deprecated. Get the medical settings notifications consent as a boolean. Use GET /v1/me/consent/medical instead.","icon":"$undefined","url":"/slim-apis/user/get-medical-settings-notifications-consent","$ref":"(ovok)/slim-apis/user/get-medical-settings-notifications-consent.mdx"},{"$id":"(ovok)/slim-apis/user/get-terms-and-conditions-consent.mdx","type":"page","name":"Get terms and conditions consent","description":"Get terms and conditions consent using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/user/get-terms-and-conditions-consent","$ref":"(ovok)/slim-apis/user/get-terms-and-conditions-consent.mdx"},{"$id":"(ovok)/slim-apis/user/send-support-message.mdx","type":"page","name":"Send support message","description":"Send support message using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/user/send-support-message","$ref":"(ovok)/slim-apis/user/send-support-message.mdx"},{"$id":"(ovok)/slim-apis/user/update-medical-settings-notifications-consent.mdx","type":"page","name":"Update medical settings notifications consent (deprecated)","description":"Deprecated. Give or withdraw the medical settings notifications consent. Use POST /v1/me/consent/medical instead.","icon":"$undefined","url":"/slim-apis/user/update-medical-settings-notifications-consent","$ref":"(ovok)/slim-apis/user/update-medical-settings-notifications-consent.mdx"},{"$id":"(ovok)/slim-apis/user/update-terms-and-conditions-consent.mdx","type":"page","name":"Update terms and conditions consent","description":"Update terms and conditions consent using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/user/update-terms-and-conditions-consent","$ref":"(ovok)/slim-apis/user/update-terms-and-conditions-consent.mdx"},{"$id":"(ovok)/slim-apis/user/update-user-consents.mdx","type":"page","name":"Update user consents","description":"Update user consents using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/user/update-user-consents","$ref":"(ovok)/slim-apis/user/update-user-consents.mdx"}],"$id":"(ovok)/slim-apis/user","$ref":{"folder":"(ovok)/slim-apis/user","meta":"(ovok)/slim-apis/user/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Audit","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/slim-apis/audit/list-change-history.mdx","type":"page","name":"List change history","description":"List change history using Ovok’s Slim API.","icon":"$undefined","url":"/slim-apis/audit/list-change-history","$ref":"(ovok)/slim-apis/audit/list-change-history.mdx"},{"$id":"(ovok)/slim-apis/audit/change-history-keys.mdx","type":"page","name":"Change history keys","description":"Keys and values returned by Ovok change history.","icon":"$undefined","url":"/slim-apis/audit/change-history-keys","$ref":"(ovok)/slim-apis/audit/change-history-keys.mdx"}],"$id":"(ovok)/slim-apis/audit","$ref":{"folder":"(ovok)/slim-apis/audit","meta":"(ovok)/slim-apis/audit/meta.json"},"icon":"$undefined"},{"$id":"_35","type":"separator","icon":"$undefined","name":"GraphQL"},{"$id":"(ovok)/graphql/index.mdx","type":"page","name":"GraphQL","description":"Explore the Ovok GraphQL schema, query FHIR resources, and understand the sandbox resource catalog.","icon":"$undefined","url":"/graphql","$ref":"(ovok)/graphql/index.mdx"},{"$id":"(ovok)/graphql/queries-and-pagination.mdx","type":"page","name":"Queries and pagination","description":"Read Ovok FHIR resources by ID, search lists, select fields, and inspect connection-shaped results.","icon":"$undefined","url":"/graphql/queries-and-pagination","$ref":"(ovok)/graphql/queries-and-pagination.mdx"},{"$id":"(ovok)/graphql/mutations.mdx","type":"page","name":"Mutations","description":"Use the mutation fields and input types exposed by the Ovok GraphQL schema.","icon":"$undefined","url":"/graphql/mutations","$ref":"(ovok)/graphql/mutations.mdx"},{"$id":"_36","type":"separator","icon":"$undefined","name":"FHIR resource catalogs"},{"$id":"(ovok)/graphql/fhir-resources-a-c.mdx","type":"page","name":"A-C","description":"GraphQL query fields, resource-specific search arguments, and mutations for FHIR R4 resources in the checked Ovok sandbox schema.","icon":"$undefined","url":"/graphql/fhir-resources-a-c","$ref":"(ovok)/graphql/fhir-resources-a-c.mdx"},{"$id":"(ovok)/graphql/fhir-resources-d-h.mdx","type":"page","name":"D-H","description":"GraphQL query fields, resource-specific search arguments, and mutations for FHIR R4 resources in the checked Ovok sandbox schema.","icon":"$undefined","url":"/graphql/fhir-resources-d-h","$ref":"(ovok)/graphql/fhir-resources-d-h.mdx"},{"$id":"(ovok)/graphql/fhir-resources-i-o.mdx","type":"page","name":"I-O","description":"GraphQL query fields, resource-specific search arguments, and mutations for FHIR R4 resources in the checked Ovok sandbox schema.","icon":"$undefined","url":"/graphql/fhir-resources-i-o","$ref":"(ovok)/graphql/fhir-resources-i-o.mdx"},{"$id":"(ovok)/graphql/fhir-resources-p-r.mdx","type":"page","name":"P-R","description":"GraphQL query fields, resource-specific search arguments, and mutations for FHIR R4 resources in the checked Ovok sandbox schema.","icon":"$undefined","url":"/graphql/fhir-resources-p-r","$ref":"(ovok)/graphql/fhir-resources-p-r.mdx"},{"$id":"(ovok)/graphql/fhir-resources-s-z.mdx","type":"page","name":"S-Z","description":"GraphQL query fields, resource-specific search arguments, and mutations for FHIR R4 resources in the checked Ovok sandbox schema.","icon":"$undefined","url":"/graphql/fhir-resources-s-z","$ref":"(ovok)/graphql/fhir-resources-s-z.mdx"},{"$id":"(ovok)/graphql/ovok-platform-resources.mdx","type":"page","name":"Ovok platform types","description":"Root GraphQL fields for non-FHIR platform types exposed in the inspected Ovok sandbox schema.","icon":"$undefined","url":"/graphql/ovok-platform-resources","$ref":"(ovok)/graphql/ovok-platform-resources.mdx"},{"$id":"_37","type":"separator","icon":"$undefined","name":"FHIR Elements"},{"$id":"(ovok)/fhir-elements/index.mdx","type":"page","name":"FHIR Elements","description":"FHIR R4 primitive and complex data type reference generated from the official HL7 package.","icon":"$undefined","url":"/fhir-elements","$ref":"(ovok)/fhir-elements/index.mdx"},{"type":"folder","name":"Primitive types","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/fhir-elements/primitive/base64-binary.mdx","type":"page","name":"base64Binary","description":"Base StructureDefinition for base64Binary Type: A stream of bytes","icon":"$undefined","url":"/fhir-elements/primitive/base64-binary","$ref":"(ovok)/fhir-elements/primitive/base64-binary.mdx"},{"$id":"(ovok)/fhir-elements/primitive/boolean.mdx","type":"page","name":"boolean","description":"Base StructureDefinition for boolean Type: Value of \"true\" or \"false\"","icon":"$undefined","url":"/fhir-elements/primitive/boolean","$ref":"(ovok)/fhir-elements/primitive/boolean.mdx"},{"$id":"(ovok)/fhir-elements/primitive/canonical.mdx","type":"page","name":"canonical","description":"Base StructureDefinition for canonical type: A URI that is a reference to a canonical URL on a FHIR resource","icon":"$undefined","url":"/fhir-elements/primitive/canonical","$ref":"(ovok)/fhir-elements/primitive/canonical.mdx"},{"$id":"(ovok)/fhir-elements/primitive/code.mdx","type":"page","name":"code","description":"Base StructureDefinition for code type: A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents","icon":"$undefined","url":"/fhir-elements/primitive/code","$ref":"(ovok)/fhir-elements/primitive/code.mdx"},{"$id":"(ovok)/fhir-elements/primitive/date-time.mdx","type":"page","name":"dateTime","description":"Base StructureDefinition for dateTime Type: A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and ","icon":"$undefined","url":"/fhir-elements/primitive/date-time","$ref":"(ovok)/fhir-elements/primitive/date-time.mdx"},{"$id":"(ovok)/fhir-elements/primitive/date.mdx","type":"page","name":"date","description":"Base StructureDefinition for date Type: A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.","icon":"$undefined","url":"/fhir-elements/primitive/date","$ref":"(ovok)/fhir-elements/primitive/date.mdx"},{"$id":"(ovok)/fhir-elements/primitive/decimal.mdx","type":"page","name":"decimal","description":"Base StructureDefinition for decimal Type: A rational number with implicit precision","icon":"$undefined","url":"/fhir-elements/primitive/decimal","$ref":"(ovok)/fhir-elements/primitive/decimal.mdx"},{"$id":"(ovok)/fhir-elements/primitive/id.mdx","type":"page","name":"id","description":"Base StructureDefinition for id type: Any combination of letters, numerals, \"-\" and \".\", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are c","icon":"$undefined","url":"/fhir-elements/primitive/id","$ref":"(ovok)/fhir-elements/primitive/id.mdx"},{"$id":"(ovok)/fhir-elements/primitive/instant.mdx","type":"page","name":"instant","description":"Base StructureDefinition for instant Type: An instant in time - known at least to the second","icon":"$undefined","url":"/fhir-elements/primitive/instant","$ref":"(ovok)/fhir-elements/primitive/instant.mdx"},{"$id":"(ovok)/fhir-elements/primitive/integer.mdx","type":"page","name":"integer","description":"Base StructureDefinition for integer Type: A whole number","icon":"$undefined","url":"/fhir-elements/primitive/integer","$ref":"(ovok)/fhir-elements/primitive/integer.mdx"},{"$id":"(ovok)/fhir-elements/primitive/markdown.mdx","type":"page","name":"markdown","description":"Base StructureDefinition for markdown type: A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine","icon":"$undefined","url":"/fhir-elements/primitive/markdown","$ref":"(ovok)/fhir-elements/primitive/markdown.mdx"},{"$id":"(ovok)/fhir-elements/primitive/oid.mdx","type":"page","name":"oid","description":"Base StructureDefinition for oid type: An OID represented as a URI","icon":"$undefined","url":"/fhir-elements/primitive/oid","$ref":"(ovok)/fhir-elements/primitive/oid.mdx"},{"$id":"(ovok)/fhir-elements/primitive/positive-int.mdx","type":"page","name":"positiveInt","description":"Base StructureDefinition for positiveInt type: An integer with a value that is positive (e.g. >0)","icon":"$undefined","url":"/fhir-elements/primitive/positive-int","$ref":"(ovok)/fhir-elements/primitive/positive-int.mdx"},{"$id":"(ovok)/fhir-elements/primitive/string.mdx","type":"page","name":"string","description":"Base StructureDefinition for string Type: A sequence of Unicode characters","icon":"$undefined","url":"/fhir-elements/primitive/string","$ref":"(ovok)/fhir-elements/primitive/string.mdx"},{"$id":"(ovok)/fhir-elements/primitive/time.mdx","type":"page","name":"time","description":"Base StructureDefinition for time Type: A time during the day, with no date specified","icon":"$undefined","url":"/fhir-elements/primitive/time","$ref":"(ovok)/fhir-elements/primitive/time.mdx"},{"$id":"(ovok)/fhir-elements/primitive/unsigned-int.mdx","type":"page","name":"unsignedInt","description":"Base StructureDefinition for unsignedInt type: An integer with a value that is not negative (e.g. >= 0)","icon":"$undefined","url":"/fhir-elements/primitive/unsigned-int","$ref":"(ovok)/fhir-elements/primitive/unsigned-int.mdx"},{"$id":"(ovok)/fhir-elements/primitive/uri.mdx","type":"page","name":"uri","description":"Base StructureDefinition for uri Type: String of characters used to identify a name or a resource","icon":"$undefined","url":"/fhir-elements/primitive/uri","$ref":"(ovok)/fhir-elements/primitive/uri.mdx"},{"$id":"(ovok)/fhir-elements/primitive/url.mdx","type":"page","name":"url","description":"Base StructureDefinition for url type: A URI that is a literal reference","icon":"$undefined","url":"/fhir-elements/primitive/url","$ref":"(ovok)/fhir-elements/primitive/url.mdx"},{"$id":"(ovok)/fhir-elements/primitive/uuid.mdx","type":"page","name":"uuid","description":"Base StructureDefinition for uuid type: A UUID, represented as a URI","icon":"$undefined","url":"/fhir-elements/primitive/uuid","$ref":"(ovok)/fhir-elements/primitive/uuid.mdx"},{"$id":"(ovok)/fhir-elements/primitive/xhtml.mdx","type":"page","name":"xhtml","description":"Base StructureDefinition for xhtml Type","icon":"$undefined","url":"/fhir-elements/primitive/xhtml","$ref":"(ovok)/fhir-elements/primitive/xhtml.mdx"}],"$id":"(ovok)/fhir-elements/primitive","$ref":{"folder":"(ovok)/fhir-elements/primitive","meta":"(ovok)/fhir-elements/primitive/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Complex types","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/fhir-elements/complex/address.mdx","type":"page","name":"Address","description":"Base StructureDefinition for Address Type: An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locat","icon":"$undefined","url":"/fhir-elements/complex/address","$ref":"(ovok)/fhir-elements/complex/address.mdx"},{"$id":"(ovok)/fhir-elements/complex/age.mdx","type":"page","name":"Age","description":"Base StructureDefinition for Age Type: A duration of time during which an organism (or a process) has existed.","icon":"$undefined","url":"/fhir-elements/complex/age","$ref":"(ovok)/fhir-elements/complex/age.mdx"},{"$id":"(ovok)/fhir-elements/complex/annotation.mdx","type":"page","name":"Annotation","description":"Base StructureDefinition for Annotation Type: A text note which also contains information about who made the statement and when.","icon":"$undefined","url":"/fhir-elements/complex/annotation","$ref":"(ovok)/fhir-elements/complex/annotation.mdx"},{"$id":"(ovok)/fhir-elements/complex/attachment.mdx","type":"page","name":"Attachment","description":"Base StructureDefinition for Attachment Type: For referring to data content defined in other formats.","icon":"$undefined","url":"/fhir-elements/complex/attachment","$ref":"(ovok)/fhir-elements/complex/attachment.mdx"},{"$id":"(ovok)/fhir-elements/complex/backbone-element.mdx","type":"page","name":"BackboneElement","description":"Base StructureDefinition for BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.","icon":"$undefined","url":"/fhir-elements/complex/backbone-element","$ref":"(ovok)/fhir-elements/complex/backbone-element.mdx"},{"$id":"(ovok)/fhir-elements/complex/codeable-concept.mdx","type":"page","name":"CodeableConcept","description":"Base StructureDefinition for CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.","icon":"$undefined","url":"/fhir-elements/complex/codeable-concept","$ref":"(ovok)/fhir-elements/complex/codeable-concept.mdx"},{"$id":"(ovok)/fhir-elements/complex/coding.mdx","type":"page","name":"Coding","description":"Base StructureDefinition for Coding Type: A reference to a code defined by a terminology system.","icon":"$undefined","url":"/fhir-elements/complex/coding","$ref":"(ovok)/fhir-elements/complex/coding.mdx"},{"$id":"(ovok)/fhir-elements/complex/contact-detail.mdx","type":"page","name":"ContactDetail","description":"Base StructureDefinition for ContactDetail Type: Specifies contact information for a person or organization.","icon":"$undefined","url":"/fhir-elements/complex/contact-detail","$ref":"(ovok)/fhir-elements/complex/contact-detail.mdx"},{"$id":"(ovok)/fhir-elements/complex/contact-point.mdx","type":"page","name":"ContactPoint","description":"Base StructureDefinition for ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.","icon":"$undefined","url":"/fhir-elements/complex/contact-point","$ref":"(ovok)/fhir-elements/complex/contact-point.mdx"},{"$id":"(ovok)/fhir-elements/complex/contributor.mdx","type":"page","name":"Contributor","description":"Base StructureDefinition for Contributor Type: A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.","icon":"$undefined","url":"/fhir-elements/complex/contributor","$ref":"(ovok)/fhir-elements/complex/contributor.mdx"},{"$id":"(ovok)/fhir-elements/complex/count.mdx","type":"page","name":"Count","description":"Base StructureDefinition for Count Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currenc","icon":"$undefined","url":"/fhir-elements/complex/count","$ref":"(ovok)/fhir-elements/complex/count.mdx"},{"$id":"(ovok)/fhir-elements/complex/data-requirement.mdx","type":"page","name":"DataRequirement","description":"Base StructureDefinition for DataRequirement Type: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.","icon":"$undefined","url":"/fhir-elements/complex/data-requirement","$ref":"(ovok)/fhir-elements/complex/data-requirement.mdx"},{"$id":"(ovok)/fhir-elements/complex/distance.mdx","type":"page","name":"Distance","description":"Base StructureDefinition for Distance Type: A length - a value with a unit that is a physical distance.","icon":"$undefined","url":"/fhir-elements/complex/distance","$ref":"(ovok)/fhir-elements/complex/distance.mdx"},{"$id":"(ovok)/fhir-elements/complex/dosage.mdx","type":"page","name":"Dosage","description":"Base StructureDefinition for Dosage Type: Indicates how the medication is/was taken or should be taken by the patient.","icon":"$undefined","url":"/fhir-elements/complex/dosage","$ref":"(ovok)/fhir-elements/complex/dosage.mdx"},{"$id":"(ovok)/fhir-elements/complex/duration.mdx","type":"page","name":"Duration","description":"Base StructureDefinition for Duration Type: A length of time.","icon":"$undefined","url":"/fhir-elements/complex/duration","$ref":"(ovok)/fhir-elements/complex/duration.mdx"},{"$id":"(ovok)/fhir-elements/complex/element-definition.mdx","type":"page","name":"ElementDefinition","description":"Base StructureDefinition for ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.","icon":"$undefined","url":"/fhir-elements/complex/element-definition","$ref":"(ovok)/fhir-elements/complex/element-definition.mdx"},{"$id":"(ovok)/fhir-elements/complex/element.mdx","type":"page","name":"Element","description":"Base StructureDefinition for Element Type: Base definition for all elements in a resource.","icon":"$undefined","url":"/fhir-elements/complex/element","$ref":"(ovok)/fhir-elements/complex/element.mdx"},{"$id":"(ovok)/fhir-elements/complex/expression.mdx","type":"page","name":"Expression","description":"Base StructureDefinition for Expression Type: A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the exp","icon":"$undefined","url":"/fhir-elements/complex/expression","$ref":"(ovok)/fhir-elements/complex/expression.mdx"},{"$id":"(ovok)/fhir-elements/complex/extension.mdx","type":"page","name":"Extension","description":"Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.","icon":"$undefined","url":"/fhir-elements/complex/extension","$ref":"(ovok)/fhir-elements/complex/extension.mdx"},{"$id":"(ovok)/fhir-elements/complex/human-name.mdx","type":"page","name":"HumanName","description":"Base StructureDefinition for HumanName Type: A human's name with the ability to identify parts and usage.","icon":"$undefined","url":"/fhir-elements/complex/human-name","$ref":"(ovok)/fhir-elements/complex/human-name.mdx"},{"$id":"(ovok)/fhir-elements/complex/identifier.mdx","type":"page","name":"Identifier","description":"Base StructureDefinition for Identifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.","icon":"$undefined","url":"/fhir-elements/complex/identifier","$ref":"(ovok)/fhir-elements/complex/identifier.mdx"},{"$id":"(ovok)/fhir-elements/complex/marketing-status.mdx","type":"page","name":"MarketingStatus","description":"Base StructureDefinition for MarketingStatus Type: The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.","icon":"$undefined","url":"/fhir-elements/complex/marketing-status","$ref":"(ovok)/fhir-elements/complex/marketing-status.mdx"},{"$id":"(ovok)/fhir-elements/complex/meta.mdx","type":"page","name":"Meta","description":"Base StructureDefinition for Meta Type: The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.","icon":"$undefined","url":"/fhir-elements/complex/meta","$ref":"(ovok)/fhir-elements/complex/meta.mdx"},{"$id":"(ovok)/fhir-elements/complex/money.mdx","type":"page","name":"Money","description":"Base StructureDefinition for Money Type: An amount of economic utility in some recognized currency.","icon":"$undefined","url":"/fhir-elements/complex/money","$ref":"(ovok)/fhir-elements/complex/money.mdx"},{"$id":"(ovok)/fhir-elements/complex/narrative.mdx","type":"page","name":"Narrative","description":"Base StructureDefinition for Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.","icon":"$undefined","url":"/fhir-elements/complex/narrative","$ref":"(ovok)/fhir-elements/complex/narrative.mdx"},{"$id":"(ovok)/fhir-elements/complex/parameter-definition.mdx","type":"page","name":"ParameterDefinition","description":"Base StructureDefinition for ParameterDefinition Type: The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are","icon":"$undefined","url":"/fhir-elements/complex/parameter-definition","$ref":"(ovok)/fhir-elements/complex/parameter-definition.mdx"},{"$id":"(ovok)/fhir-elements/complex/period.mdx","type":"page","name":"Period","description":"Base StructureDefinition for Period Type: A time period defined by a start and end date and optionally time.","icon":"$undefined","url":"/fhir-elements/complex/period","$ref":"(ovok)/fhir-elements/complex/period.mdx"},{"$id":"(ovok)/fhir-elements/complex/population.mdx","type":"page","name":"Population","description":"Base StructureDefinition for Population Type: A populatioof people with some set of grouping criteria.","icon":"$undefined","url":"/fhir-elements/complex/population","$ref":"(ovok)/fhir-elements/complex/population.mdx"},{"$id":"(ovok)/fhir-elements/complex/prod-characteristic.mdx","type":"page","name":"ProdCharacteristic","description":"Base StructureDefinition for ProdCharacteristic Type: The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.","icon":"$undefined","url":"/fhir-elements/complex/prod-characteristic","$ref":"(ovok)/fhir-elements/complex/prod-characteristic.mdx"},{"$id":"(ovok)/fhir-elements/complex/product-shelf-life.mdx","type":"page","name":"ProductShelfLife","description":"Base StructureDefinition for ProductShelfLife Type: The shelf-life and storage information for a medicinal product item or container can be described using this class.","icon":"$undefined","url":"/fhir-elements/complex/product-shelf-life","$ref":"(ovok)/fhir-elements/complex/product-shelf-life.mdx"},{"$id":"(ovok)/fhir-elements/complex/quantity.mdx","type":"page","name":"Quantity","description":"Base StructureDefinition for Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating curr","icon":"$undefined","url":"/fhir-elements/complex/quantity","$ref":"(ovok)/fhir-elements/complex/quantity.mdx"},{"$id":"(ovok)/fhir-elements/complex/range.mdx","type":"page","name":"Range","description":"Base StructureDefinition for Range Type: A set of ordered Quantities defined by a low and high limit.","icon":"$undefined","url":"/fhir-elements/complex/range","$ref":"(ovok)/fhir-elements/complex/range.mdx"},{"$id":"(ovok)/fhir-elements/complex/ratio.mdx","type":"page","name":"Ratio","description":"Base StructureDefinition for Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.","icon":"$undefined","url":"/fhir-elements/complex/ratio","$ref":"(ovok)/fhir-elements/complex/ratio.mdx"},{"$id":"(ovok)/fhir-elements/complex/reference.mdx","type":"page","name":"Reference","description":"Base StructureDefinition for Reference Type: A reference from one resource to another.","icon":"$undefined","url":"/fhir-elements/complex/reference","$ref":"(ovok)/fhir-elements/complex/reference.mdx"},{"$id":"(ovok)/fhir-elements/complex/related-artifact.mdx","type":"page","name":"RelatedArtifact","description":"Base StructureDefinition for RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.","icon":"$undefined","url":"/fhir-elements/complex/related-artifact","$ref":"(ovok)/fhir-elements/complex/related-artifact.mdx"},{"$id":"(ovok)/fhir-elements/complex/sampled-data.mdx","type":"page","name":"SampledData","description":"Base StructureDefinition for SampledData Type: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.","icon":"$undefined","url":"/fhir-elements/complex/sampled-data","$ref":"(ovok)/fhir-elements/complex/sampled-data.mdx"},{"$id":"(ovok)/fhir-elements/complex/signature.mdx","type":"page","name":"Signature","description":"Base StructureDefinition for Signature Type: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple ","icon":"$undefined","url":"/fhir-elements/complex/signature","$ref":"(ovok)/fhir-elements/complex/signature.mdx"},{"$id":"(ovok)/fhir-elements/complex/substance-amount.mdx","type":"page","name":"SubstanceAmount","description":"Base StructureDefinition for SubstanceAmount Type: Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular struc","icon":"$undefined","url":"/fhir-elements/complex/substance-amount","$ref":"(ovok)/fhir-elements/complex/substance-amount.mdx"},{"$id":"(ovok)/fhir-elements/complex/timing.mdx","type":"page","name":"Timing","description":"Base StructureDefinition for Timing Type: Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. ","icon":"$undefined","url":"/fhir-elements/complex/timing","$ref":"(ovok)/fhir-elements/complex/timing.mdx"},{"$id":"(ovok)/fhir-elements/complex/trigger-definition.mdx","type":"page","name":"TriggerDefinition","description":"Base StructureDefinition for TriggerDefinition Type: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.","icon":"$undefined","url":"/fhir-elements/complex/trigger-definition","$ref":"(ovok)/fhir-elements/complex/trigger-definition.mdx"},{"$id":"(ovok)/fhir-elements/complex/usage-context.mdx","type":"page","name":"UsageContext","description":"Base StructureDefinition for UsageContext Type: Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) o","icon":"$undefined","url":"/fhir-elements/complex/usage-context","$ref":"(ovok)/fhir-elements/complex/usage-context.mdx"}],"$id":"(ovok)/fhir-elements/complex","$ref":{"folder":"(ovok)/fhir-elements/complex","meta":"(ovok)/fhir-elements/complex/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Foundation models","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(ovok)/fhir-elements/foundation/domain-resource.mdx","type":"page","name":"DomainResource","description":"A resource that includes narrative, extensions, and contained resources.","icon":"$undefined","url":"/fhir-elements/foundation/domain-resource","$ref":"(ovok)/fhir-elements/foundation/domain-resource.mdx"},{"$id":"(ovok)/fhir-elements/foundation/resource.mdx","type":"page","name":"Resource","description":"This is the base resource type for everything.","icon":"$undefined","url":"/fhir-elements/foundation/resource","$ref":"(ovok)/fhir-elements/foundation/resource.mdx"}],"$id":"(ovok)/fhir-elements/foundation","$ref":{"folder":"(ovok)/fhir-elements/foundation","meta":"(ovok)/fhir-elements/foundation/meta.json"},"icon":"$undefined"}],"$id":"(ovok)","$ref":{"folder":"(ovok)","meta":"(ovok)/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Signals","root":true,"defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"_38","type":"separator","icon":"$undefined","name":"Signals"},{"$id":"(signals)/signals/index.mdx","type":"page","name":"Signals","description":"Understand Actimi Signals, its role alongside Ovok, and its MDR Class IIa status.","icon":"$undefined","url":"/signals","$ref":"(signals)/signals/index.mdx"},{"type":"folder","name":"Standalone","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(signals)/signals/standalone/webhooks.mdx","type":"page","name":"Webhooks","description":"Receive Signals alerts, episodes, readings and patient changes as signed webhooks: subscribers, events, reach, signatures and redelivery.","icon":"$undefined","url":"/signals/standalone/webhooks","$ref":"(signals)/signals/standalone/webhooks.mdx"},{"type":"folder","name":"API reference","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Alerts","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(signals)/signals/standalone/api/alerts/list-alerts-or-the-episodes-they-were-folded-into.mdx","type":"page","name":"List alerts, or the episodes they were folded into","description":"List alerts, or the episodes they were folded into, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/alerts/list-alerts-or-the-episodes-they-were-folded-into","$ref":"(signals)/signals/standalone/api/alerts/list-alerts-or-the-episodes-they-were-folded-into.mdx"},{"$id":"(signals)/signals/standalone/api/alerts/get-one-alert-or-one-episode-with-its-readings.mdx","type":"page","name":"Get one alert, or one episode with its readings","description":"Get one alert, or one episode with its readings, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/alerts/get-one-alert-or-one-episode-with-its-readings","$ref":"(signals)/signals/standalone/api/alerts/get-one-alert-or-one-episode-with-its-readings.mdx"},{"$id":"(signals)/signals/standalone/api/alerts/acknowledge-an-alert-or-an-episode.mdx","type":"page","name":"Acknowledge an alert, or an episode","description":"Acknowledge an alert, or an episode, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/alerts/acknowledge-an-alert-or-an-episode","$ref":"(signals)/signals/standalone/api/alerts/acknowledge-an-alert-or-an-episode.mdx"}],"$id":"(signals)/signals/standalone/api/alerts","$ref":{"folder":"(signals)/signals/standalone/api/alerts","meta":"(signals)/signals/standalone/api/alerts/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Observations","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(signals)/signals/standalone/api/observations/submit-a-reading-by-patient-refid.mdx","type":"page","name":"Submit a reading by patient refId","description":"Submit a reading by patient refId, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/observations/submit-a-reading-by-patient-refid","$ref":"(signals)/signals/standalone/api/observations/submit-a-reading-by-patient-refid.mdx"},{"$id":"(signals)/signals/standalone/api/observations/list-a-patients-readings.mdx","type":"page","name":"List a patient's readings","description":"List a patient's readings, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/observations/list-a-patients-readings","$ref":"(signals)/signals/standalone/api/observations/list-a-patients-readings.mdx"},{"$id":"(signals)/signals/standalone/api/observations/submit-a-reading-for-a-patient-id.mdx","type":"page","name":"Submit a reading for a patient id","description":"Submit a reading for a patient id, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/observations/submit-a-reading-for-a-patient-id","$ref":"(signals)/signals/standalone/api/observations/submit-a-reading-for-a-patient-id.mdx"},{"$id":"(signals)/signals/standalone/api/observations/submit-several-readings-for-one-patient.mdx","type":"page","name":"Submit several readings for one patient","description":"Submit several readings for one patient, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/observations/submit-several-readings-for-one-patient","$ref":"(signals)/signals/standalone/api/observations/submit-several-readings-for-one-patient.mdx"}],"$id":"(signals)/signals/standalone/api/observations","$ref":{"folder":"(signals)/signals/standalone/api/observations","meta":"(signals)/signals/standalone/api/observations/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Patients","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(signals)/signals/standalone/api/patients/list-patients.mdx","type":"page","name":"List patients","description":"List patients, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/list-patients","$ref":"(signals)/signals/standalone/api/patients/list-patients.mdx"},{"$id":"(signals)/signals/standalone/api/patients/create-patients.mdx","type":"page","name":"Create patients","description":"Create patients, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/create-patients","$ref":"(signals)/signals/standalone/api/patients/create-patients.mdx"},{"$id":"(signals)/signals/standalone/api/patients/resolve-refids-to-signals-ids.mdx","type":"page","name":"Resolve refIds to Signals ids","description":"Resolve refIds to Signals ids, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/resolve-refids-to-signals-ids","$ref":"(signals)/signals/standalone/api/patients/resolve-refids-to-signals-ids.mdx"},{"$id":"(signals)/signals/standalone/api/patients/get-one-patient.mdx","type":"page","name":"Get one patient","description":"Get one patient, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/get-one-patient","$ref":"(signals)/signals/standalone/api/patients/get-one-patient.mdx"},{"$id":"(signals)/signals/standalone/api/patients/update-a-patient.mdx","type":"page","name":"Update a patient","description":"Update a patient, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/update-a-patient","$ref":"(signals)/signals/standalone/api/patients/update-a-patient.mdx"},{"$id":"(signals)/signals/standalone/api/patients/delete-a-patient.mdx","type":"page","name":"Delete a patient","description":"Delete a patient, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/delete-a-patient","$ref":"(signals)/signals/standalone/api/patients/delete-a-patient.mdx"},{"$id":"(signals)/signals/standalone/api/patients/list-a-submitters-patients.mdx","type":"page","name":"List a submitter's patients","description":"List a submitter's patients, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/list-a-submitters-patients","$ref":"(signals)/signals/standalone/api/patients/list-a-submitters-patients.mdx"},{"$id":"(signals)/signals/standalone/api/patients/attach-patients-to-a-submitter.mdx","type":"page","name":"Attach patients to a submitter","description":"Attach patients to a submitter, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/attach-patients-to-a-submitter","$ref":"(signals)/signals/standalone/api/patients/attach-patients-to-a-submitter.mdx"},{"$id":"(signals)/signals/standalone/api/patients/detach-a-patient-from-a-submitter.mdx","type":"page","name":"Detach a patient from a submitter","description":"Detach a patient from a submitter, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/detach-a-patient-from-a-submitter","$ref":"(signals)/signals/standalone/api/patients/detach-a-patient-from-a-submitter.mdx"},{"$id":"(signals)/signals/standalone/api/patients/list-a-subscribers-patients.mdx","type":"page","name":"List a subscriber's patients","description":"List a subscriber's patients, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/list-a-subscribers-patients","$ref":"(signals)/signals/standalone/api/patients/list-a-subscribers-patients.mdx"},{"$id":"(signals)/signals/standalone/api/patients/attach-patients-to-a-subscriber.mdx","type":"page","name":"Attach patients to a subscriber","description":"Attach patients to a subscriber, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/attach-patients-to-a-subscriber","$ref":"(signals)/signals/standalone/api/patients/attach-patients-to-a-subscriber.mdx"},{"$id":"(signals)/signals/standalone/api/patients/detach-a-patient-from-a-subscriber.mdx","type":"page","name":"Detach a patient from a subscriber","description":"Detach a patient from a subscriber, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patients/detach-a-patient-from-a-subscriber","$ref":"(signals)/signals/standalone/api/patients/detach-a-patient-from-a-subscriber.mdx"}],"$id":"(signals)/signals/standalone/api/patients","$ref":{"folder":"(signals)/signals/standalone/api/patients","meta":"(signals)/signals/standalone/api/patients/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Patient config","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(signals)/signals/standalone/api/patient-config/write-one-config-to-many-patients.mdx","type":"page","name":"Write one config to many patients","description":"Write one config to many patients, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patient-config/write-one-config-to-many-patients","$ref":"(signals)/signals/standalone/api/patient-config/write-one-config-to-many-patients.mdx"},{"$id":"(signals)/signals/standalone/api/patient-config/write-a-different-config-to-each-of-many-patients.mdx","type":"page","name":"Write a different config to each of many patients","description":"Write a different config to each of many patients, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patient-config/write-a-different-config-to-each-of-many-patients","$ref":"(signals)/signals/standalone/api/patient-config/write-a-different-config-to-each-of-many-patients.mdx"},{"$id":"(signals)/signals/standalone/api/patient-config/read-the-config-status-of-many-patients.mdx","type":"page","name":"Read the config status of many patients","description":"Read the config status of many patients, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/patient-config/read-the-config-status-of-many-patients","$ref":"(signals)/signals/standalone/api/patient-config/read-the-config-status-of-many-patients.mdx"}],"$id":"(signals)/signals/standalone/api/patient-config","$ref":{"folder":"(signals)/signals/standalone/api/patient-config","meta":"(signals)/signals/standalone/api/patient-config/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Clients","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(signals)/signals/standalone/api/clients/list-users.mdx","type":"page","name":"List users","description":"List users, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/clients/list-users","$ref":"(signals)/signals/standalone/api/clients/list-users.mdx"},{"$id":"(signals)/signals/standalone/api/clients/create-a-user.mdx","type":"page","name":"Create a user","description":"Create a user, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/clients/create-a-user","$ref":"(signals)/signals/standalone/api/clients/create-a-user.mdx"},{"$id":"(signals)/signals/standalone/api/clients/get-one-user.mdx","type":"page","name":"Get one user","description":"Get one user, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/clients/get-one-user","$ref":"(signals)/signals/standalone/api/clients/get-one-user.mdx"},{"$id":"(signals)/signals/standalone/api/clients/update-a-user.mdx","type":"page","name":"Update a user","description":"Update a user, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/clients/update-a-user","$ref":"(signals)/signals/standalone/api/clients/update-a-user.mdx"},{"$id":"(signals)/signals/standalone/api/clients/delete-a-user.mdx","type":"page","name":"Delete a user","description":"Delete a user, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/clients/delete-a-user","$ref":"(signals)/signals/standalone/api/clients/delete-a-user.mdx"},{"$id":"(signals)/signals/standalone/api/clients/read-the-webhook-endpoint.mdx","type":"page","name":"Read the webhook endpoint","description":"Read the webhook endpoint, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/clients/read-the-webhook-endpoint","$ref":"(signals)/signals/standalone/api/clients/read-the-webhook-endpoint.mdx"},{"$id":"(signals)/signals/standalone/api/clients/enable-the-webhook-endpoint.mdx","type":"page","name":"Enable the webhook endpoint","description":"Enable the webhook endpoint, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/clients/enable-the-webhook-endpoint","$ref":"(signals)/signals/standalone/api/clients/enable-the-webhook-endpoint.mdx"},{"$id":"(signals)/signals/standalone/api/clients/disable-the-webhook-endpoint.mdx","type":"page","name":"Disable the webhook endpoint","description":"Disable the webhook endpoint, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/clients/disable-the-webhook-endpoint","$ref":"(signals)/signals/standalone/api/clients/disable-the-webhook-endpoint.mdx"},{"$id":"(signals)/signals/standalone/api/clients/send-a-test-event.mdx","type":"page","name":"Send a test event","description":"Send a test event, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/clients/send-a-test-event","$ref":"(signals)/signals/standalone/api/clients/send-a-test-event.mdx"},{"$id":"(signals)/signals/standalone/api/clients/rotate-the-webhook-signing-secret.mdx","type":"page","name":"Rotate the webhook signing secret","description":"Rotate the webhook signing secret, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/clients/rotate-the-webhook-signing-secret","$ref":"(signals)/signals/standalone/api/clients/rotate-the-webhook-signing-secret.mdx"}],"$id":"(signals)/signals/standalone/api/clients","$ref":{"folder":"(signals)/signals/standalone/api/clients","meta":"(signals)/signals/standalone/api/clients/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Tenants","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(signals)/signals/standalone/api/tenants/get-the-callers-tenant.mdx","type":"page","name":"Get the caller's tenant","description":"Get the caller's tenant, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/tenants/get-the-callers-tenant","$ref":"(signals)/signals/standalone/api/tenants/get-the-callers-tenant.mdx"},{"$id":"(signals)/signals/standalone/api/tenants/update-tenant-settings.mdx","type":"page","name":"Update tenant settings","description":"Update tenant settings, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/tenants/update-tenant-settings","$ref":"(signals)/signals/standalone/api/tenants/update-tenant-settings.mdx"}],"$id":"(signals)/signals/standalone/api/tenants","$ref":{"folder":"(signals)/signals/standalone/api/tenants","meta":"(signals)/signals/standalone/api/tenants/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Settings","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(signals)/signals/standalone/api/settings/get-an-orgs-rule-settings.mdx","type":"page","name":"Get an org's rule settings","description":"Get an org's rule settings, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/settings/get-an-orgs-rule-settings","$ref":"(signals)/signals/standalone/api/settings/get-an-orgs-rule-settings.mdx"},{"$id":"(signals)/signals/standalone/api/settings/replace-an-orgs-rule-settings.mdx","type":"page","name":"Replace an org's rule settings","description":"Replace an org's rule settings, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/settings/replace-an-orgs-rule-settings","$ref":"(signals)/signals/standalone/api/settings/replace-an-orgs-rule-settings.mdx"},{"$id":"(signals)/signals/standalone/api/settings/get-a-patients-own-rule-settings.mdx","type":"page","name":"Get a patient's own rule settings","description":"Get a patient's own rule settings, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/settings/get-a-patients-own-rule-settings","$ref":"(signals)/signals/standalone/api/settings/get-a-patients-own-rule-settings.mdx"},{"$id":"(signals)/signals/standalone/api/settings/replace-a-patients-own-rule-settings.mdx","type":"page","name":"Replace a patient's own rule settings","description":"Replace a patient's own rule settings, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/settings/replace-a-patients-own-rule-settings","$ref":"(signals)/signals/standalone/api/settings/replace-a-patients-own-rule-settings.mdx"}],"$id":"(signals)/signals/standalone/api/settings","$ref":{"folder":"(signals)/signals/standalone/api/settings","meta":"(signals)/signals/standalone/api/settings/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Events","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(signals)/signals/standalone/api/events/list-webhook-events.mdx","type":"page","name":"List webhook events","description":"List webhook events, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/events/list-webhook-events","$ref":"(signals)/signals/standalone/api/events/list-webhook-events.mdx"},{"$id":"(signals)/signals/standalone/api/events/list-a-deliverys-attempts.mdx","type":"page","name":"List a delivery's attempts","description":"List a delivery's attempts, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/events/list-a-deliverys-attempts","$ref":"(signals)/signals/standalone/api/events/list-a-deliverys-attempts.mdx"},{"$id":"(signals)/signals/standalone/api/events/redeliver-events.mdx","type":"page","name":"Redeliver events","description":"Redeliver events, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/events/redeliver-events","$ref":"(signals)/signals/standalone/api/events/redeliver-events.mdx"},{"$id":"(signals)/signals/standalone/api/events/redeliver-one-event.mdx","type":"page","name":"Redeliver one event","description":"Redeliver one event, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/events/redeliver-one-event","$ref":"(signals)/signals/standalone/api/events/redeliver-one-event.mdx"}],"$id":"(signals)/signals/standalone/api/events","$ref":{"folder":"(signals)/signals/standalone/api/events","meta":"(signals)/signals/standalone/api/events/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Health","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(signals)/signals/standalone/api/health/liveness.mdx","type":"page","name":"Liveness","description":"Liveness, through Ovok's Signals gateway.","icon":"$undefined","url":"/signals/standalone/api/health/liveness","$ref":"(signals)/signals/standalone/api/health/liveness.mdx"}],"$id":"(signals)/signals/standalone/api/health","$ref":{"folder":"(signals)/signals/standalone/api/health","meta":"(signals)/signals/standalone/api/health/meta.json"},"icon":"$undefined"}],"$id":"(signals)/signals/standalone/api","$ref":{"folder":"(signals)/signals/standalone/api","meta":"(signals)/signals/standalone/api/meta.json"},"icon":"$undefined"}],"$id":"(signals)/signals/standalone","$ref":{"folder":"(signals)/signals/standalone","meta":"(signals)/signals/standalone/meta.json"},"index":{"$id":"(signals)/signals/standalone/index.mdx","type":"page","name":"Signals standalone","description":"Use Signals' own API through Ovok at /v1/signals/api: app types, authentication, what Ovok adds to each call, and a first patient, reading and alert.","icon":"$undefined","url":"/signals/standalone","$ref":"(signals)/signals/standalone/index.mdx"},"icon":"$undefined"},{"$id":"_39","type":"separator","icon":"$undefined","name":"With Ovok"},{"$id":"(signals)/signals/connected-ovok.mdx","type":"page","name":"Signals with Ovok","description":"Use Signals as part of an Ovok app: FHIR Observations go to Signals, and its alerts come back into FHIR as DetectedIssue, Flag and Observation interpretation.","icon":"$undefined","url":"/signals/connected-ovok","$ref":"(signals)/signals/connected-ovok.mdx"},{"$id":"(signals)/signals/with-ovok/settings.mdx","type":"page","name":"Settings","description":"SIGNALS_SEND_AUTO and SIGNALS_ANNOTATE_OBSERVATIONS: what each switch does, its default, and what saving it sets up.","icon":"$undefined","url":"/signals/with-ovok/settings","$ref":"(signals)/signals/with-ovok/settings.mdx"},{"$id":"(signals)/signals/with-ovok/fhir-annotations.mdx","type":"page","name":"Alerts in FHIR","description":"How Ovok writes Signals' alerts and episodes into FHIR: a DetectedIssue per alert, a Flag per episode, and interpretation and referenceRange on the reading.","icon":"$undefined","url":"/signals/with-ovok/fhir-annotations","$ref":"(signals)/signals/with-ovok/fhir-annotations.mdx"},{"$id":"(signals)/signals/enable-signals-patient.mdx","type":"page","name":"Enable Signals for a Patient","description":"Enroll an existing Ovok Patient in Signals through the Patient enable-signals operation.","icon":"$undefined","url":"/signals/enable-signals-patient","$ref":"(signals)/signals/enable-signals-patient.mdx"},{"$id":"(signals)/signals/with-ovok/gotchas.mdx","type":"page","name":"Gotchas","description":"What to know before relying on Signals in an Ovok app: which readings are sent, retries and gaps, episodes, annotation limits and access.","icon":"$undefined","url":"/signals/with-ovok/gotchas","$ref":"(signals)/signals/with-ovok/gotchas.mdx"}],"$id":"(signals)","$ref":{"folder":"(signals)","meta":"(signals)/meta.json"},"icon":"$undefined"},{"type":"folder","name":"SDKs","root":true,"defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"_40","type":"separator","icon":"$undefined","name":"JavaScript SDK"},{"$id":"(sdks)/web-sdk/index.mdx","type":"page","name":"JavaScript SDK","description":"Use the Ovok TypeScript client in server, browser, and React Native applications.","icon":"$undefined","url":"/web-sdk","$ref":"(sdks)/web-sdk/index.mdx"},{"$id":"_41","type":"separator","icon":"$undefined","name":"Start here"},{"$id":"(sdks)/web-sdk/core/getting-started.mdx","type":"page","name":"Get started","description":"Install @ovok/core, configure the Ovok client, and make a first request.","icon":"$undefined","url":"/web-sdk/core/getting-started","$ref":"(sdks)/web-sdk/core/getting-started.mdx"},{"$id":"(sdks)/web-sdk/core/client-configuration.mdx","type":"page","name":"Configure the client","description":"Configure the Ovok API origin, tenant, storage, and request behavior.","icon":"$undefined","url":"/web-sdk/core/client-configuration","$ref":"(sdks)/web-sdk/core/client-configuration.mdx"},{"$id":"(sdks)/web-sdk/core/next-client.mdx","type":"page","name":"The Ovok client","description":"Use the @ovok/core package root for Node, browsers and React Native.","icon":"$undefined","url":"/web-sdk/core/next-client","$ref":"(sdks)/web-sdk/core/next-client.mdx"},{"$id":"(sdks)/web-sdk/core/errors-and-retries.mdx","type":"page","name":"Errors and retries","description":"Catch typed Ovok errors and retry only failures that are safe to repeat.","icon":"$undefined","url":"/web-sdk/core/errors-and-retries","$ref":"(sdks)/web-sdk/core/errors-and-retries.mdx"},{"$id":"(sdks)/web-sdk/core/compatibility.mdx","type":"page","name":"Compatibility","description":"Check runtime, React, and Ovok API requirements before integrating the SDK.","icon":"$undefined","url":"/web-sdk/core/compatibility","$ref":"(sdks)/web-sdk/core/compatibility.mdx"},{"type":"folder","name":"Guides","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/web-sdk/core/guides/sign-in.mdx","type":"page","name":"Sign users in","description":"Sign users in with the Ovok client, keep several accounts, and react to session changes.","icon":"$undefined","url":"/web-sdk/core/guides/sign-in","$ref":"(sdks)/web-sdk/core/guides/sign-in.mdx"},{"$id":"(sdks)/web-sdk/core/guides/react-applications.mdx","type":"page","name":"React applications","description":"Use the package root for the Ovok client and @ovok/core/next/react for the provider and hooks. Keep the provider and hook consumers in the client component tree.","icon":"$undefined","url":"/web-sdk/core/guides/react-applications","$ref":"(sdks)/web-sdk/core/guides/react-applications.mdx"}],"$id":"(sdks)/web-sdk/core/guides","$ref":{"folder":"(sdks)/web-sdk/core/guides","meta":"(sdks)/web-sdk/core/guides/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Namespaces","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/web-sdk/core/namespaces/accounts.mdx","type":"page","name":"ovok.accounts","description":"List the accounts the signed-in user can access.","icon":"$undefined","url":"/web-sdk/core/namespaces/accounts","$ref":"(sdks)/web-sdk/core/namespaces/accounts.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/ai.mdx","type":"page","name":"ovok.ai","description":"Translate text, chat with an AI assistant, and search FHIR data in natural language.","icon":"$undefined","url":"/web-sdk/core/namespaces/ai","$ref":"(sdks)/web-sdk/core/namespaces/ai.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/auth.mdx","type":"page","name":"ovok.auth","description":"Sign in, register, manage passwords and sessions, and delete an account.","icon":"$undefined","url":"/web-sdk/core/namespaces/auth","$ref":"(sdks)/web-sdk/core/namespaces/auth.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/bots.mdx","type":"page","name":"ovok.bots","description":"Run a server-side bot with a JSON input.","icon":"$undefined","url":"/web-sdk/core/namespaces/bots","$ref":"(sdks)/web-sdk/core/namespaces/bots.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/cms.mdx","type":"page","name":"ovok.cms","description":"Read published CMS documents, legal pages, release notes and translations.","icon":"$undefined","url":"/web-sdk/core/namespaces/cms","$ref":"(sdks)/web-sdk/core/namespaces/cms.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/consent.mdx","type":"page","name":"ovok.consent","description":"Read and record legal and medical consent, and request consent signatures.","icon":"$undefined","url":"/web-sdk/core/namespaces/consent","$ref":"(sdks)/web-sdk/core/namespaces/consent.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/content.mdx","type":"page","name":"ovok.content","description":"Search and manage managed content items by type and language.","icon":"$undefined","url":"/web-sdk/core/namespaces/content","$ref":"(sdks)/web-sdk/core/namespaces/content.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/documents.mdx","type":"page","name":"ovok.documents","description":"Register uploads, update metadata, delete documents, and build download URLs.","icon":"$undefined","url":"/web-sdk/core/namespaces/documents","$ref":"(sdks)/web-sdk/core/namespaces/documents.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/email.mdx","type":"page","name":"ovok.email","description":"List the project's email templates.","icon":"$undefined","url":"/web-sdk/core/namespaces/email","$ref":"(sdks)/web-sdk/core/namespaces/email.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/fhir.mdx","type":"page","name":"ovok.fhir","description":"Read, search, write and batch FHIR resources through the Ovok API.","icon":"$undefined","url":"/web-sdk/core/namespaces/fhir","$ref":"(sdks)/web-sdk/core/namespaces/fhir.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/health.mdx","type":"page","name":"ovok.health","description":"Check that the Ovok API and its dependencies are healthy.","icon":"$undefined","url":"/web-sdk/core/namespaces/health","$ref":"(sdks)/web-sdk/core/namespaces/health.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/invites.mdx","type":"page","name":"ovok.invites","description":"Send and accept record-share and care invitations.","icon":"$undefined","url":"/web-sdk/core/namespaces/invites","$ref":"(sdks)/web-sdk/core/namespaces/invites.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/localization.mdx","type":"page","name":"ovok.locales and ovok.localizations","description":"Manage the languages a project supports and its translation entries.","icon":"$undefined","url":"/web-sdk/core/namespaces/localization","$ref":"(sdks)/web-sdk/core/namespaces/localization.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/measurements.mdx","type":"page","name":"ovok.measurements","description":"Build, save and read measurements as FHIR Observations, with an offline queue.","icon":"$undefined","url":"/web-sdk/core/namespaces/measurements","$ref":"(sdks)/web-sdk/core/namespaces/measurements.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/patient.mdx","type":"page","name":"ovok.patient","description":"Read and manage the signed-in patient's own records.","icon":"$undefined","url":"/web-sdk/core/namespaces/patient","$ref":"(sdks)/web-sdk/core/namespaces/patient.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/projects.mdx","type":"page","name":"ovok.projects","description":"List the projects you administer and manage a project's members, features and settings.","icon":"$undefined","url":"/web-sdk/core/namespaces/projects","$ref":"(sdks)/web-sdk/core/namespaces/projects.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/questionnaires.mdx","type":"page","name":"ovok.questionnaires and ovok.questionnaireResponses","description":"Pre-fill questionnaires, submit responses and extract observations.","icon":"$undefined","url":"/web-sdk/core/namespaces/questionnaires","$ref":"(sdks)/web-sdk/core/namespaces/questionnaires.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/realtime.mdx","type":"page","name":"ovok.realtime","description":"Receive live notifications when FHIR resources change, over a websocket.","icon":"$undefined","url":"/web-sdk/core/namespaces/realtime","$ref":"(sdks)/web-sdk/core/namespaces/realtime.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/session.mdx","type":"page","name":"ovok.session","description":"Read the current session, follow session changes and switch between saved accounts.","icon":"$undefined","url":"/web-sdk/core/namespaces/session","$ref":"(sdks)/web-sdk/core/namespaces/session.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/sharing.mdx","type":"page","name":"ovok.sharing","description":"Share a patient's observations with other people through invites, and manage active shares.","icon":"$undefined","url":"/web-sdk/core/namespaces/sharing","$ref":"(sdks)/web-sdk/core/namespaces/sharing.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/signals.mdx","type":"page","name":"ovok.signals","description":"Enable Signals for a patient, repair undelivered limits and call the Signals API through Ovok.","icon":"$undefined","url":"/web-sdk/core/namespaces/signals","$ref":"(sdks)/web-sdk/core/namespaces/signals.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/slim.mdx","type":"page","name":"ovok.slim","description":"The care-home dashboard API: residents, devices, notifications, thresholds, trends, places and staff.","icon":"$undefined","url":"/web-sdk/core/namespaces/slim","$ref":"(sdks)/web-sdk/core/namespaces/slim.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/videocalls.mdx","type":"page","name":"ovok.videoCalls","description":"Schedule video calls, get access to them and send call emails.","icon":"$undefined","url":"/web-sdk/core/namespaces/videocalls","$ref":"(sdks)/web-sdk/core/namespaces/videocalls.mdx"},{"$id":"(sdks)/web-sdk/core/namespaces/wearables.mdx","type":"page","name":"ovok.wearables","description":"Configure wearable providers and connect, sync and disconnect a patient's accounts.","icon":"$undefined","url":"/web-sdk/core/namespaces/wearables","$ref":"(sdks)/web-sdk/core/namespaces/wearables.mdx"}],"$id":"(sdks)/web-sdk/core/namespaces","$ref":{"folder":"(sdks)/web-sdk/core/namespaces","meta":"(sdks)/web-sdk/core/namespaces/meta.json"},"icon":"$undefined"},{"$id":"_42","type":"separator","icon":"$undefined","name":"React"},{"$id":"(sdks)/web-sdk/core/react.mdx","type":"page","name":"React integration","description":"Provide the Ovok client to React components and use the SDK hooks.","icon":"$undefined","url":"/web-sdk/core/react","$ref":"(sdks)/web-sdk/core/react.mdx"},{"$id":"_43","type":"separator","icon":"$undefined","name":"Reference"},{"$id":"(sdks)/web-sdk/core/api-surface.mdx","type":"page","name":"JavaScript SDK API map","description":"Find the package-root client, resource namespaces, React exports, and API reference.","icon":"$undefined","url":"/web-sdk/core/api-surface","$ref":"(sdks)/web-sdk/core/api-surface.mdx"},{"type":"folder","name":"API reference","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"@ovok/core","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/web-sdk/core/reference/core/accounts.mdx","type":"page","name":"accounts","description":"Generated reference for @ovok/core: accounts.","icon":"$undefined","url":"/web-sdk/core/reference/core/accounts","$ref":"(sdks)/web-sdk/core/reference/core/accounts.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/ai.mdx","type":"page","name":"ai","description":"Generated reference for @ovok/core: ai.","icon":"$undefined","url":"/web-sdk/core/reference/core/ai","$ref":"(sdks)/web-sdk/core/reference/core/ai.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/auth.mdx","type":"page","name":"auth","description":"Generated reference for @ovok/core: auth.","icon":"$undefined","url":"/web-sdk/core/reference/core/auth","$ref":"(sdks)/web-sdk/core/reference/core/auth.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/bots.mdx","type":"page","name":"bots","description":"Generated reference for @ovok/core: bots.","icon":"$undefined","url":"/web-sdk/core/reference/core/bots","$ref":"(sdks)/web-sdk/core/reference/core/bots.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/cms.mdx","type":"page","name":"cms","description":"Generated reference for @ovok/core: cms.","icon":"$undefined","url":"/web-sdk/core/reference/core/cms","$ref":"(sdks)/web-sdk/core/reference/core/cms.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/consent.mdx","type":"page","name":"consent","description":"Generated reference for @ovok/core: consent.","icon":"$undefined","url":"/web-sdk/core/reference/core/consent","$ref":"(sdks)/web-sdk/core/reference/core/consent.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/content.mdx","type":"page","name":"content","description":"Generated reference for @ovok/core: content.","icon":"$undefined","url":"/web-sdk/core/reference/core/content","$ref":"(sdks)/web-sdk/core/reference/core/content.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/documents.mdx","type":"page","name":"documents","description":"Generated reference for @ovok/core: documents.","icon":"$undefined","url":"/web-sdk/core/reference/core/documents","$ref":"(sdks)/web-sdk/core/reference/core/documents.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/email.mdx","type":"page","name":"email","description":"Generated reference for @ovok/core: email.","icon":"$undefined","url":"/web-sdk/core/reference/core/email","$ref":"(sdks)/web-sdk/core/reference/core/email.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/errors.mdx","type":"page","name":"Errors","description":"Generated reference for @ovok/core: Errors.","icon":"$undefined","url":"/web-sdk/core/reference/core/errors","$ref":"(sdks)/web-sdk/core/reference/core/errors.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/fhir.mdx","type":"page","name":"fhir","description":"Generated reference for @ovok/core: fhir.","icon":"$undefined","url":"/web-sdk/core/reference/core/fhir","$ref":"(sdks)/web-sdk/core/reference/core/fhir.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/health.mdx","type":"page","name":"health","description":"Generated reference for @ovok/core: health.","icon":"$undefined","url":"/web-sdk/core/reference/core/health","$ref":"(sdks)/web-sdk/core/reference/core/health.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/invites.mdx","type":"page","name":"invites","description":"Generated reference for @ovok/core: invites.","icon":"$undefined","url":"/web-sdk/core/reference/core/invites","$ref":"(sdks)/web-sdk/core/reference/core/invites.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/localization.mdx","type":"page","name":"localization","description":"Generated reference for @ovok/core: localization.","icon":"$undefined","url":"/web-sdk/core/reference/core/localization","$ref":"(sdks)/web-sdk/core/reference/core/localization.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/measurements.mdx","type":"page","name":"measurements","description":"Generated reference for @ovok/core: measurements.","icon":"$undefined","url":"/web-sdk/core/reference/core/measurements","$ref":"(sdks)/web-sdk/core/reference/core/measurements.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/ovok-client.mdx","type":"page","name":"Ovok client","description":"Generated reference for @ovok/core: Ovok client.","icon":"$undefined","url":"/web-sdk/core/reference/core/ovok-client","$ref":"(sdks)/web-sdk/core/reference/core/ovok-client.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/patient.mdx","type":"page","name":"patient","description":"Generated reference for @ovok/core: patient.","icon":"$undefined","url":"/web-sdk/core/reference/core/patient","$ref":"(sdks)/web-sdk/core/reference/core/patient.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/projects.mdx","type":"page","name":"projects","description":"Generated reference for @ovok/core: projects.","icon":"$undefined","url":"/web-sdk/core/reference/core/projects","$ref":"(sdks)/web-sdk/core/reference/core/projects.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/questionnaires.mdx","type":"page","name":"questionnaires","description":"Generated reference for @ovok/core: questionnaires.","icon":"$undefined","url":"/web-sdk/core/reference/core/questionnaires","$ref":"(sdks)/web-sdk/core/reference/core/questionnaires.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/realtime.mdx","type":"page","name":"realtime","description":"Generated reference for @ovok/core: realtime.","icon":"$undefined","url":"/web-sdk/core/reference/core/realtime","$ref":"(sdks)/web-sdk/core/reference/core/realtime.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/session.mdx","type":"page","name":"session","description":"Generated reference for @ovok/core: session.","icon":"$undefined","url":"/web-sdk/core/reference/core/session","$ref":"(sdks)/web-sdk/core/reference/core/session.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/sharing.mdx","type":"page","name":"sharing","description":"Generated reference for @ovok/core: sharing.","icon":"$undefined","url":"/web-sdk/core/reference/core/sharing","$ref":"(sdks)/web-sdk/core/reference/core/sharing.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/signals.mdx","type":"page","name":"signals","description":"Generated reference for @ovok/core: signals.","icon":"$undefined","url":"/web-sdk/core/reference/core/signals","$ref":"(sdks)/web-sdk/core/reference/core/signals.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/slim.mdx","type":"page","name":"slim","description":"Generated reference for @ovok/core: slim.","icon":"$undefined","url":"/web-sdk/core/reference/core/slim","$ref":"(sdks)/web-sdk/core/reference/core/slim.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/videocalls.mdx","type":"page","name":"videoCalls","description":"Generated reference for @ovok/core: videoCalls.","icon":"$undefined","url":"/web-sdk/core/reference/core/videocalls","$ref":"(sdks)/web-sdk/core/reference/core/videocalls.mdx"},{"$id":"(sdks)/web-sdk/core/reference/core/wearables.mdx","type":"page","name":"wearables","description":"Generated reference for @ovok/core: wearables.","icon":"$undefined","url":"/web-sdk/core/reference/core/wearables","$ref":"(sdks)/web-sdk/core/reference/core/wearables.mdx"}],"$id":"(sdks)/web-sdk/core/reference/core","$ref":{"folder":"(sdks)/web-sdk/core/reference/core","meta":"(sdks)/web-sdk/core/reference/core/meta.json"},"index":{"$id":"(sdks)/web-sdk/core/reference/core/index.mdx","type":"page","name":"@ovok/core","description":"Generated reference for @ovok/core.","icon":"$undefined","url":"/web-sdk/core/reference/core","$ref":"(sdks)/web-sdk/core/reference/core/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/web-sdk/core/reference/react.mdx","type":"page","name":"@ovok/core/next/react","description":"Generated reference for @ovok/core/next/react.","icon":"$undefined","url":"/web-sdk/core/reference/react","$ref":"(sdks)/web-sdk/core/reference/react.mdx"}],"$id":"(sdks)/web-sdk/core/reference","$ref":{"folder":"(sdks)/web-sdk/core/reference","meta":"(sdks)/web-sdk/core/reference/meta.json"},"index":{"$id":"(sdks)/web-sdk/core/reference/index.mdx","type":"page","name":"API reference","description":"Generated reference for every public export of the JavaScript SDK.","icon":"$undefined","url":"/web-sdk/core/reference","$ref":"(sdks)/web-sdk/core/reference/index.mdx"},"icon":"$undefined"},{"$id":"_44","type":"separator","icon":"$undefined","name":"React Native SDK"},{"$id":"(sdks)/native-sdk/index.mdx","type":"page","name":"React Native SDK","description":"Find the right guide, integration path, or component reference for @ovok/native","icon":"$undefined","url":"/native-sdk","$ref":"(sdks)/native-sdk/index.mdx"},{"type":"folder","name":"Guides","root":"$undefined","defaultOpen":true,"description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/overview.mdx","type":"page","name":"Overview","description":"The end-to-end integration guide for the Ovok React Native SDK","icon":"$undefined","url":"/native-sdk/guide/overview","$ref":"(sdks)/native-sdk/guide/overview.mdx"},{"$id":"(sdks)/native-sdk/guide/getting-started.mdx","type":"page","name":"Getting started","description":"Build and run a first native sign-in flow with @ovok/native","icon":"$undefined","url":"/native-sdk/guide/getting-started","$ref":"(sdks)/native-sdk/guide/getting-started.mdx"},{"type":"folder","name":"How-to guides","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/how-to/installation.mdx","type":"page","name":"Installation and native setup","description":"Install @ovok/native and configure its Expo and native dependencies","icon":"$undefined","url":"/native-sdk/guide/how-to/installation","$ref":"(sdks)/native-sdk/guide/how-to/installation.mdx"},{"$id":"(sdks)/native-sdk/guide/how-to/app-building.mdx","type":"page","name":"Build an app with the SDK","description":"Assemble authentication, native health workflows, and app-owned screens with the OVOK SDK","icon":"$undefined","url":"/native-sdk/guide/how-to/app-building","$ref":"(sdks)/native-sdk/guide/how-to/app-building.mdx"},{"$id":"(sdks)/native-sdk/guide/how-to/app-shell.mdx","type":"page","name":"App shell and providers","description":"Initialize the OVOK client once and compose native, theme, navigation, and feature providers","icon":"$undefined","url":"/native-sdk/guide/how-to/app-shell","$ref":"(sdks)/native-sdk/guide/how-to/app-shell.mdx"},{"$id":"(sdks)/native-sdk/guide/how-to/invites-and-carers.mdx","type":"page","name":"Invites and carers","description":"Share a patient's record, accept care invites, and sign in carers from invite links.","icon":"$undefined","url":"/native-sdk/guide/how-to/invites-and-carers","$ref":"(sdks)/native-sdk/guide/how-to/invites-and-carers.mdx"},{"$id":"(sdks)/native-sdk/guide/how-to/observability.mdx","type":"page","name":"Logs and telemetry","description":"Route Ovok SDK diagnostics to your logger and OpenTelemetry providers","icon":"$undefined","url":"/native-sdk/guide/how-to/observability","$ref":"(sdks)/native-sdk/guide/how-to/observability.mdx"},{"$id":"(sdks)/native-sdk/guide/how-to/reusable-flows.mdx","type":"page","name":"Reusable flows","description":"Integrate Ovok pairing, manual measurement entry, and health access UI","icon":"$undefined","url":"/native-sdk/guide/how-to/reusable-flows","$ref":"(sdks)/native-sdk/guide/how-to/reusable-flows.mdx"},{"$id":"(sdks)/native-sdk/guide/how-to/troubleshooting.mdx","type":"page","name":"Troubleshooting","description":"Diagnose setup, permissions, Bluetooth, health import, and background failures","icon":"$undefined","url":"/native-sdk/guide/how-to/troubleshooting","$ref":"(sdks)/native-sdk/guide/how-to/troubleshooting.mdx"}],"$id":"(sdks)/native-sdk/guide/how-to","$ref":{"folder":"(sdks)/native-sdk/guide/how-to","meta":"(sdks)/native-sdk/guide/how-to/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Modules","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/modules/auth.mdx","type":"page","name":"Authentication","description":"Build sign-in and account flows with the native SDK authentication components.","icon":"$undefined","url":"/native-sdk/guide/modules/auth","$ref":"(sdks)/native-sdk/guide/modules/auth.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/background-sync.mdx","type":"page","name":"Background sync","description":"Choose and configure background delivery for Bluetooth and health data","icon":"$undefined","url":"/native-sdk/guide/modules/background-sync","$ref":"(sdks)/native-sdk/guide/modules/background-sync.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/breathing-exercise.mdx","type":"page","name":"Breathing exercises","description":"Add the SDK's guided breathing exercise to a screen","icon":"$undefined","url":"/native-sdk/guide/modules/breathing-exercise","$ref":"(sdks)/native-sdk/guide/modules/breathing-exercise.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/bt-device-instructions.mdx","type":"page","name":"Device instructions","description":"Show the instruction manual for an integrated Bluetooth device.","icon":"$undefined","url":"/native-sdk/guide/modules/bt-device-instructions","$ref":"(sdks)/native-sdk/guide/modules/bt-device-instructions.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/bt-device.mdx","type":"page","name":"Supported devices and catalog","description":"Read catalog metadata, choose accepted device declarations, and present Bluetooth hardware.","icon":"$undefined","url":"/native-sdk/guide/modules/bt-device","$ref":"(sdks)/native-sdk/guide/modules/bt-device.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/bt-management.mdx","type":"page","name":"Bluetooth","description":"Add Bluetooth LE devices, collect readings, and build a reliable connection flow.","icon":"$undefined","url":"/native-sdk/guide/modules/bt-management","$ref":"(sdks)/native-sdk/guide/modules/bt-management.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/cms.mdx","type":"page","name":"CMS content and translations","description":"Read localized Ovok CMS content and load CMS translations into the host app","icon":"$undefined","url":"/native-sdk/guide/modules/cms","$ref":"(sdks)/native-sdk/guide/modules/cms.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/content.mdx","type":"page","name":"Content components","description":"Compose content cards, lists, and FHIR Composition detail screens","icon":"$undefined","url":"/native-sdk/guide/modules/content","$ref":"(sdks)/native-sdk/guide/modules/content.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/data-sync.mdx","type":"page","name":"HealthKit and Health Connect","description":"Configure permissions and import device health data with the OVOK SDK","icon":"$undefined","url":"/native-sdk/guide/modules/data-sync","$ref":"(sdks)/native-sdk/guide/modules/data-sync.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/diary.mdx","type":"page","name":"Diary cards","description":"Present diary and measurement summaries with the DiaryCard component","icon":"$undefined","url":"/native-sdk/guide/modules/diary","$ref":"(sdks)/native-sdk/guide/modules/diary.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/helpers.mdx","type":"page","name":"SDK helpers","description":"Reuse the SDK's form fields, conditional rendering, and utilities","icon":"$undefined","url":"/native-sdk/guide/modules/helpers","$ref":"(sdks)/native-sdk/guide/modules/helpers.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/image.mdx","type":"page","name":"Optimized images","description":"Render Ovok-hosted images with the SDK's layout and URL helpers","icon":"$undefined","url":"/native-sdk/guide/modules/image","$ref":"(sdks)/native-sdk/guide/modules/image.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/journal.mdx","type":"page","name":"Journal components","description":"Build a daily question, answer form, and past-entry list","icon":"$undefined","url":"/native-sdk/guide/modules/journal","$ref":"(sdks)/native-sdk/guide/modules/journal.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/language-switcher.mdx","type":"page","name":"Language switcher","description":"Connect the controlled language selector to your app's localization layer","icon":"$undefined","url":"/native-sdk/guide/modules/language-switcher","$ref":"(sdks)/native-sdk/guide/modules/language-switcher.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/measurement.mdx","type":"page","name":"Measurement lists","description":"Render measurement rows and date-range controls with app-owned data","icon":"$undefined","url":"/native-sdk/guide/modules/measurement","$ref":"(sdks)/native-sdk/guide/modules/measurement.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/next-background-sync.mdx","type":"page","name":"Background sync on the next client (preview)","description":"Schedule health imports and offline measurement delivery with the next client","icon":"$undefined","url":"/native-sdk/guide/modules/next-background-sync","$ref":"(sdks)/native-sdk/guide/modules/next-background-sync.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/next-bluetooth-web.mdx","type":"page","name":"Bluetooth in browsers (preview)","description":"@ovok/native/next/bluetooth/web: run the integrated devices in a browser over Web Bluetooth.","icon":"$undefined","url":"/native-sdk/guide/modules/next-bluetooth-web","$ref":"(sdks)/native-sdk/guide/modules/next-bluetooth-web.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/next-bluetooth.mdx","type":"page","name":"Bluetooth on the next client (preview)","description":"@ovok/native/next/bluetooth: scan, pick, connect and save readings through the next Ovok client.","icon":"$undefined","url":"/native-sdk/guide/modules/next-bluetooth","$ref":"(sdks)/native-sdk/guide/modules/next-bluetooth.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/next-data-sync.mdx","type":"page","name":"Health sync on the next client (preview)","description":"Import HealthKit and Health Connect records through the next client contract","icon":"$undefined","url":"/native-sdk/guide/modules/next-data-sync","$ref":"(sdks)/native-sdk/guide/modules/next-data-sync.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/next.mdx","type":"page","name":"The next client (preview)","description":"@ovok/native/next: the @ovok/core/next contract with sessions kept in the device's secure store.","icon":"$undefined","url":"/native-sdk/guide/modules/next","$ref":"(sdks)/native-sdk/guide/modules/next.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/observation-detail.mdx","type":"page","name":"Observation detail screens","description":"Present a normalized observation with the ObservationDetail primitives","icon":"$undefined","url":"/native-sdk/guide/modules/observation-detail","$ref":"(sdks)/native-sdk/guide/modules/observation-detail.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/patient.mdx","type":"page","name":"Patient components","description":"Render patient cards and lists from app-owned FHIR resources","icon":"$undefined","url":"/native-sdk/guide/modules/patient","$ref":"(sdks)/native-sdk/guide/modules/patient.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/pdf.mdx","type":"page","name":"PDF viewer","description":"Display a local or remote PDF with the native PDF viewer","icon":"$undefined","url":"/native-sdk/guide/modules/pdf","$ref":"(sdks)/native-sdk/guide/modules/pdf.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/picker-sheet.mdx","type":"page","name":"Picker sheets","description":"Present a selection in a bottom sheet or wheel picker","icon":"$undefined","url":"/native-sdk/guide/modules/picker-sheet","$ref":"(sdks)/native-sdk/guide/modules/picker-sheet.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/polyfills.mdx","type":"page","name":"Polyfills","description":"Install the runtime APIs the Ovok client needs before the app loads.","icon":"$undefined","url":"/native-sdk/guide/modules/polyfills","$ref":"(sdks)/native-sdk/guide/modules/polyfills.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/progress-bar.mdx","type":"page","name":"Progress bars","description":"Show determinate task progress with the ProgressBar component","icon":"$undefined","url":"/native-sdk/guide/modules/progress-bar","$ref":"(sdks)/native-sdk/guide/modules/progress-bar.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/progress-ring.mdx","type":"page","name":"Progress ring","description":"Show determinate or unknown progress in an accessible circular indicator","icon":"$undefined","url":"/native-sdk/guide/modules/progress-ring","$ref":"(sdks)/native-sdk/guide/modules/progress-ring.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/questionnaire-response-form.mdx","type":"page","name":"Questionnaire forms","description":"Render and submit FHIR Questionnaires with the SDK form components","icon":"$undefined","url":"/native-sdk/guide/modules/questionnaire-response-form","$ref":"(sdks)/native-sdk/guide/modules/questionnaire-response-form.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/setting.mdx","type":"page","name":"Settings lists","description":"Build grouped settings screens with the SettingList components","icon":"$undefined","url":"/native-sdk/guide/modules/setting","$ref":"(sdks)/native-sdk/guide/modules/setting.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/socket.mdx","type":"page","name":"Real-time sockets","description":"Connect to Ovok real-time events with SocketProvider and its hooks","icon":"$undefined","url":"/native-sdk/guide/modules/socket","$ref":"(sdks)/native-sdk/guide/modules/socket.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/tab.mdx","type":"page","name":"Tabs","description":"Compose controlled tab navigation with the Tab components","icon":"$undefined","url":"/native-sdk/guide/modules/tab","$ref":"(sdks)/native-sdk/guide/modules/tab.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/theme.mdx","type":"page","name":"Theme","description":"Wrap the app in ThemeProvider and read colors, spacing and fonts with useAppTheme.","icon":"$undefined","url":"/native-sdk/guide/modules/theme","$ref":"(sdks)/native-sdk/guide/modules/theme.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/tile.mdx","type":"page","name":"Measurement tiles","description":"Show measurement value, device status, and task state with Tile","icon":"$undefined","url":"/native-sdk/guide/modules/tile","$ref":"(sdks)/native-sdk/guide/modules/tile.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/ui.mdx","type":"page","name":"App UI","description":"Compose Ovok UI components with your app shell, theme, and feature state","icon":"$undefined","url":"/native-sdk/guide/modules/ui","$ref":"(sdks)/native-sdk/guide/modules/ui.mdx"},{"$id":"(sdks)/native-sdk/guide/modules/wearables.mdx","type":"page","name":"Wearables","description":"Show a wearable provider's icon and display name.","icon":"$undefined","url":"/native-sdk/guide/modules/wearables","$ref":"(sdks)/native-sdk/guide/modules/wearables.mdx"}],"$id":"(sdks)/native-sdk/guide/modules","$ref":{"folder":"(sdks)/native-sdk/guide/modules","meta":"(sdks)/native-sdk/guide/modules/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Components","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Auth Components","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Sign-In","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/container.mdx","type":"page","name":"SignIn Container","description":"Main container component that wraps all sign-in related functionality with scrollable interface and keyboard handling","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/container","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/container.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/footer.mdx","type":"page","name":"SignIn.Footer","description":"Footer component for the sign-in screen with additional links and information","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/footer","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/footer.mdx"},{"type":"folder","name":"SignIn.EmailForm","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/form/forgot-password.mdx","type":"page","name":"SignIn.EmailForm.ForgotPassword","description":"Forgot password link component for navigation to password recovery","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/form/forgot-password","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/form/forgot-password.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/form/inputs.mdx","type":"page","name":"SignIn.EmailForm.Inputs","description":"Email and password input fields with validation and error display","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/form/inputs","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/form/inputs.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/form/signin-button.mdx","type":"page","name":"SignIn.EmailForm.SigninButton","description":"Submit button component with loading states, validation, and error display","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/form/signin-button","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/form/signin-button.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/form/spacing.mdx","type":"page","name":"SignIn.EmailForm.Spacing","description":"Layout spacing component for consistent vertical spacing in SignIn forms","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/form/spacing","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/form/spacing.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/form","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/sign-in/form","meta":"(sdks)/native-sdk/guide/components/auth/sign-in/form/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/form/index.mdx","type":"page","name":"SignIn.EmailForm","description":"Complete email/password authentication interface with validation and error handling","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/form","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/form/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"SignIn.Header","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/header/description.mdx","type":"page","name":"SignIn.Header.Description","description":"Description component for the sign-in header section","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/header/description","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/header/description.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/header/title.mdx","type":"page","name":"SignIn.Header.Title","description":"Title component for the sign-in header section","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/header/title","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/header/title.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/header","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/sign-in/header","meta":"(sdks)/native-sdk/guide/components/auth/sign-in/header/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/header/index.mdx","type":"page","name":"SignIn.Header","description":"Container component for the header section of the sign-in screen","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/header","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/header/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/register-link.mdx","type":"page","name":"SignIn.RegisterLink","description":"Localized link for navigating from sign-in to registration","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/register-link","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/register-link.mdx"},{"type":"folder","name":"SignIn.SocialLogins","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins/apple-login.mdx","type":"page","name":"SignIn.SocialLogins.AppleLogin","description":"Apple authentication button component with Sign in with Apple integration","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/social-logins/apple-login","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins/apple-login.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins/google-login.mdx","type":"page","name":"SignIn.SocialLogins.GoogleLogin","description":"Google authentication button component with OAuth integration and customizable appearance","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/social-logins/google-login","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins/google-login.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins/login-with-separator.mdx","type":"page","name":"SignIn.LoginWithSeparator","description":"Visual separator component to divide email login from social login options with an \"OR\" label","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/social-logins/login-with-separator","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins/login-with-separator.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins","meta":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins/index.mdx","type":"page","name":"SignIn.SocialLogins","description":"Container component for grouping social login buttons with consistent styling and layout","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in/social-logins","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/social-logins/index.mdx"},"icon":"$undefined"}],"$id":"(sdks)/native-sdk/guide/components/auth/sign-in","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/sign-in","meta":"(sdks)/native-sdk/guide/components/auth/sign-in/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/sign-in/index.mdx","type":"page","name":"Sign-In","description":"Add email, social, and MFA sign-in to a React Native app","icon":"$undefined","url":"/native-sdk/guide/components/auth/sign-in","$ref":"(sdks)/native-sdk/guide/components/auth/sign-in/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Registration","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"components","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Register.EmailForm","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/auth/register/components/form/inputs.mdx","type":"page","name":"Register.EmailForm.Inputs","description":"The inputs component provides all form fields needed for user registration including name, surname, email, password, and password confirmation.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/components/form/inputs","$ref":"(sdks)/native-sdk/guide/components/auth/register/components/form/inputs.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/register/components/form/register-button.mdx","type":"page","name":"Register.EmailForm.RegisterButton","description":"The register button component handles form submission with loading states and error display.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/components/form/register-button","$ref":"(sdks)/native-sdk/guide/components/auth/register/components/form/register-button.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/register/components/form/spacing.mdx","type":"page","name":"Register.EmailForm.Spacing","description":"The spacing component provides flexible layout spacing for form elements. This component is shared with the sign-in module.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/components/form/spacing","$ref":"(sdks)/native-sdk/guide/components/auth/register/components/form/spacing.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth/register/components/form","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/register/components/form","meta":"(sdks)/native-sdk/guide/components/auth/register/components/form/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/register/components/form/index.mdx","type":"page","name":"Register.EmailForm","description":"The email form components provide a complete registration interface with validation, error handling, and customization options.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/components/form","$ref":"(sdks)/native-sdk/guide/components/auth/register/components/form/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Register.Header","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/auth/register/components/header/description.mdx","type":"page","name":"Register.Header.Description","description":"The description component displays subtitle text for the registration page.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/components/header/description","$ref":"(sdks)/native-sdk/guide/components/auth/register/components/header/description.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/register/components/header/title.mdx","type":"page","name":"Register.Header.Title","description":"The title component displays the main heading for the registration page.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/components/header/title","$ref":"(sdks)/native-sdk/guide/components/auth/register/components/header/title.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth/register/components/header","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/register/components/header","meta":"(sdks)/native-sdk/guide/components/auth/register/components/header/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/register/components/header/index.mdx","type":"page","name":"Register.Header","description":"The header component provides title and description sections for the registration interface.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/components/header","$ref":"(sdks)/native-sdk/guide/components/auth/register/components/header/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/auth/register/components/register.mdx","type":"page","name":"Register","description":"The main Register component provides a complete registration interface with keyboard-aware scrolling and safe area handling.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/components/register","$ref":"(sdks)/native-sdk/guide/components/auth/register/components/register.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth/register/components","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/register/components","meta":"(sdks)/native-sdk/guide/components/auth/register/components/meta.json"},"icon":"$undefined"},{"type":"folder","name":"examples","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/auth/register/examples/basic-usage.mdx","type":"page","name":"Basic Usage","description":"Learn how to implement basic user registration functionality with the Register component.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/examples/basic-usage","$ref":"(sdks)/native-sdk/guide/components/auth/register/examples/basic-usage.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/register/examples/custom-styling.mdx","type":"page","name":"Custom Styling","description":"Learn how to customize the appearance of registration components to match your app's design.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/examples/custom-styling","$ref":"(sdks)/native-sdk/guide/components/auth/register/examples/custom-styling.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/register/examples/custom-validation.mdx","type":"page","name":"Custom Validation","description":"Learn how to implement custom validation rules for the registration form.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/examples/custom-validation","$ref":"(sdks)/native-sdk/guide/components/auth/register/examples/custom-validation.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/register/examples/pre-filled-data.mdx","type":"page","name":"Pre-filled Data","description":"Learn how to handle registration with pre-existing data and partial user information.","icon":"$undefined","url":"/native-sdk/guide/components/auth/register/examples/pre-filled-data","$ref":"(sdks)/native-sdk/guide/components/auth/register/examples/pre-filled-data.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth/register/examples","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/register/examples","meta":"(sdks)/native-sdk/guide/components/auth/register/examples/meta.json"},"icon":"$undefined"}],"$id":"(sdks)/native-sdk/guide/components/auth/register","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/register","meta":"(sdks)/native-sdk/guide/components/auth/register/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/register/index.mdx","type":"page","name":"Registration","description":"Create an account with the SDK's native registration form","icon":"$undefined","url":"/native-sdk/guide/components/auth/register","$ref":"(sdks)/native-sdk/guide/components/auth/register/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Password Reset","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"components","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"ResetPassword.Form","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form/inputs.mdx","type":"page","name":"ResetPassword.Form.Inputs","description":"Input fields component containing email address input and account type selector for the password reset form.","icon":"$undefined","url":"/native-sdk/guide/components/auth/reset-password/components/form/inputs","$ref":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form/inputs.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form/reset-password-button.mdx","type":"page","name":"ResetPassword.Form.Button","description":"Submit button component for the password reset form with loading states, error display, and proper form integration.","icon":"$undefined","url":"/native-sdk/guide/components/auth/reset-password/components/form/reset-password-button","$ref":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form/reset-password-button.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form/spacing.mdx","type":"page","name":"ResetPassword.Form.Spacing","description":"Flexible spacing component that creates layout space between form elements and pushes the submit button to the bottom of the container.","icon":"$undefined","url":"/native-sdk/guide/components/auth/reset-password/components/form/spacing","$ref":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form/spacing.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form","meta":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form/index.mdx","type":"page","name":"ResetPassword.Form","description":"Form container component that handles password reset validation, submission, and state management using Formik and Yup.","icon":"$undefined","url":"/native-sdk/guide/components/auth/reset-password/components/form","$ref":"(sdks)/native-sdk/guide/components/auth/reset-password/components/form/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"ResetPassword.Header","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components/header/description.mdx","type":"page","name":"ResetPassword.Header.Description","description":"The description component for the password reset header, providing instructional text to guide users through the reset process.","icon":"$undefined","url":"/native-sdk/guide/components/auth/reset-password/components/header/description","$ref":"(sdks)/native-sdk/guide/components/auth/reset-password/components/header/description.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components/header/title.mdx","type":"page","name":"ResetPassword.Header.Title","description":"The title component for the password reset header, displaying the main heading text.","icon":"$undefined","url":"/native-sdk/guide/components/auth/reset-password/components/header/title","$ref":"(sdks)/native-sdk/guide/components/auth/reset-password/components/header/title.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components/header","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/reset-password/components/header","meta":"(sdks)/native-sdk/guide/components/auth/reset-password/components/header/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components/header/index.mdx","type":"page","name":"ResetPassword.Header","description":"Header section component containing title and description for the password reset flow.","icon":"$undefined","url":"/native-sdk/guide/components/auth/reset-password/components/header","$ref":"(sdks)/native-sdk/guide/components/auth/reset-password/components/header/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components/reset-password.mdx","type":"page","name":"ResetPassword Container","description":"The main container component that provides keyboard awareness, safe area handling, and scrolling functionality for the password reset flow.","icon":"$undefined","url":"/native-sdk/guide/components/auth/reset-password/components/reset-password","$ref":"(sdks)/native-sdk/guide/components/auth/reset-password/components/reset-password.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/components","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/reset-password/components","meta":"(sdks)/native-sdk/guide/components/auth/reset-password/components/meta.json"},"icon":"$undefined"}],"$id":"(sdks)/native-sdk/guide/components/auth/reset-password","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth/reset-password","meta":"(sdks)/native-sdk/guide/components/auth/reset-password/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/reset-password/index.mdx","type":"page","name":"Password Reset","description":"Let users request password recovery with the native SDK","icon":"$undefined","url":"/native-sdk/guide/components/auth/reset-password","$ref":"(sdks)/native-sdk/guide/components/auth/reset-password/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/auth/profile.mdx","type":"page","name":"Profile Form","description":"Edit selected fields on the active Patient resource","icon":"$undefined","url":"/native-sdk/guide/components/auth/profile","$ref":"(sdks)/native-sdk/guide/components/auth/profile.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/session.mdx","type":"page","name":"Session Management","description":"Read profile and server-side session state in your app","icon":"$undefined","url":"/native-sdk/guide/components/auth/session","$ref":"(sdks)/native-sdk/guide/components/auth/session.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/logout-button.mdx","type":"page","name":"Logout Button","description":"Add a sign-out action to an account or settings screen","icon":"$undefined","url":"/native-sdk/guide/components/auth/logout-button","$ref":"(sdks)/native-sdk/guide/components/auth/logout-button.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/delete-account-button.mdx","type":"page","name":"Delete Account Button","description":"Add a confirmed account-deletion action to account settings","icon":"$undefined","url":"/native-sdk/guide/components/auth/delete-account-button","$ref":"(sdks)/native-sdk/guide/components/auth/delete-account-button.mdx"},{"$id":"(sdks)/native-sdk/guide/components/auth/hooks.mdx","type":"page","name":"Auth Hooks and Rate Limits","description":"Handle session state and rate limits in custom auth screens","icon":"$undefined","url":"/native-sdk/guide/components/auth/hooks","$ref":"(sdks)/native-sdk/guide/components/auth/hooks.mdx"}],"$id":"(sdks)/native-sdk/guide/components/auth","$ref":{"folder":"(sdks)/native-sdk/guide/components/auth","meta":"(sdks)/native-sdk/guide/components/auth/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/auth/index.mdx","type":"page","name":"Auth Components","description":"Choose the native SDK guide for each authentication flow","icon":"$undefined","url":"/native-sdk/guide/components/auth","$ref":"(sdks)/native-sdk/guide/components/auth/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/background-sync.mdx","type":"page","name":"Background sync APIs","description":"Components and functions for Bluetooth and health data background work","icon":"$undefined","url":"/native-sdk/guide/components/background-sync","$ref":"(sdks)/native-sdk/guide/components/background-sync.mdx"},{"type":"folder","name":"Breathing Exercise","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/breathing-exercise/types.mdx","type":"page","name":"Breathing Exercise Types","description":"Public TypeScript types for the breathing exercise module","icon":"$undefined","url":"/native-sdk/guide/components/breathing-exercise/types","$ref":"(sdks)/native-sdk/guide/components/breathing-exercise/types.mdx"},{"$id":"(sdks)/native-sdk/guide/components/breathing-exercise/breathing-exercise-provider.mdx","type":"page","name":"BreathingExerciseProvider","description":"Provider for the breathing exercise timeline","icon":"$undefined","url":"/native-sdk/guide/components/breathing-exercise/breathing-exercise-provider","$ref":"(sdks)/native-sdk/guide/components/breathing-exercise/breathing-exercise-provider.mdx"},{"$id":"(sdks)/native-sdk/guide/components/breathing-exercise/use-breathing-exercise.mdx","type":"page","name":"useBreathingExercise","description":"Read the active breathing exercise timeline","icon":"$undefined","url":"/native-sdk/guide/components/breathing-exercise/use-breathing-exercise","$ref":"(sdks)/native-sdk/guide/components/breathing-exercise/use-breathing-exercise.mdx"},{"$id":"(sdks)/native-sdk/guide/components/breathing-exercise/breathing-exercise.mdx","type":"page","name":"BreathingExercise Component","description":"The BreathingExercise component is the main compound component that provides a complete guided breathing exercise experience. It serves as both a container and a context provider, offering flexible composition through its sub-components.","icon":"$undefined","url":"/native-sdk/guide/components/breathing-exercise/breathing-exercise","$ref":"(sdks)/native-sdk/guide/components/breathing-exercise/breathing-exercise.mdx"}],"$id":"(sdks)/native-sdk/guide/components/breathing-exercise","$ref":{"folder":"(sdks)/native-sdk/guide/components/breathing-exercise","meta":"(sdks)/native-sdk/guide/components/breathing-exercise/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/breathing-exercise/index.mdx","type":"page","name":"Breathing Exercise","description":"A timed inhale, hold, and exhale compound component","icon":"$undefined","url":"/native-sdk/guide/components/breathing-exercise","$ref":"(sdks)/native-sdk/guide/components/breathing-exercise/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Content","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/content/content-card.mdx","type":"page","name":"ContentCard","description":"Compound card primitives for content previews","icon":"$undefined","url":"/native-sdk/guide/components/content/content-card","$ref":"(sdks)/native-sdk/guide/components/content/content-card.mdx"},{"$id":"(sdks)/native-sdk/guide/components/content/content-detail.mdx","type":"page","name":"ContentDetail","description":"Compound primitives for rendering a FHIR Composition or supplied content","icon":"$undefined","url":"/native-sdk/guide/components/content/content-detail","$ref":"(sdks)/native-sdk/guide/components/content/content-detail.mdx"},{"$id":"(sdks)/native-sdk/guide/components/content/content-list.mdx","type":"page","name":"ContentList","description":"Flat-list primitives for grouped content and horizontal previews","icon":"$undefined","url":"/native-sdk/guide/components/content/content-list","$ref":"(sdks)/native-sdk/guide/components/content/content-list.mdx"},{"$id":"(sdks)/native-sdk/guide/components/content/advanced-api.mdx","type":"page","name":"Composition context","description":"Read a FHIR Composition from ContentDetail descendants","icon":"$undefined","url":"/native-sdk/guide/components/content/advanced-api","$ref":"(sdks)/native-sdk/guide/components/content/advanced-api.mdx"}],"$id":"(sdks)/native-sdk/guide/components/content","$ref":{"folder":"(sdks)/native-sdk/guide/components/content","meta":"(sdks)/native-sdk/guide/components/content/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/content/index.mdx","type":"page","name":"Content","description":"Content cards, lists, and FHIR Composition detail primitives","icon":"$undefined","url":"/native-sdk/guide/components/content","$ref":"(sdks)/native-sdk/guide/components/content/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Helpers","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/helpers/conditional.mdx","type":"page","name":"Conditional","description":"Render children only when a boolean condition is true","icon":"$undefined","url":"/native-sdk/guide/components/helpers/conditional","$ref":"(sdks)/native-sdk/guide/components/helpers/conditional.mdx"},{"type":"folder","name":"Form helpers","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/helpers/forms/form-date-field.mdx","type":"page","name":"FormDateField","description":"Formik-connected date, time, or datetime picker field","icon":"$undefined","url":"/native-sdk/guide/components/helpers/forms/form-date-field","$ref":"(sdks)/native-sdk/guide/components/helpers/forms/form-date-field.mdx"},{"$id":"(sdks)/native-sdk/guide/components/helpers/forms/form-field.mdx","type":"page","name":"FormField","description":"Formik-connected text input with touched error display","icon":"$undefined","url":"/native-sdk/guide/components/helpers/forms/form-field","$ref":"(sdks)/native-sdk/guide/components/helpers/forms/form-field.mdx"},{"$id":"(sdks)/native-sdk/guide/components/helpers/forms/form-select.mdx","type":"page","name":"FormSelect","description":"Formik-connected dropdown for a list of options","icon":"$undefined","url":"/native-sdk/guide/components/helpers/forms/form-select","$ref":"(sdks)/native-sdk/guide/components/helpers/forms/form-select.mdx"}],"$id":"(sdks)/native-sdk/guide/components/helpers/forms","$ref":{"folder":"(sdks)/native-sdk/guide/components/helpers/forms","meta":"(sdks)/native-sdk/guide/components/helpers/forms/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/helpers/forms/index.mdx","type":"page","name":"Form helpers","description":"Formik-connected text, select, and date fields","icon":"$undefined","url":"/native-sdk/guide/components/helpers/forms","$ref":"(sdks)/native-sdk/guide/components/helpers/forms/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/helpers/logging.mdx","type":"page","name":"Logging","description":"Configure the Ovok SDK logger and use its logging helpers","icon":"$undefined","url":"/native-sdk/guide/components/helpers/logging","$ref":"(sdks)/native-sdk/guide/components/helpers/logging.mdx"},{"$id":"(sdks)/native-sdk/guide/components/helpers/telemetry.mdx","type":"page","name":"Telemetry","description":"Configure OpenTelemetry providers and use Ovok spans, metrics, events, and attributes","icon":"$undefined","url":"/native-sdk/guide/components/helpers/telemetry","$ref":"(sdks)/native-sdk/guide/components/helpers/telemetry.mdx"},{"$id":"(sdks)/native-sdk/guide/components/helpers/with-animated.mdx","type":"page","name":"withAnimated","description":"Create a Reanimated-compatible wrapper for a component","icon":"$undefined","url":"/native-sdk/guide/components/helpers/with-animated","$ref":"(sdks)/native-sdk/guide/components/helpers/with-animated.mdx"}],"$id":"(sdks)/native-sdk/guide/components/helpers","$ref":{"folder":"(sdks)/native-sdk/guide/components/helpers","meta":"(sdks)/native-sdk/guide/components/helpers/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/helpers/index.mdx","type":"page","name":"Helpers","description":"Small utilities re-exported by @ovok/native - Conditional, Formik form fields, structured logging, and telemetry","icon":"$undefined","url":"/native-sdk/guide/components/helpers","$ref":"(sdks)/native-sdk/guide/components/helpers/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"LanguageSwitcher","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/language-switcher/advanced-api.mdx","type":"page","name":"Language switcher hook and context","description":"Read the selected language inside a LanguageSwitcher option","icon":"$undefined","url":"/native-sdk/guide/components/language-switcher/advanced-api","$ref":"(sdks)/native-sdk/guide/components/language-switcher/advanced-api.mdx"},{"$id":"(sdks)/native-sdk/guide/components/language-switcher/flag.mdx","type":"page","name":"LanguageSwitcher.Option.Flag","description":"A flexible container component for displaying language flags or flag-related imagery. Provides consistent styling and layout for visual language identification elements.","icon":"$undefined","url":"/native-sdk/guide/components/language-switcher/flag","$ref":"(sdks)/native-sdk/guide/components/language-switcher/flag.mdx"},{"$id":"(sdks)/native-sdk/guide/components/language-switcher/label.mdx","type":"page","name":"LanguageSwitcher.Option.Label","description":"A text component for displaying language names with consistent typography and styling. Built on react-native-paper Text component with custom font styling and theme integration.","icon":"$undefined","url":"/native-sdk/guide/components/language-switcher/label","$ref":"(sdks)/native-sdk/guide/components/language-switcher/label.mdx"},{"$id":"(sdks)/native-sdk/guide/components/language-switcher/language-switcher.mdx","type":"page","name":"LanguageSwitcher","description":"A provider component that manages language selection state through React Context API. Serves as the main container for language option components with automatic state management and theme integration.","icon":"$undefined","url":"/native-sdk/guide/components/language-switcher/language-switcher","$ref":"(sdks)/native-sdk/guide/components/language-switcher/language-switcher.mdx"},{"$id":"(sdks)/native-sdk/guide/components/language-switcher/language-switcher-option.mdx","type":"page","name":"LanguageSwitcher.Option","description":"A touchable option component for individual language selection. Provides context for its child components and handles selection state, styling, and interaction feedback with Material Design 3 theming.","icon":"$undefined","url":"/native-sdk/guide/components/language-switcher/language-switcher-option","$ref":"(sdks)/native-sdk/guide/components/language-switcher/language-switcher-option.mdx"},{"$id":"(sdks)/native-sdk/guide/components/language-switcher/radio-button.mdx","type":"page","name":"LanguageSwitcher.Option.RadioButton","description":"A radio button control component that automatically manages selection state based on the parent language option context. Built on react-native-paper RadioButton.Android with disabled pointer events for seamless parent option interaction.","icon":"$undefined","url":"/native-sdk/guide/components/language-switcher/radio-button","$ref":"(sdks)/native-sdk/guide/components/language-switcher/radio-button.mdx"}],"$id":"(sdks)/native-sdk/guide/components/language-switcher","$ref":{"folder":"(sdks)/native-sdk/guide/components/language-switcher","meta":"(sdks)/native-sdk/guide/components/language-switcher/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/language-switcher/index.mdx","type":"page","name":"LanguageSwitcher","description":"Controlled language selection compound component","icon":"$undefined","url":"/native-sdk/guide/components/language-switcher","$ref":"(sdks)/native-sdk/guide/components/language-switcher/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Measurement","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/measurement/measurement-list.mdx","type":"page","name":"MeasurementList","description":"FlashList wrapper with default measurement rows","icon":"$undefined","url":"/native-sdk/guide/components/measurement/measurement-list","$ref":"(sdks)/native-sdk/guide/components/measurement/measurement-list.mdx"},{"$id":"(sdks)/native-sdk/guide/components/measurement/measurement-list-item.mdx","type":"page","name":"MeasurementList.Item","description":"Touchable value, unit, and timestamp row","icon":"$undefined","url":"/native-sdk/guide/components/measurement/measurement-list-item","$ref":"(sdks)/native-sdk/guide/components/measurement/measurement-list-item.mdx"},{"$id":"(sdks)/native-sdk/guide/components/measurement/date-range.mdx","type":"page","name":"MeasurementList.DateRange","description":"Navigate fixed week, month, or year ranges","icon":"$undefined","url":"/native-sdk/guide/components/measurement/date-range","$ref":"(sdks)/native-sdk/guide/components/measurement/date-range.mdx"}],"$id":"(sdks)/native-sdk/guide/components/measurement","$ref":{"folder":"(sdks)/native-sdk/guide/components/measurement","meta":"(sdks)/native-sdk/guide/components/measurement/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/measurement/index.mdx","type":"page","name":"Measurement","description":"List and date-range primitives for measurement summaries","icon":"$undefined","url":"/native-sdk/guide/components/measurement","$ref":"(sdks)/native-sdk/guide/components/measurement/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/polyfills.mdx","type":"page","name":"Polyfills and runtime setup","description":"Initialize runtime APIs required by the Ovok client","icon":"$undefined","url":"/native-sdk/guide/components/polyfills","$ref":"(sdks)/native-sdk/guide/components/polyfills.mdx"},{"$id":"(sdks)/native-sdk/guide/components/progress-bar.mdx","type":"page","name":"ProgressBar","description":"Animated progress indicator component with smooth spring transitions and SharedValue support","icon":"$undefined","url":"/native-sdk/guide/components/progress-bar","$ref":"(sdks)/native-sdk/guide/components/progress-bar.mdx"},{"type":"folder","name":"QuestionnaireResponseForm","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"QuestionnaireForm.Content","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content/all-items.mdx","type":"page","name":"QuestionnaireForm.Content.AllItems","description":"Render all currently enabled questionnaire items","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/content/all-items","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content/all-items.mdx"},{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content/error.mdx","type":"page","name":"QuestionnaireForm.Content.Error","description":"Show validation and submission errors with retry","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/content/error","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content/error.mdx"},{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content/item.mdx","type":"page","name":"QuestionnaireContent.Item","description":"Renders the current questionnaire item for paged mode, automatically handling field type selection and conditional logic.","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/content/item","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content/item.mdx"}],"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content","$ref":{"folder":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content","meta":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content/index.mdx","type":"page","name":"QuestionnaireForm.Content","description":"Content primitives for current or all enabled questionnaire items","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/content","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/content/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"QuestionnaireForm.Navigation","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation/next-button.mdx","type":"page","name":"QuestionnaireForm.Navigation.NextButton","description":"Advance to the next enabled questionnaire item","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/navigation/next-button","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation/next-button.mdx"},{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation/previous-button.mdx","type":"page","name":"QuestionnaireForm.Navigation.PreviousButton","description":"Return to the previous questionnaire item","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/navigation/previous-button","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation/previous-button.mdx"},{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation/submit-button.mdx","type":"page","name":"QuestionnaireForm.Navigation.SubmitButton","description":"Submit the questionnaire response","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/navigation/submit-button","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation/submit-button.mdx"}],"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation","$ref":{"folder":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation","meta":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation/index.mdx","type":"page","name":"QuestionnaireForm.Navigation","description":"Keyboard-aware navigation controls for the form","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/navigation","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/navigation/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/advanced-api.mdx","type":"page","name":"Providers, hooks, and submit utilities","description":"Advanced public exports for custom questionnaire renderers","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/advanced-api","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/advanced-api.mdx"},{"type":"folder","name":"QuestionnaireHeader","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/header/subtitle.mdx","type":"page","name":"QuestionnaireHeader.Subtitle","description":"Displays progress information using an app-owned i18next translation key and formatting.","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/header/subtitle","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/header/subtitle.mdx"},{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/header/title.mdx","type":"page","name":"QuestionnaireHeader.Title","description":"Displays the questionnaire title with automatic fallback and customizable styling.","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/header/title","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/header/title.mdx"}],"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/header","$ref":{"folder":"(sdks)/native-sdk/guide/components/questionnaire-response-form/header","meta":"(sdks)/native-sdk/guide/components/questionnaire-response-form/header/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/header/index.mdx","type":"page","name":"QuestionnaireHeader","description":"The header components provide title display and progress tracking for questionnaire forms. These components work together to create informative headers that guide users through multi-page questionnaires with clear navigation context.","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form/header","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/header/index.mdx"},"icon":"$undefined"}],"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form","$ref":{"folder":"(sdks)/native-sdk/guide/components/questionnaire-response-form","meta":"(sdks)/native-sdk/guide/components/questionnaire-response-form/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/questionnaire-response-form/index.mdx","type":"page","name":"QuestionnaireResponseForm","description":"A FHIR Questionnaire renderer with optional paging and submission","icon":"$undefined","url":"/native-sdk/guide/components/questionnaire-response-form","$ref":"(sdks)/native-sdk/guide/components/questionnaire-response-form/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Socket","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/socket/hooks.mdx","type":"page","name":"Socket hooks","description":"Read socket status and subscribe to AI session messages","icon":"$undefined","url":"/native-sdk/guide/components/socket/hooks","$ref":"(sdks)/native-sdk/guide/components/socket/hooks.mdx"},{"$id":"(sdks)/native-sdk/guide/components/socket/socket-provider.mdx","type":"page","name":"SocketProvider","description":"Create one authenticated Socket.IO connection for real-time SDK events","icon":"$undefined","url":"/native-sdk/guide/components/socket/socket-provider","$ref":"(sdks)/native-sdk/guide/components/socket/socket-provider.mdx"},{"$id":"(sdks)/native-sdk/guide/components/socket/types.mdx","type":"page","name":"Socket types and context","description":"Public types for the socket provider and its context","icon":"$undefined","url":"/native-sdk/guide/components/socket/types","$ref":"(sdks)/native-sdk/guide/components/socket/types.mdx"}],"$id":"(sdks)/native-sdk/guide/components/socket","$ref":{"folder":"(sdks)/native-sdk/guide/components/socket","meta":"(sdks)/native-sdk/guide/components/socket/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/socket/index.mdx","type":"page","name":"Socket","description":"Real-time socket connection to the Ovok backend - SocketProvider, useSocket hook, and AI event listener","icon":"$undefined","url":"/native-sdk/guide/components/socket","$ref":"(sdks)/native-sdk/guide/components/socket/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/progress-ring.mdx","type":"page","name":"ProgressRing","description":"Accessible circular progress with a distinct unknown state and optional center content","icon":"$undefined","url":"/native-sdk/guide/components/progress-ring","$ref":"(sdks)/native-sdk/guide/components/progress-ring.mdx"},{"type":"folder","name":"Theme","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/theme/theme-provider.mdx","type":"page","name":"ThemeProvider","description":"Load SDK fonts and provide the generated React Native Paper theme","icon":"$undefined","url":"/native-sdk/guide/components/theme/theme-provider","$ref":"(sdks)/native-sdk/guide/components/theme/theme-provider.mdx"},{"$id":"(sdks)/native-sdk/guide/components/theme/use-app-theme.mdx","type":"page","name":"useAppTheme","description":"Read the generated Paper theme and SDK spacing helpers","icon":"$undefined","url":"/native-sdk/guide/components/theme/use-app-theme","$ref":"(sdks)/native-sdk/guide/components/theme/use-app-theme.mdx"},{"$id":"(sdks)/native-sdk/guide/components/theme/colors.mdx","type":"page","name":"Colors","description":"Default MD3 and healthcare color tokens exported by the SDK","icon":"$undefined","url":"/native-sdk/guide/components/theme/colors","$ref":"(sdks)/native-sdk/guide/components/theme/colors.mdx"},{"$id":"(sdks)/native-sdk/guide/components/theme/multipliers.mdx","type":"page","name":"Multipliers","description":"Configure spacing and border-radius calculation helpers","icon":"$undefined","url":"/native-sdk/guide/components/theme/multipliers","$ref":"(sdks)/native-sdk/guide/components/theme/multipliers.mdx"}],"$id":"(sdks)/native-sdk/guide/components/theme","$ref":{"folder":"(sdks)/native-sdk/guide/components/theme","meta":"(sdks)/native-sdk/guide/components/theme/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/theme/index.mdx","type":"page","name":"Theme","description":"Comprehensive theming system with Material Design 3, custom colors, and responsive spacing","icon":"$undefined","url":"/native-sdk/guide/components/theme","$ref":"(sdks)/native-sdk/guide/components/theme/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/wearables.mdx","type":"page","name":"WearableProviderIcon","description":"Icons and display names for wearable providers and phone health stores","icon":"$undefined","url":"/native-sdk/guide/components/wearables","$ref":"(sdks)/native-sdk/guide/components/wearables.mdx"},{"type":"folder","name":"Tab","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/tab/tab.mdx","type":"page","name":"Tab Container","description":"Main tab container component that manages state and provides context for tab items","icon":"$undefined","url":"/native-sdk/guide/components/tab/tab","$ref":"(sdks)/native-sdk/guide/components/tab/tab.mdx"},{"$id":"(sdks)/native-sdk/guide/components/tab/tab-item.mdx","type":"page","name":"Tab.Item","description":"Individual tab item component with icon support, active/inactive states, and theme integration","icon":"$undefined","url":"/native-sdk/guide/components/tab/tab-item","$ref":"(sdks)/native-sdk/guide/components/tab/tab-item.mdx"},{"$id":"(sdks)/native-sdk/guide/components/tab/advanced-api.mdx","type":"page","name":"TabProvider and useTab","description":"Share controlled tab state with a custom tab bar","icon":"$undefined","url":"/native-sdk/guide/components/tab/advanced-api","$ref":"(sdks)/native-sdk/guide/components/tab/advanced-api.mdx"}],"$id":"(sdks)/native-sdk/guide/components/tab","$ref":{"folder":"(sdks)/native-sdk/guide/components/tab","meta":"(sdks)/native-sdk/guide/components/tab/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/tab/index.mdx","type":"page","name":"Tab","description":"Flexible tab navigation component system with compound components and theme integration","icon":"$undefined","url":"/native-sdk/guide/components/tab","$ref":"(sdks)/native-sdk/guide/components/tab/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Setting","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/setting/setting-list.mdx","type":"page","name":"SettingList","description":"High-performance list component built on FlashList for settings screens with section headers and custom components","icon":"$undefined","url":"/native-sdk/guide/components/setting/setting-list","$ref":"(sdks)/native-sdk/guide/components/setting/setting-list.mdx"},{"$id":"(sdks)/native-sdk/guide/components/setting/setting-list-item.mdx","type":"page","name":"SettingListItem","description":"Individual setting item component with icon support, navigation arrows, and theme integration","icon":"$undefined","url":"/native-sdk/guide/components/setting/setting-list-item","$ref":"(sdks)/native-sdk/guide/components/setting/setting-list-item.mdx"},{"$id":"(sdks)/native-sdk/guide/components/setting/list-header.mdx","type":"page","name":"ListHeader","description":"Section header component for grouping settings with dynamic spacing based on position","icon":"$undefined","url":"/native-sdk/guide/components/setting/list-header","$ref":"(sdks)/native-sdk/guide/components/setting/list-header.mdx"}],"$id":"(sdks)/native-sdk/guide/components/setting","$ref":{"folder":"(sdks)/native-sdk/guide/components/setting","meta":"(sdks)/native-sdk/guide/components/setting/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/setting/index.mdx","type":"page","name":"Setting","description":"High-performance setting list components with FlashList, custom items, and section headers","icon":"$undefined","url":"/native-sdk/guide/components/setting","$ref":"(sdks)/native-sdk/guide/components/setting/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"PickerSheet","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/picker-sheet/picker-sheet.mdx","type":"page","name":"PickerSheet","description":"Bottom sheet modal container with backdrop and safe area handling for picker interfaces","icon":"$undefined","url":"/native-sdk/guide/components/picker-sheet/picker-sheet","$ref":"(sdks)/native-sdk/guide/components/picker-sheet/picker-sheet.mdx"},{"$id":"(sdks)/native-sdk/guide/components/picker-sheet/wheel-picker.mdx","type":"page","name":"WheelPicker","description":"iOS-style wheel picker with smooth scrolling, visual feedback, and performance optimizations","icon":"$undefined","url":"/native-sdk/guide/components/picker-sheet/wheel-picker","$ref":"(sdks)/native-sdk/guide/components/picker-sheet/wheel-picker.mdx"}],"$id":"(sdks)/native-sdk/guide/components/picker-sheet","$ref":{"folder":"(sdks)/native-sdk/guide/components/picker-sheet","meta":"(sdks)/native-sdk/guide/components/picker-sheet/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/picker-sheet/index.mdx","type":"page","name":"PickerSheet","description":"Bottom sheet picker components with animated wheel picker for seamless selection experiences","icon":"$undefined","url":"/native-sdk/guide/components/picker-sheet","$ref":"(sdks)/native-sdk/guide/components/picker-sheet/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Tile","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/tile/tile.mdx","type":"page","name":"Tile Component","description":"Main container component for displaying measurement data with interactive states and visual feedback","icon":"$undefined","url":"/native-sdk/guide/components/tile/tile","$ref":"(sdks)/native-sdk/guide/components/tile/tile.mdx"},{"$id":"(sdks)/native-sdk/guide/components/tile/start-section.mdx","type":"page","name":"Tile.StartSection","description":"Header section component that displays task icon, completion state, and optional right-side content","icon":"$undefined","url":"/native-sdk/guide/components/tile/start-section","$ref":"(sdks)/native-sdk/guide/components/tile/start-section.mdx"},{"$id":"(sdks)/native-sdk/guide/components/tile/title.mdx","type":"page","name":"Tile.Title","description":"Title text component for displaying measurement task names with consistent typography","icon":"$undefined","url":"/native-sdk/guide/components/tile/title","$ref":"(sdks)/native-sdk/guide/components/tile/title.mdx"},{"$id":"(sdks)/native-sdk/guide/components/tile/task-icon.mdx","type":"page","name":"Tile.TaskIcon","description":"Healthcare measurement type icons with SVG rendering and theme integration","icon":"$undefined","url":"/native-sdk/guide/components/tile/task-icon","$ref":"(sdks)/native-sdk/guide/components/tile/task-icon.mdx"},{"$id":"(sdks)/native-sdk/guide/components/tile/measured-value.mdx","type":"page","name":"Tile.MeasuredValue","description":"Display component for measurement results with value, unit, and timestamp","icon":"$undefined","url":"/native-sdk/guide/components/tile/measured-value","$ref":"(sdks)/native-sdk/guide/components/tile/measured-value.mdx"},{"$id":"(sdks)/native-sdk/guide/components/tile/measuring-spinner.mdx","type":"page","name":"Tile.MeasuringSpinner","description":"Loading indicator component for active measurement states","icon":"$undefined","url":"/native-sdk/guide/components/tile/measuring-spinner","$ref":"(sdks)/native-sdk/guide/components/tile/measuring-spinner.mdx"},{"$id":"(sdks)/native-sdk/guide/components/tile/no-measured-value.mdx","type":"page","name":"Tile.NoMeasuredValue","description":"Placeholder component for displaying when no measurement data is available","icon":"$undefined","url":"/native-sdk/guide/components/tile/no-measured-value","$ref":"(sdks)/native-sdk/guide/components/tile/no-measured-value.mdx"},{"$id":"(sdks)/native-sdk/guide/components/tile/status.mdx","type":"page","name":"Tile.Status","description":"Device connection status indicator with colored text and localized messages","icon":"$undefined","url":"/native-sdk/guide/components/tile/status","$ref":"(sdks)/native-sdk/guide/components/tile/status.mdx"},{"$id":"(sdks)/native-sdk/guide/components/tile/complete-animation.mdx","type":"page","name":"Tile.CompleteAnimation","description":"Success animation overlay component for celebrating completed measurements","icon":"$undefined","url":"/native-sdk/guide/components/tile/complete-animation","$ref":"(sdks)/native-sdk/guide/components/tile/complete-animation.mdx"}],"$id":"(sdks)/native-sdk/guide/components/tile","$ref":{"folder":"(sdks)/native-sdk/guide/components/tile","meta":"(sdks)/native-sdk/guide/components/tile/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/tile/index.mdx","type":"page","name":"Tile","description":"Interactive measurement display components for healthcare applications with progress states and device connectivity","icon":"$undefined","url":"/native-sdk/guide/components/tile","$ref":"(sdks)/native-sdk/guide/components/tile/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/cms.mdx","type":"page","name":"CMS hooks","description":"Localized CMS content, legal pages, release notes, and i18next translations","icon":"$undefined","url":"/native-sdk/guide/components/cms","$ref":"(sdks)/native-sdk/guide/components/cms.mdx"},{"type":"folder","name":"Bluetooth device UI","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/bt-device/bt-device-instruction.mdx","type":"page","name":"BTDeviceInstruction","description":"Display the SDK-hosted manual associated with an integrated Bluetooth device.","icon":"$undefined","url":"/native-sdk/guide/components/bt-device/bt-device-instruction","$ref":"(sdks)/native-sdk/guide/components/bt-device/bt-device-instruction.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-device/bt-device-item.mdx","type":"page","name":"BTDeviceItem","description":"Compound themed row for Bluetooth device cards and lists.","icon":"$undefined","url":"/native-sdk/guide/components/bt-device/bt-device-item","$ref":"(sdks)/native-sdk/guide/components/bt-device/bt-device-item.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-device/bt-device-list.mdx","type":"page","name":"BTDeviceList","description":"Render the SDK device rows and connection statuses from DeviceListProvider.","icon":"$undefined","url":"/native-sdk/guide/components/bt-device/bt-device-list","$ref":"(sdks)/native-sdk/guide/components/bt-device/bt-device-list.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-device/device-list-provider.mdx","type":"page","name":"DeviceListProvider","description":"Provide the device-list context used by BTDeviceList and BTProvider status updates.","icon":"$undefined","url":"/native-sdk/guide/components/bt-device/device-list-provider","$ref":"(sdks)/native-sdk/guide/components/bt-device/device-list-provider.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-device/supported-device-list.mdx","type":"page","name":"SupportedDeviceList","description":"Render the static device catalog with names, images, and image credits.","icon":"$undefined","url":"/native-sdk/guide/components/bt-device/supported-device-list","$ref":"(sdks)/native-sdk/guide/components/bt-device/supported-device-list.mdx"}],"$id":"(sdks)/native-sdk/guide/components/bt-device","$ref":{"folder":"(sdks)/native-sdk/guide/components/bt-device","meta":"(sdks)/native-sdk/guide/components/bt-device/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/bt-device/index.mdx","type":"page","name":"Bluetooth device UI","description":"Components for showing supported devices, connection status, and device instructions.","icon":"$undefined","url":"/native-sdk/guide/components/bt-device","$ref":"(sdks)/native-sdk/guide/components/bt-device/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/bt-device-instructions.mdx","type":"page","name":"Bluetooth device instructions","description":"Show an SDK-hosted instruction PDF for an integrated Bluetooth device.","icon":"$undefined","url":"/native-sdk/guide/components/bt-device-instructions","$ref":"(sdks)/native-sdk/guide/components/bt-device-instructions.mdx"},{"type":"folder","name":"Bluetooth management","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/bt-management/advanced-usage.mdx","type":"page","name":"Advanced Bluetooth usage","description":"Manage a Bluetooth session directly, tune runtime hooks, and use deterministic BLE fixtures.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/advanced-usage","$ref":"(sdks)/native-sdk/guide/components/bt-management/advanced-usage.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/bluetooth-device-picker.mdx","type":"page","name":"BluetoothDevicePicker","description":"Render a chooser for multiple devices discovered by BTProvider auto-connect.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/bluetooth-device-picker","$ref":"(sdks)/native-sdk/guide/components/bt-management/bluetooth-device-picker.mdx"},{"type":"folder","name":"BTProvider","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-access-permission-changed.mdx","type":"page","name":"onAccessPermissionChanged","description":"React to the Bluetooth permission result reported by BTProvider.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/bt-provider/on-access-permission-changed","$ref":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-access-permission-changed.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-connection-event.mdx","type":"page","name":"onConnectionEvent","description":"Observe pairing, bond, battery, and transfer events from a Bluetooth device.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/bt-provider/on-connection-event","$ref":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-connection-event.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-device-found.mdx","type":"page","name":"onDeviceFound","description":"Handle a supported Bluetooth device when the SDK discovers it.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/bt-provider/on-device-found","$ref":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-device-found.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-device-selection-required.mdx","type":"page","name":"onDeviceSelectionRequired","description":"Present a user choice when auto-connect discovers multiple accepted devices.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/bt-provider/on-device-selection-required","$ref":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-device-selection-required.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-device-status-changed.mdx","type":"page","name":"onDeviceStatusChanged","description":"Observe compact status changes for accepted Bluetooth devices.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/bt-provider/on-device-status-changed","$ref":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-device-status-changed.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-error.mdx","type":"page","name":"onError","description":"Receive Bluetooth runtime and device measurement failures.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/bt-provider/on-error","$ref":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-error.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-result.mdx","type":"page","name":"onResult","description":"Receive normalized measurements from a Bluetooth device.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/bt-provider/on-result","$ref":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/on-result.mdx"}],"$id":"(sdks)/native-sdk/guide/components/bt-management/bt-provider","$ref":{"folder":"(sdks)/native-sdk/guide/components/bt-management/bt-provider","meta":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/index.mdx","type":"page","name":"BTProvider","description":"Own a Bluetooth LE session and receive device, connection, measurement, and error events.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/bt-provider","$ref":"(sdks)/native-sdk/guide/components/bt-management/bt-provider/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/custom-devices.mdx","type":"page","name":"Custom devices","description":"Declare a supported Bluetooth device when the SDK has no built-in protocol.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/custom-devices","$ref":"(sdks)/native-sdk/guide/components/bt-management/custom-devices.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/default-permission-fallback.mdx","type":"page","name":"DefaultPermissionFallback","description":"Default permission prompt used when Bluetooth access has not been granted.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/default-permission-fallback","$ref":"(sdks)/native-sdk/guide/components/bt-management/default-permission-fallback.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/device-services.mdx","type":"page","name":"Bluetooth services and protocols","description":"Public session and protocol APIs for Bluetooth integrations.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/device-services","$ref":"(sdks)/native-sdk/guide/components/bt-management/device-services.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/device-types.mdx","type":"page","name":"Bluetooth device types","description":"Understand integrated device keys, decodable protocols, standard profiles, and custom declarations.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/device-types","$ref":"(sdks)/native-sdk/guide/components/bt-management/device-types.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/hooks.mdx","type":"page","name":"Bluetooth hooks","description":"React hooks for Bluetooth runtime state, nearby devices, results, pairing, and scan control.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/hooks","$ref":"(sdks)/native-sdk/guide/components/bt-management/hooks.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/runtime-provider.mdx","type":"page","name":"BluetoothRuntimeProvider","description":"Low-level provider for composing Bluetooth runtime hooks outside BTProvider.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/runtime-provider","$ref":"(sdks)/native-sdk/guide/components/bt-management/runtime-provider.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/supported-devices.mdx","type":"page","name":"Supported devices","description":"Use the SDK's Bluetooth catalog to select supported devices and accepted protocol declarations.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/supported-devices","$ref":"(sdks)/native-sdk/guide/components/bt-management/supported-devices.mdx"},{"$id":"(sdks)/native-sdk/guide/components/bt-management/types.mdx","type":"page","name":"Bluetooth types","description":"Public types used by Bluetooth providers, results, errors, devices, and custom declarations.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management/types","$ref":"(sdks)/native-sdk/guide/components/bt-management/types.mdx"}],"$id":"(sdks)/native-sdk/guide/components/bt-management","$ref":{"folder":"(sdks)/native-sdk/guide/components/bt-management","meta":"(sdks)/native-sdk/guide/components/bt-management/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/bt-management/index.mdx","type":"page","name":"Bluetooth management","description":"Public Bluetooth runtime, provider, hooks, device definitions, and UI entry points.","icon":"$undefined","url":"/native-sdk/guide/components/bt-management","$ref":"(sdks)/native-sdk/guide/components/bt-management/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"DataSync","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"android","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/data-sync/android/health-connect-authorization-provider.mdx","type":"page","name":"AndroidHealthConnectAuthorizationProvider","description":"Initialize Health Connect and request its permissions","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/android/health-connect-authorization-provider","$ref":"(sdks)/native-sdk/guide/components/data-sync/android/health-connect-authorization-provider.mdx"},{"$id":"(sdks)/native-sdk/guide/components/data-sync/android/health-sync.mdx","type":"page","name":"AndroidHealthSync","description":"Read Health Connect records and save mapped OVOK observations","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/android/health-sync","$ref":"(sdks)/native-sdk/guide/components/data-sync/android/health-sync.mdx"}],"$id":"(sdks)/native-sdk/guide/components/data-sync/android","$ref":{"folder":"(sdks)/native-sdk/guide/components/data-sync/android","meta":"(sdks)/native-sdk/guide/components/data-sync/android/meta.json"},"icon":"$undefined"},{"type":"folder","name":"apple","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/data-sync/apple/health-authorization-provider.mdx","type":"page","name":"AppleHealthAuthorizationProvider","description":"Request HealthKit permissions and expose authorization state","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/apple/health-authorization-provider","$ref":"(sdks)/native-sdk/guide/components/data-sync/apple/health-authorization-provider.mdx"},{"$id":"(sdks)/native-sdk/guide/components/data-sync/apple/health-sync.mdx","type":"page","name":"AppleHealthSync","description":"Read HealthKit samples and save mapped OVOK observations","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/apple/health-sync","$ref":"(sdks)/native-sdk/guide/components/data-sync/apple/health-sync.mdx"}],"$id":"(sdks)/native-sdk/guide/components/data-sync/apple","$ref":{"folder":"(sdks)/native-sdk/guide/components/data-sync/apple","meta":"(sdks)/native-sdk/guide/components/data-sync/apple/meta.json"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/data-sync/data-sync.mdx","type":"page","name":"DataSync compound API","description":"Platform component members exposed by the DataSync namespace","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/data-sync","$ref":"(sdks)/native-sdk/guide/components/data-sync/data-sync.mdx"},{"type":"folder","name":"ManuallyRequestSheet","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/container.mdx","type":"page","name":"ManuallyRequestSheet.Container","description":"Themed bottom-sheet content with safe-area spacing","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/manually-request-sheet/container","$ref":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/container.mdx"},{"$id":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/description.mdx","type":"page","name":"ManuallyRequestSheet.Description","description":"Themed body copy for a health permission prompt","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/manually-request-sheet/description","$ref":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/description.mdx"},{"$id":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/image.mdx","type":"page","name":"ManuallyRequestSheet.Image","description":"Artwork slot for the health permission prompt","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/manually-request-sheet/image","$ref":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/image.mdx"},{"$id":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/request-button.mdx","type":"page","name":"ManuallyRequestSheet.RequestButton","description":"Contained action button for requesting health permissions","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/manually-request-sheet/request-button","$ref":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/request-button.mdx"},{"$id":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/skip-button.mdx","type":"page","name":"ManuallyRequestSheet.SkipButton","description":"Text action button for a host-defined skip action","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/manually-request-sheet/skip-button","$ref":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/skip-button.mdx"},{"$id":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/title.mdx","type":"page","name":"ManuallyRequestSheet.Title","description":"Themed title text for a health permission prompt","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/manually-request-sheet/title","$ref":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/title.mdx"}],"$id":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet","$ref":{"folder":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet","meta":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/index.mdx","type":"page","name":"ManuallyRequestSheet","description":"Compound bottom-sheet UI for a host-owned health permission request","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/manually-request-sheet","$ref":"(sdks)/native-sdk/guide/components/data-sync/manually-request-sheet/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/data-sync/sync-progress-list.mdx","type":"page","name":"SyncProgressList","description":"Render per-type health import state and progress","icon":"$undefined","url":"/native-sdk/guide/components/data-sync/sync-progress-list","$ref":"(sdks)/native-sdk/guide/components/data-sync/sync-progress-list.mdx"}],"$id":"(sdks)/native-sdk/guide/components/data-sync","$ref":{"folder":"(sdks)/native-sdk/guide/components/data-sync","meta":"(sdks)/native-sdk/guide/components/data-sync/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/data-sync/index.mdx","type":"page","name":"DataSync","description":"Public module reference for HealthKit and Health Connect imports","icon":"$undefined","url":"/native-sdk/guide/components/data-sync","$ref":"(sdks)/native-sdk/guide/components/data-sync/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"diary","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/diary/diary-card.mdx","type":"page","name":"DiaryCard","description":"The DiaryCard component is a specialized interactive card designed for displaying health measurement data and diary entries. It extends TouchableOpacity with healthcare-specific styling and automatic visual state management based on data availability.","icon":"$undefined","url":"/native-sdk/guide/components/diary/diary-card","$ref":"(sdks)/native-sdk/guide/components/diary/diary-card.mdx"},{"$id":"(sdks)/native-sdk/guide/components/diary/measured-value.mdx","type":"page","name":"DiaryCard.MeasuredValue","description":"Displays a measured value with unit and timestamp. Inherited from the Tile module and themed for consistency across diary cards.","icon":"$undefined","url":"/native-sdk/guide/components/diary/measured-value","$ref":"(sdks)/native-sdk/guide/components/diary/measured-value.mdx"},{"$id":"(sdks)/native-sdk/guide/components/diary/no-data.mdx","type":"page","name":"DiaryCard.NoData","description":"The DiaryCard.NoData component displays a localized message indicating that no measurement data is available. It provides consistent empty state messaging for diary cards with internationalization support and theme-aware styling.","icon":"$undefined","url":"/native-sdk/guide/components/diary/no-data","$ref":"(sdks)/native-sdk/guide/components/diary/no-data.mdx"},{"$id":"(sdks)/native-sdk/guide/components/diary/start-section.mdx","type":"page","name":"DiaryCard.StartSection","description":"The DiaryCard.StartSection component provides a horizontal layout container for the header section of diary cards. It manages the placement of icons, labels, and optional right-side content with automatic fallback to an arrow icon when no right content is provided.","icon":"$undefined","url":"/native-sdk/guide/components/diary/start-section","$ref":"(sdks)/native-sdk/guide/components/diary/start-section.mdx"},{"$id":"(sdks)/native-sdk/guide/components/diary/task-icon.mdx","type":"page","name":"DiaryCard.TaskIcon","description":"The DiaryCard.TaskIcon component displays a measurement type icon. It is inherited from the Tile module's TaskIcon and exposed on DiaryCard for convenience.","icon":"$undefined","url":"/native-sdk/guide/components/diary/task-icon","$ref":"(sdks)/native-sdk/guide/components/diary/task-icon.mdx"},{"$id":"(sdks)/native-sdk/guide/components/diary/title.mdx","type":"page","name":"DiaryCard.Title","description":"Title text for diary cards. Inherited from the Tile module and styled with large title typography.","icon":"$undefined","url":"/native-sdk/guide/components/diary/title","$ref":"(sdks)/native-sdk/guide/components/diary/title.mdx"}],"$id":"(sdks)/native-sdk/guide/components/diary","$ref":{"folder":"(sdks)/native-sdk/guide/components/diary","meta":"(sdks)/native-sdk/guide/components/diary/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/diary/index.mdx","type":"page","name":"Diary","description":"A specialized card component system for displaying health measurement data and diary entries in healthcare applications. The Diary module provides interactive cards with measurement display capabilities, designed for medical tracking and patient monitoring workflows.","icon":"$undefined","url":"/native-sdk/guide/components/diary","$ref":"(sdks)/native-sdk/guide/components/diary/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/image.mdx","type":"page","name":"Image","description":"Image rendering exports from the @ovok/native/image module","icon":"$undefined","url":"/native-sdk/guide/components/image","$ref":"(sdks)/native-sdk/guide/components/image.mdx"},{"type":"folder","name":"journal","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/journal/answer.mdx","type":"page","name":"Answer","description":"The Answer component provides a keyboard-aware scrollable container for journal entry forms. It combines KeyboardAwareScrollView with KeyboardToolbar to create an optimal mobile input experience for healthcare questionnaires and journal entries.","icon":"$undefined","url":"/native-sdk/guide/components/journal/answer","$ref":"(sdks)/native-sdk/guide/components/journal/answer.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/answer-actions.mdx","type":"page","name":"Answer.Actions","description":"The Answer.Actions component provides a themed container for action buttons at the bottom of journal entry forms. It applies consistent horizontal padding and serves as a wrapper for submission, navigation, and other form-related buttons.","icon":"$undefined","url":"/native-sdk/guide/components/journal/answer-actions","$ref":"(sdks)/native-sdk/guide/components/journal/answer-actions.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/answer-header.mdx","type":"page","name":"Answer.Header","description":"The Answer.Header component provides a horizontal layout container for form navigation and action elements. It's designed to house back buttons, progress indicators, save actions, and other form-related controls at the top of journal entry screens.","icon":"$undefined","url":"/native-sdk/guide/components/journal/answer-header","$ref":"(sdks)/native-sdk/guide/components/journal/answer-header.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/answer-input.mdx","type":"page","name":"Answer.Input","description":"The Answer.Input component renders React Native's TextInput with the","icon":"$undefined","url":"/native-sdk/guide/components/journal/answer-input","$ref":"(sdks)/native-sdk/guide/components/journal/answer-input.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/answer-question.mdx","type":"page","name":"Answer.Question","description":"The Answer.Question component displays question text in journal and questionnaire forms. It provides consistent typography and styling for question prompts with emphasis on readability and accessibility.","icon":"$undefined","url":"/native-sdk/guide/components/journal/answer-question","$ref":"(sdks)/native-sdk/guide/components/journal/answer-question.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/past-journal-card.mdx","type":"page","name":"PastJournalCard","description":"The PastJournalCard component displays completed journal entries and questionnaire responses in a Material Design card format. It provides a structured layout for showing historical health data, patient responses, and journal content.","icon":"$undefined","url":"/native-sdk/guide/components/journal/past-journal-card","$ref":"(sdks)/native-sdk/guide/components/journal/past-journal-card.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/past-journal-card-answer.mdx","type":"page","name":"PastJournalCard.Answer","description":"The PastJournalCard.Answer component renders the answer text of a past journal entry with a subtle color.","icon":"$undefined","url":"/native-sdk/guide/components/journal/past-journal-card-answer","$ref":"(sdks)/native-sdk/guide/components/journal/past-journal-card-answer.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/past-journal-card-date.mdx","type":"page","name":"PastJournalCard.Date","description":"The PastJournalCard.Date component displays the date of a past journal entry with subdued emphasis.","icon":"$undefined","url":"/native-sdk/guide/components/journal/past-journal-card-date","$ref":"(sdks)/native-sdk/guide/components/journal/past-journal-card-date.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/past-journal-card-title.mdx","type":"page","name":"PastJournalCard.Title","description":"The PastJournalCard.Title component renders the title text for a past journal entry with appropriate typography and weight.","icon":"$undefined","url":"/native-sdk/guide/components/journal/past-journal-card-title","$ref":"(sdks)/native-sdk/guide/components/journal/past-journal-card-title.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/today-question-card.mdx","type":"page","name":"TodayQuestionCard","description":"The TodayQuestionCard component displays daily questions and prompts in an interactive card format with gradient background support. It's designed for engaging daily health check-ins, questionnaires, and journal prompts with visual appeal and clear call-to-action elements.","icon":"$undefined","url":"/native-sdk/guide/components/journal/today-question-card","$ref":"(sdks)/native-sdk/guide/components/journal/today-question-card.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/today-question-card-actions.mdx","type":"page","name":"TodayQuestionCard.Actions","description":"The TodayQuestionCard.Actions component aligns action items to the right with consistent spacing.","icon":"$undefined","url":"/native-sdk/guide/components/journal/today-question-card-actions","$ref":"(sdks)/native-sdk/guide/components/journal/today-question-card-actions.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/today-question-card-content.mdx","type":"page","name":"TodayQuestionCard.Content","description":"The TodayQuestionCard.Content component is a padded container that spaces inner elements consistently.","icon":"$undefined","url":"/native-sdk/guide/components/journal/today-question-card-content","$ref":"(sdks)/native-sdk/guide/components/journal/today-question-card-content.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/today-question-card-gradient.mdx","type":"page","name":"TodayQuestionCard.Gradient","description":"The TodayQuestionCard.Gradient component provides a gradient background using expo-linear-gradient for visually appealing daily prompts.","icon":"$undefined","url":"/native-sdk/guide/components/journal/today-question-card-gradient","$ref":"(sdks)/native-sdk/guide/components/journal/today-question-card-gradient.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/today-question-card-question.mdx","type":"page","name":"TodayQuestionCard.Question","description":"The TodayQuestionCard.Question component renders the question text prominently.","icon":"$undefined","url":"/native-sdk/guide/components/journal/today-question-card-question","$ref":"(sdks)/native-sdk/guide/components/journal/today-question-card-question.mdx"},{"$id":"(sdks)/native-sdk/guide/components/journal/today-question-card-title.mdx","type":"page","name":"TodayQuestionCard.Title","description":"The TodayQuestionCard.Title component renders the card title with the theme primary color.","icon":"$undefined","url":"/native-sdk/guide/components/journal/today-question-card-title","$ref":"(sdks)/native-sdk/guide/components/journal/today-question-card-title.mdx"}],"$id":"(sdks)/native-sdk/guide/components/journal","$ref":{"folder":"(sdks)/native-sdk/guide/components/journal","meta":"(sdks)/native-sdk/guide/components/journal/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/journal/index.mdx","type":"page","name":"Journal","description":"A comprehensive set of React Native components for building journal and questionnaire interfaces in healthcare applications. The Journal module provides keyboard-aware forms, question-answer flows, and display components for past entries.","icon":"$undefined","url":"/native-sdk/guide/components/journal","$ref":"(sdks)/native-sdk/guide/components/journal/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"observation-detail","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/observation-detail/data-container.mdx","type":"page","name":"ObservationDetail.DataContainer","description":"A themed card container component for grouping related observation data with consistent styling, shadows, and Material Design 3 theming. Provides structured presentation for healthcare information.","icon":"$undefined","url":"/native-sdk/guide/components/observation-detail/data-container","$ref":"(sdks)/native-sdk/guide/components/observation-detail/data-container.mdx"},{"$id":"(sdks)/native-sdk/guide/components/observation-detail/date-time.mdx","type":"page","name":"ObservationDetail.DateTime","description":"A date and time display component with flexible formatting options and fallback content support. Designed for healthcare observation timestamps with localization and conditional rendering capabilities.","icon":"$undefined","url":"/native-sdk/guide/components/observation-detail/date-time","$ref":"(sdks)/native-sdk/guide/components/observation-detail/date-time.mdx"},{"$id":"(sdks)/native-sdk/guide/components/observation-detail/observation-detail.mdx","type":"page","name":"ObservationDetail","description":"A scrollable container component designed for displaying healthcare observation data with automatic safe area handling and theme-based spacing. Serves as the main container for compound observation detail components.","icon":"$undefined","url":"/native-sdk/guide/components/observation-detail/observation-detail","$ref":"(sdks)/native-sdk/guide/components/observation-detail/observation-detail.mdx"},{"$id":"(sdks)/native-sdk/guide/components/observation-detail/photo-preview.mdx","type":"page","name":"ObservationDetail.PhotoPreview","description":"An advanced photo gallery component with thumbnail navigation and full-screen modal preview. Built on FlashList for high performance with large photo sets and includes rotation, navigation, and zoom capabilities.","icon":"$undefined","url":"/native-sdk/guide/components/observation-detail/photo-preview","$ref":"(sdks)/native-sdk/guide/components/observation-detail/photo-preview.mdx"},{"$id":"(sdks)/native-sdk/guide/components/observation-detail/resource.mdx","type":"page","name":"ObservationDetail.Resource","description":"A resource information component for displaying data source details with optional imagery. Used to indicate the origin or method of data collection in healthcare observations.","icon":"$undefined","url":"/native-sdk/guide/components/observation-detail/resource","$ref":"(sdks)/native-sdk/guide/components/observation-detail/resource.mdx"},{"$id":"(sdks)/native-sdk/guide/components/observation-detail/single-card-data-row.mdx","type":"page","name":"ObservationDetail.SingleCardDataRow","description":"A label-value data row component designed for structured display of healthcare information. Provides consistent spacing, typography, and layout for observation data presentation.","icon":"$undefined","url":"/native-sdk/guide/components/observation-detail/single-card-data-row","$ref":"(sdks)/native-sdk/guide/components/observation-detail/single-card-data-row.mdx"},{"$id":"(sdks)/native-sdk/guide/components/observation-detail/text-data.mdx","type":"page","name":"ObservationDetail.TextData","description":"A text content component with consistent padding and typography for displaying narrative healthcare information. Designed for clinical notes, descriptions, and unstructured observation data.","icon":"$undefined","url":"/native-sdk/guide/components/observation-detail/text-data","$ref":"(sdks)/native-sdk/guide/components/observation-detail/text-data.mdx"}],"$id":"(sdks)/native-sdk/guide/components/observation-detail","$ref":{"folder":"(sdks)/native-sdk/guide/components/observation-detail","meta":"(sdks)/native-sdk/guide/components/observation-detail/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/observation-detail/index.mdx","type":"page","name":"ObservationDetail","description":"The ObservationDetail module provides a comprehensive solution for displaying detailed healthcare observation data in a structured, scrollable layout. Built as a compound component system optimized for medical data presentation with support for various data types, photos, and resource information.","icon":"$undefined","url":"/native-sdk/guide/components/observation-detail","$ref":"(sdks)/native-sdk/guide/components/observation-detail/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/optimized-image.mdx","type":"page","name":"optimized-image","description":"OptimizedImage is a layout and retry wrapper around expo-image. It reads the","icon":"$undefined","url":"/native-sdk/guide/components/optimized-image","$ref":"(sdks)/native-sdk/guide/components/optimized-image.mdx"},{"type":"folder","name":"patient","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"PatientCard.BirthDate","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/patient/patient-birth-date/icon.mdx","type":"page","name":"PatientCard.BirthDate.Icon","description":"Calendar icon component using Calendar2 from iconsax-react-nativejs.","icon":"$undefined","url":"/native-sdk/guide/components/patient/patient-birth-date/icon","$ref":"(sdks)/native-sdk/guide/components/patient/patient-birth-date/icon.mdx"},{"$id":"(sdks)/native-sdk/guide/components/patient/patient-birth-date/text.mdx","type":"page","name":"PatientCard.BirthDate.Text","description":"Date and age text display component with flexible formatting.","icon":"$undefined","url":"/native-sdk/guide/components/patient/patient-birth-date/text","$ref":"(sdks)/native-sdk/guide/components/patient/patient-birth-date/text.mdx"}],"$id":"(sdks)/native-sdk/guide/components/patient/patient-birth-date","$ref":{"folder":"(sdks)/native-sdk/guide/components/patient/patient-birth-date","meta":"(sdks)/native-sdk/guide/components/patient/patient-birth-date/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/patient/patient-birth-date/index.mdx","type":"page","name":"PatientCard.BirthDate","description":"A compound component for displaying patient birth date and age information with calendar icon support. Provides flexible date formatting and age calculation for healthcare applications.","icon":"$undefined","url":"/native-sdk/guide/components/patient/patient-birth-date","$ref":"(sdks)/native-sdk/guide/components/patient/patient-birth-date/index.mdx"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/components/patient/patient-card.mdx","type":"page","name":"PatientCard","description":"A touchable card container component designed for displaying patient information in healthcare applications. Built with compound architecture to provide flexible composition of patient data elements with consistent Material Design 3 styling; add accessibility semantics through the touchable props in the host app.","icon":"$undefined","url":"/native-sdk/guide/components/patient/patient-card","$ref":"(sdks)/native-sdk/guide/components/patient/patient-card.mdx"},{"$id":"(sdks)/native-sdk/guide/components/patient/patient-gender.mdx","type":"page","name":"PatientCard.Gender","description":"A visual gender indicator component with icon support and themed styling. Provides accessible gender display for healthcare applications with localization support and multiple visual variants.","icon":"$undefined","url":"/native-sdk/guide/components/patient/patient-gender","$ref":"(sdks)/native-sdk/guide/components/patient/patient-gender.mdx"},{"$id":"(sdks)/native-sdk/guide/components/patient/patient-list.mdx","type":"page","name":"PatientList","description":"High-performance patient directory component built on FlashList for efficient rendering of large patient datasets. Provides default patient card rendering with customizable item rendering and automatic spacing.","icon":"$undefined","url":"/native-sdk/guide/components/patient/patient-list","$ref":"(sdks)/native-sdk/guide/components/patient/patient-list.mdx"},{"$id":"(sdks)/native-sdk/guide/components/patient/patient-meta.mdx","type":"page","name":"PatientCard.Meta","description":"A flexible container component for organizing patient metadata and secondary information. Provides consistent spacing and responsive layout for patient demographics and additional details.","icon":"$undefined","url":"/native-sdk/guide/components/patient/patient-meta","$ref":"(sdks)/native-sdk/guide/components/patient/patient-meta.mdx"},{"$id":"(sdks)/native-sdk/guide/components/patient/patient-name.mdx","type":"page","name":"PatientCard.Name","description":"A text component for displaying patient names with configurable formatting options. Built to work with FHIR HumanName resources and provides intelligent fallbacks for missing or incomplete name data in healthcare applications.","icon":"$undefined","url":"/native-sdk/guide/components/patient/patient-name","$ref":"(sdks)/native-sdk/guide/components/patient/patient-name.mdx"}],"$id":"(sdks)/native-sdk/guide/components/patient","$ref":{"folder":"(sdks)/native-sdk/guide/components/patient","meta":"(sdks)/native-sdk/guide/components/patient/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/patient/index.mdx","type":"page","name":"Patient","description":"The Patient module provides a comprehensive solution for displaying and managing patient information in healthcare applications. Built on top of FHIR Patient resources with compound components, localization support, and performance optimizations using FlashList.","icon":"$undefined","url":"/native-sdk/guide/components/patient","$ref":"(sdks)/native-sdk/guide/components/patient/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"PDF","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/pdf/pdf-viewer.mdx","type":"page","name":"PDFViewer","description":"PDF document viewer component built on react-native-pdf with enhanced loading states, theme integration, and automatic error handling. Provides a seamless document viewing experience with smooth loading animations and consistent styling.","icon":"$undefined","url":"/native-sdk/guide/components/pdf/pdf-viewer","$ref":"(sdks)/native-sdk/guide/components/pdf/pdf-viewer.mdx"}],"$id":"(sdks)/native-sdk/guide/components/pdf","$ref":{"folder":"(sdks)/native-sdk/guide/components/pdf","meta":"(sdks)/native-sdk/guide/components/pdf/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/pdf/index.mdx","type":"page","name":"PDF","description":"Theme-aware native PDF rendering with loading and callback support","icon":"$undefined","url":"/native-sdk/guide/components/pdf","$ref":"(sdks)/native-sdk/guide/components/pdf/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"App UI components","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/guide/components/ui/background-sync-setting.mdx","type":"page","name":"BackgroundSyncSetting","description":"Let a user enable Bluetooth background scanning","icon":"$undefined","url":"/native-sdk/guide/components/ui/background-sync-setting","$ref":"(sdks)/native-sdk/guide/components/ui/background-sync-setting.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/bluetooth-state-notice.mdx","type":"page","name":"BluetoothStateNotice","description":"Show Bluetooth availability and offer a permission or settings action","icon":"$undefined","url":"/native-sdk/guide/components/ui/bluetooth-state-notice","$ref":"(sdks)/native-sdk/guide/components/ui/bluetooth-state-notice.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/calendar.mdx","type":"page","name":"Calendar","description":"Accessible, locale-aware date selection for React Native apps","icon":"$undefined","url":"/native-sdk/guide/components/ui/calendar","$ref":"(sdks)/native-sdk/guide/components/ui/calendar.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/ecg-strip-viewer.mdx","type":"page","name":"EcgStripViewer","description":"Render app-provided ECG samples as a paged, scrollable waveform strip.","icon":"$undefined","url":"/native-sdk/guide/components/ui/ecg-strip-viewer","$ref":"(sdks)/native-sdk/guide/components/ui/ecg-strip-viewer.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/flow-frame.mdx","type":"page","name":"FlowFrame","description":"Safe-area and keyboard-aware layout for host-owned multi-step flows","icon":"$undefined","url":"/native-sdk/guide/components/ui/flow-frame","$ref":"(sdks)/native-sdk/guide/components/ui/flow-frame.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/health-import-card.mdx","type":"page","name":"HealthImportCard","description":"Show health access status and request access through an app adapter","icon":"$undefined","url":"/native-sdk/guide/components/ui/health-import-card","$ref":"(sdks)/native-sdk/guide/components/ui/health-import-card.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/manual-entry-form.mdx","type":"page","name":"ManualEntryForm","description":"Collect and validate a numeric measurement for app-owned saving","icon":"$undefined","url":"/native-sdk/guide/components/ui/manual-entry-form","$ref":"(sdks)/native-sdk/guide/components/ui/manual-entry-form.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/measurement-trend-chart.mdx","type":"page","name":"MeasurementTrendChart","description":"Themeable multi-series measurement trend and sparkline charts","icon":"$undefined","url":"/native-sdk/guide/components/ui/measurement-trend-chart","$ref":"(sdks)/native-sdk/guide/components/ui/measurement-trend-chart.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/nearby-device-prompt.mdx","type":"page","name":"NearbyDevicePrompt","description":"An opt-in prompt for pairing a supported device found nearby","icon":"$undefined","url":"/native-sdk/guide/components/ui/nearby-device-prompt","$ref":"(sdks)/native-sdk/guide/components/ui/nearby-device-prompt.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/pairing-flow.mdx","type":"page","name":"PairingFlow","description":"Pair a discovered Bluetooth device and persist its ID","icon":"$undefined","url":"/native-sdk/guide/components/ui/pairing-flow","$ref":"(sdks)/native-sdk/guide/components/ui/pairing-flow.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/period-calendar.mdx","type":"page","name":"PeriodCalendar","description":"Calendar-based visualization for host-supplied period intervals","icon":"$undefined","url":"/native-sdk/guide/components/ui/period-calendar","$ref":"(sdks)/native-sdk/guide/components/ui/period-calendar.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/prerequisite-gate.mdx","type":"page","name":"PrerequisiteGate","description":"Wait for a host-authorized account prerequisite check before rendering app content","icon":"$undefined","url":"/native-sdk/guide/components/ui/prerequisite-gate","$ref":"(sdks)/native-sdk/guide/components/ui/prerequisite-gate.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/reusable-flows.mdx","type":"page","name":"Reusable flows","description":"Higher-level pairing, manual-entry, and health-access UI components","icon":"$undefined","url":"/native-sdk/guide/components/ui/reusable-flows","$ref":"(sdks)/native-sdk/guide/components/ui/reusable-flows.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/supported-devices-catalog-list.mdx","type":"page","name":"SupportedDevicesCatalogList","description":"Display the supported-device catalog with connection declarations and measurement metadata.","icon":"$undefined","url":"/native-sdk/guide/components/ui/supported-devices-catalog-list","$ref":"(sdks)/native-sdk/guide/components/ui/supported-devices-catalog-list.mdx"},{"$id":"(sdks)/native-sdk/guide/components/ui/urine-test-result.mdx","type":"page","name":"UrineTestResult","description":"Present an existing urine-analysis measurement with accessible analyte rows","icon":"$undefined","url":"/native-sdk/guide/components/ui/urine-test-result","$ref":"(sdks)/native-sdk/guide/components/ui/urine-test-result.mdx"}],"$id":"(sdks)/native-sdk/guide/components/ui","$ref":{"folder":"(sdks)/native-sdk/guide/components/ui","meta":"(sdks)/native-sdk/guide/components/ui/meta.json"},"index":{"$id":"(sdks)/native-sdk/guide/components/ui/index.mdx","type":"page","name":"App UI components","description":"Public component and theming exports from @ovok/native/ui","icon":"$undefined","url":"/native-sdk/guide/components/ui","$ref":"(sdks)/native-sdk/guide/components/ui/index.mdx"},"icon":"$undefined"}],"$id":"(sdks)/native-sdk/guide/components","$ref":{"folder":"(sdks)/native-sdk/guide/components","meta":"(sdks)/native-sdk/guide/components/meta.json"},"icon":"$undefined"},{"$id":"(sdks)/native-sdk/guide/architecture.mdx","type":"page","name":"Architecture and lifecycle","description":"Understand SDK boundaries, provider lifetimes, and foreground and background data flows.","icon":"$undefined","url":"/native-sdk/guide/architecture","$ref":"(sdks)/native-sdk/guide/architecture.mdx"},{"$id":"(sdks)/native-sdk/guide/sdk-features.mdx","type":"page","name":"Reusable SDK features","description":"The SDK exposes integration primitives and optional composition UI, not an application","icon":"$undefined","url":"/native-sdk/guide/sdk-features","$ref":"(sdks)/native-sdk/guide/sdk-features.mdx"},{"$id":"(sdks)/native-sdk/guide/measurement-field-catalog.mdx","type":"page","name":"Measurement field catalog","description":"Canonical units, validation bounds, and optional display ranges for decoded measurements","icon":"$undefined","url":"/native-sdk/guide/measurement-field-catalog","$ref":"(sdks)/native-sdk/guide/measurement-field-catalog.mdx"},{"$id":"(sdks)/native-sdk/guide/public-api.mdx","type":"page","name":"Public API map","description":"Root exports and subpath imports for @ovok/native","icon":"$undefined","url":"/native-sdk/guide/public-api","$ref":"(sdks)/native-sdk/guide/public-api.mdx"},{"$id":"(sdks)/native-sdk/guide/release-and-development.mdx","type":"page","name":"Development and release","description":"Build, test, document, and release the SDK safely","icon":"$undefined","url":"/native-sdk/guide/release-and-development","$ref":"(sdks)/native-sdk/guide/release-and-development.mdx"},{"$id":"(sdks)/native-sdk/guide/supported-devices.mdx","type":"page","name":"Supported Bluetooth devices","description":"Complete list of devices in the @ovok/native Bluetooth catalog.","icon":"$undefined","url":"/native-sdk/guide/supported-devices","$ref":"(sdks)/native-sdk/guide/supported-devices.mdx"}],"$id":"(sdks)/native-sdk/guide","$ref":{"folder":"(sdks)/native-sdk/guide","meta":"(sdks)/native-sdk/guide/meta.json"},"icon":"$undefined"},{"type":"folder","name":"API reference","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/native-sdk/reference/auth.mdx","type":"page","name":"auth","description":"Sign-in, registration, password reset, profile and session components and hooks.","icon":"$undefined","url":"/native-sdk/reference/auth","$ref":"(sdks)/native-sdk/reference/auth.mdx"},{"$id":"(sdks)/native-sdk/reference/background-sync.mdx","type":"page","name":"background-sync","description":"Android background sync, the Bluetooth foreground service, sync notifications and background-safe storage.","icon":"$undefined","url":"/native-sdk/reference/background-sync","$ref":"(sdks)/native-sdk/reference/background-sync.mdx"},{"$id":"(sdks)/native-sdk/reference/breathing-exercise.mdx","type":"page","name":"breathing-exercise","description":"Guided breathing exercise component, provider and hook.","icon":"$undefined","url":"/native-sdk/reference/breathing-exercise","$ref":"(sdks)/native-sdk/reference/breathing-exercise.mdx"},{"$id":"(sdks)/native-sdk/reference/bt-device-instructions.mdx","type":"page","name":"bt-device-instructions","description":"Device instruction screens and the bundled instruction PDFs for supported Bluetooth devices.","icon":"$undefined","url":"/native-sdk/reference/bt-device-instructions","$ref":"(sdks)/native-sdk/reference/bt-device-instructions.mdx"},{"$id":"(sdks)/native-sdk/reference/bt-device.mdx","type":"page","name":"bt-device","description":"Bluetooth device lists, the supported-device catalog and device images.","icon":"$undefined","url":"/native-sdk/reference/bt-device","$ref":"(sdks)/native-sdk/reference/bt-device.mdx"},{"$id":"(sdks)/native-sdk/reference/bt-management.mdx","type":"page","name":"bt-management","description":"Bluetooth Low Energy device management: scanning, pairing, connecting, reading measurements and syncing them.","icon":"$undefined","url":"/native-sdk/reference/bt-management","$ref":"(sdks)/native-sdk/reference/bt-management.mdx"},{"$id":"(sdks)/native-sdk/reference/cms.mdx","type":"page","name":"cms","description":"Hooks that read CMS content, locales and translations.","icon":"$undefined","url":"/native-sdk/reference/cms","$ref":"(sdks)/native-sdk/reference/cms.mdx"},{"$id":"(sdks)/native-sdk/reference/content.mdx","type":"page","name":"content","description":"Content cards, lists and detail screens for educational content.","icon":"$undefined","url":"/native-sdk/reference/content","$ref":"(sdks)/native-sdk/reference/content.mdx"},{"$id":"(sdks)/native-sdk/reference/data-sync.mdx","type":"page","name":"data-sync","description":"Apple Health and Health Connect import: authorization, sync progress and manual request UI.","icon":"$undefined","url":"/native-sdk/reference/data-sync","$ref":"(sdks)/native-sdk/reference/data-sync.mdx"},{"$id":"(sdks)/native-sdk/reference/diary.mdx","type":"page","name":"diary","description":"Diary card component.","icon":"$undefined","url":"/native-sdk/reference/diary","$ref":"(sdks)/native-sdk/reference/diary.mdx"},{"$id":"(sdks)/native-sdk/reference/helpers.mdx","type":"page","name":"helpers","description":"Shared helpers: form fields, conditional rendering, formatting utilities, logging and telemetry.","icon":"$undefined","url":"/native-sdk/reference/helpers","$ref":"(sdks)/native-sdk/reference/helpers.mdx"},{"$id":"(sdks)/native-sdk/reference/image.mdx","type":"page","name":"image","description":"Optimized image component.","icon":"$undefined","url":"/native-sdk/reference/image","$ref":"(sdks)/native-sdk/reference/image.mdx"},{"$id":"(sdks)/native-sdk/reference/journal.mdx","type":"page","name":"journal","description":"Journal question, answer and history components.","icon":"$undefined","url":"/native-sdk/reference/journal","$ref":"(sdks)/native-sdk/reference/journal.mdx"},{"$id":"(sdks)/native-sdk/reference/language-switcher.mdx","type":"page","name":"language-switcher","description":"Language switcher component, context and hook.","icon":"$undefined","url":"/native-sdk/reference/language-switcher","$ref":"(sdks)/native-sdk/reference/language-switcher.mdx"},{"$id":"(sdks)/native-sdk/reference/measurement.mdx","type":"page","name":"measurement","description":"Measurement list components.","icon":"$undefined","url":"/native-sdk/reference/measurement","$ref":"(sdks)/native-sdk/reference/measurement.mdx"},{"$id":"(sdks)/native-sdk/reference/next-background-sync.mdx","type":"page","name":"next/background-sync","description":"Background sync helpers for `@ovok/native/next`.","icon":"$undefined","url":"/native-sdk/reference/next-background-sync","$ref":"(sdks)/native-sdk/reference/next-background-sync.mdx"},{"$id":"(sdks)/native-sdk/reference/next-bluetooth.mdx","type":"page","name":"next/bluetooth","description":"Bluetooth for `@ovok/native/next`, in layers: the framework-free `BluetoothRuntime` and its ports, device drivers,","icon":"$undefined","url":"/native-sdk/reference/next-bluetooth","$ref":"(sdks)/native-sdk/reference/next-bluetooth.mdx"},{"$id":"(sdks)/native-sdk/reference/next-bluetooth-web.mdx","type":"page","name":"next/bluetooth/web","description":"Bluetooth for `@ovok/native/next` in browsers, over Web Bluetooth: the same `BluetoothRuntime`, devices, result","icon":"$undefined","url":"/native-sdk/reference/next-bluetooth-web","$ref":"(sdks)/native-sdk/reference/next-bluetooth-web.mdx"},{"$id":"(sdks)/native-sdk/reference/next-data-sync.mdx","type":"page","name":"next/data-sync","description":"HealthKit and Health Connect import for `@ovok/native/next`.","icon":"$undefined","url":"/native-sdk/reference/next-data-sync","$ref":"(sdks)/native-sdk/reference/next-data-sync.mdx"},{"$id":"(sdks)/native-sdk/reference/next.mdx","type":"page","name":"next","description":"The native `Ovok` client built on `@ovok/core/next`, with secure-store token storage.","icon":"$undefined","url":"/native-sdk/reference/next","$ref":"(sdks)/native-sdk/reference/next.mdx"},{"$id":"(sdks)/native-sdk/reference/observation-detail.mdx","type":"page","name":"observation-detail","description":"Observation detail screen components.","icon":"$undefined","url":"/native-sdk/reference/observation-detail","$ref":"(sdks)/native-sdk/reference/observation-detail.mdx"},{"$id":"(sdks)/native-sdk/reference/patient.mdx","type":"page","name":"patient","description":"Patient card, list, name, gender and birth-date components.","icon":"$undefined","url":"/native-sdk/reference/patient","$ref":"(sdks)/native-sdk/reference/patient.mdx"},{"$id":"(sdks)/native-sdk/reference/pdf.mdx","type":"page","name":"pdf","description":"PDF viewer component.","icon":"$undefined","url":"/native-sdk/reference/pdf","$ref":"(sdks)/native-sdk/reference/pdf.mdx"},{"$id":"(sdks)/native-sdk/reference/picker-sheet.mdx","type":"page","name":"picker-sheet","description":"Wheel pickers and the bottom picker sheet.","icon":"$undefined","url":"/native-sdk/reference/picker-sheet","$ref":"(sdks)/native-sdk/reference/picker-sheet.mdx"},{"$id":"(sdks)/native-sdk/reference/polyfills.mdx","type":"page","name":"polyfills","description":"Runtime polyfills the SDK needs in React Native; import once at app start.","icon":"$undefined","url":"/native-sdk/reference/polyfills","$ref":"(sdks)/native-sdk/reference/polyfills.mdx"},{"$id":"(sdks)/native-sdk/reference/progress-bar.mdx","type":"page","name":"progress-bar","description":"Progress bar component.","icon":"$undefined","url":"/native-sdk/reference/progress-bar","$ref":"(sdks)/native-sdk/reference/progress-bar.mdx"},{"$id":"(sdks)/native-sdk/reference/progress-ring.mdx","type":"page","name":"progress-ring","description":"Progress ring component.","icon":"$undefined","url":"/native-sdk/reference/progress-ring","$ref":"(sdks)/native-sdk/reference/progress-ring.mdx"},{"$id":"(sdks)/native-sdk/reference/questionnaire-response-form.mdx","type":"page","name":"questionnaire-response-form","description":"FHIR questionnaire forms: providers, navigation, item renderers and answer helpers.","icon":"$undefined","url":"/native-sdk/reference/questionnaire-response-form","$ref":"(sdks)/native-sdk/reference/questionnaire-response-form.mdx"},{"$id":"(sdks)/native-sdk/reference/setting.mdx","type":"page","name":"setting","description":"Settings list components.","icon":"$undefined","url":"/native-sdk/reference/setting","$ref":"(sdks)/native-sdk/reference/setting.mdx"},{"$id":"(sdks)/native-sdk/reference/socket.mdx","type":"page","name":"socket","description":"Realtime socket provider and context.","icon":"$undefined","url":"/native-sdk/reference/socket","$ref":"(sdks)/native-sdk/reference/socket.mdx"},{"$id":"(sdks)/native-sdk/reference/tab.mdx","type":"page","name":"tab","description":"Tab bar component, provider, context and hook.","icon":"$undefined","url":"/native-sdk/reference/tab","$ref":"(sdks)/native-sdk/reference/tab.mdx"},{"$id":"(sdks)/native-sdk/reference/theme.mdx","type":"page","name":"theme","description":"Theme provider, theme hook, colors and spacing multipliers.","icon":"$undefined","url":"/native-sdk/reference/theme","$ref":"(sdks)/native-sdk/reference/theme.mdx"},{"$id":"(sdks)/native-sdk/reference/tile.mdx","type":"page","name":"tile","description":"Tile component for task and dashboard entries.","icon":"$undefined","url":"/native-sdk/reference/tile","$ref":"(sdks)/native-sdk/reference/tile.mdx"},{"$id":"(sdks)/native-sdk/reference/ui.mdx","type":"page","name":"ui","description":"Ready-made measurement and device flows: pairing, manual entry, charts, calendars and ECG strips.","icon":"$undefined","url":"/native-sdk/reference/ui","$ref":"(sdks)/native-sdk/reference/ui.mdx"},{"$id":"(sdks)/native-sdk/reference/wearables.mdx","type":"page","name":"wearables","description":"Wearable provider icons and wearable source types.","icon":"$undefined","url":"/native-sdk/reference/wearables","$ref":"(sdks)/native-sdk/reference/wearables.mdx"}],"$id":"(sdks)/native-sdk/reference","$ref":{"folder":"(sdks)/native-sdk/reference","meta":"(sdks)/native-sdk/reference/meta.json"},"index":{"$id":"(sdks)/native-sdk/reference/index.mdx","type":"page","name":"API reference","description":"Generated reference for every public module of @ovok/native.","icon":"$undefined","url":"/native-sdk/reference","$ref":"(sdks)/native-sdk/reference/index.mdx"},"icon":"$undefined"},{"$id":"_45","type":"separator","icon":"$undefined","name":"Python SDK"},{"$id":"(sdks)/python-sdk/index.mdx","type":"page","name":"Python SDK","description":"Integrate Ovok Core APIs from Python applications.","icon":"$undefined","url":"/python-sdk","$ref":"(sdks)/python-sdk/index.mdx"},{"$id":"(sdks)/python-sdk/getting-started.mdx","type":"page","name":"Get started","description":"The Python SDK requires Python 3.10 or later and has no runtime dependencies outside","icon":"$undefined","url":"/python-sdk/getting-started","$ref":"(sdks)/python-sdk/getting-started.mdx"},{"type":"folder","name":"Guides","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/python-sdk/guides/handle-errors.mdx","type":"page","name":"Handle errors","description":"Every failure raises a subclass of OvokError. Catch the specific class you can act on and","icon":"$undefined","url":"/python-sdk/guides/handle-errors","$ref":"(sdks)/python-sdk/guides/handle-errors.mdx"},{"$id":"(sdks)/python-sdk/guides/keep-users-signed-in.mdx","type":"page","name":"Keep users signed in","description":"A client built without client_secret acts for a signed-in user. It keeps the session in","icon":"$undefined","url":"/python-sdk/guides/keep-users-signed-in","$ref":"(sdks)/python-sdk/guides/keep-users-signed-in.mdx"},{"$id":"(sdks)/python-sdk/guides/machine-clients.mdx","type":"page","name":"Authenticate a machine client","description":"A backend service that acts for itself, not for a user, signs in with an OAuth client ID and","icon":"$undefined","url":"/python-sdk/guides/machine-clients","$ref":"(sdks)/python-sdk/guides/machine-clients.mdx"},{"$id":"(sdks)/python-sdk/guides/paging.mdx","type":"page","name":"Page through lists","description":"Every list method returns a Page: data holds this page's items, total the item count","icon":"$undefined","url":"/python-sdk/guides/paging","$ref":"(sdks)/python-sdk/guides/paging.mdx"}],"$id":"(sdks)/python-sdk/guides","$ref":{"folder":"(sdks)/python-sdk/guides","meta":"(sdks)/python-sdk/guides/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Namespaces","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/python-sdk/namespaces/accounts.mdx","type":"page","name":"Accounts","description":"ovok.accounts lists the accounts the signed-in user can access, for example to offer an account","icon":"$undefined","url":"/python-sdk/namespaces/accounts","$ref":"(sdks)/python-sdk/namespaces/accounts.mdx"},{"$id":"(sdks)/python-sdk/namespaces/ai.mdx","type":"page","name":"AI","description":"ovok.ai gives access to Ovok's AI features: text translation, natural-language FHIR search and","icon":"$undefined","url":"/python-sdk/namespaces/ai","$ref":"(sdks)/python-sdk/namespaces/ai.mdx"},{"$id":"(sdks)/python-sdk/namespaces/auth.mdx","type":"page","name":"Authentication","description":"ovok.auth signs users in and out, registers patients and practitioners, and manages the","icon":"$undefined","url":"/python-sdk/namespaces/auth","$ref":"(sdks)/python-sdk/namespaces/auth.mdx"},{"$id":"(sdks)/python-sdk/namespaces/bots.mdx","type":"page","name":"Bots","description":"ovok.bots runs bots deployed to the project and returns their output.","icon":"$undefined","url":"/python-sdk/namespaces/bots","$ref":"(sdks)/python-sdk/namespaces/bots.mdx"},{"$id":"(sdks)/python-sdk/namespaces/cms.mdx","type":"page","name":"CMS","description":"ovok.cms reads the published CMS content of the client's tenant: legal pages, translations,","icon":"$undefined","url":"/python-sdk/namespaces/cms","$ref":"(sdks)/python-sdk/namespaces/cms.mdx"},{"$id":"(sdks)/python-sdk/namespaces/consent.mdx","type":"page","name":"Consent","description":"ovok.consent reads and records the signed-in user's legal consent (terms and conditions)","icon":"$undefined","url":"/python-sdk/namespaces/consent","$ref":"(sdks)/python-sdk/namespaces/consent.mdx"},{"$id":"(sdks)/python-sdk/namespaces/content.mdx","type":"page","name":"Content","description":"ovok.content manages the project's CMS content entries. Each entry is addressed by its content","icon":"$undefined","url":"/python-sdk/namespaces/content","$ref":"(sdks)/python-sdk/namespaces/content.mdx"},{"$id":"(sdks)/python-sdk/namespaces/documents.mdx","type":"page","name":"Documents","description":"ovok.documents stores files such as reports and consent forms. It lists and deletes documents,","icon":"$undefined","url":"/python-sdk/namespaces/documents","$ref":"(sdks)/python-sdk/namespaces/documents.mdx"},{"$id":"(sdks)/python-sdk/namespaces/email.mdx","type":"page","name":"Email","description":"ovok.email reads the project's email settings. Today it lists the email templates the project","icon":"$undefined","url":"/python-sdk/namespaces/email","$ref":"(sdks)/python-sdk/namespaces/email.mdx"},{"$id":"(sdks)/python-sdk/namespaces/fhir.mdx","type":"page","name":"FHIR","description":"ovok.fhir is a generic FHIR R4 client for any resource type. Resources are plain","icon":"$undefined","url":"/python-sdk/namespaces/fhir","$ref":"(sdks)/python-sdk/namespaces/fhir.mdx"},{"$id":"(sdks)/python-sdk/namespaces/health.mdx","type":"page","name":"Health","description":"ovok.health reads the API health check. It sends no credentials, so it works before","icon":"$undefined","url":"/python-sdk/namespaces/health","$ref":"(sdks)/python-sdk/namespaces/health.mdx"},{"$id":"(sdks)/python-sdk/namespaces/invites.mdx","type":"page","name":"Invites","description":"ovok.invites creates and accepts invitations: record shares, care, practitioners and","icon":"$undefined","url":"/python-sdk/namespaces/invites","$ref":"(sdks)/python-sdk/namespaces/invites.mdx"},{"$id":"(sdks)/python-sdk/namespaces/locales.mdx","type":"page","name":"Locales","description":"ovok.locales reads and updates the languages the project offers. Use","icon":"$undefined","url":"/python-sdk/namespaces/locales","$ref":"(sdks)/python-sdk/namespaces/locales.mdx"},{"$id":"(sdks)/python-sdk/namespaces/localizations.mdx","type":"page","name":"Localizations","description":"ovok.localizations manages the project's localized strings by language and key, either one","icon":"$undefined","url":"/python-sdk/namespaces/localizations","$ref":"(sdks)/python-sdk/namespaces/localizations.mdx"},{"$id":"(sdks)/python-sdk/namespaces/measurements.mdx","type":"page","name":"Measurements","description":"ovok.measurements turns device and manual readings into FHIR Observations, saves them","icon":"$undefined","url":"/python-sdk/namespaces/measurements","$ref":"(sdks)/python-sdk/namespaces/measurements.mdx"},{"$id":"(sdks)/python-sdk/namespaces/patient.mdx","type":"page","name":"Patient","description":"ovok.patient reads the FHIR data a patient app needs: appointments, schedules and slots,","icon":"$undefined","url":"/python-sdk/namespaces/patient","$ref":"(sdks)/python-sdk/namespaces/patient.mdx"},{"$id":"(sdks)/python-sdk/namespaces/projects.mdx","type":"page","name":"Projects","description":"ovok.projects lists the projects the signed-in user administers and manages the current","icon":"$undefined","url":"/python-sdk/namespaces/projects","$ref":"(sdks)/python-sdk/namespaces/projects.mdx"},{"$id":"(sdks)/python-sdk/namespaces/questionnaire-responses.mdx","type":"page","name":"Questionnaire responses","description":"ovok.questionnaire_responses submits a user's answers, optionally with the Observations","icon":"$undefined","url":"/python-sdk/namespaces/questionnaire-responses","$ref":"(sdks)/python-sdk/namespaces/questionnaire-responses.mdx"},{"$id":"(sdks)/python-sdk/namespaces/questionnaires.mdx","type":"page","name":"Questionnaires","description":"ovok.questionnaires prepares a Questionnaire for the user to fill in. Read Questionnaires","icon":"$undefined","url":"/python-sdk/namespaces/questionnaires","$ref":"(sdks)/python-sdk/namespaces/questionnaires.mdx"},{"$id":"(sdks)/python-sdk/namespaces/sharing.mdx","type":"page","name":"Sharing","description":"ovok.sharing lets a patient share their record: create and redeem invitations, list and","icon":"$undefined","url":"/python-sdk/namespaces/sharing","$ref":"(sdks)/python-sdk/namespaces/sharing.mdx"},{"$id":"(sdks)/python-sdk/namespaces/signals.mdx","type":"page","name":"Signals","description":"ovok.signals turns on Signals monitoring for patients, calls the Signals API through the","icon":"$undefined","url":"/python-sdk/namespaces/signals","$ref":"(sdks)/python-sdk/namespaces/signals.mdx"},{"$id":"(sdks)/python-sdk/namespaces/slim.mdx","type":"page","name":"Slim","description":"ovok.slim is Ovok's compact care-facility API: patients, devices and their live state,","icon":"$undefined","url":"/python-sdk/namespaces/slim","$ref":"(sdks)/python-sdk/namespaces/slim.mdx"},{"$id":"(sdks)/python-sdk/namespaces/video-calls.mdx","type":"page","name":"Video calls","description":"ovok.video_calls runs LiveKit video calls: it schedules call appointments, grants room access to","icon":"$undefined","url":"/python-sdk/namespaces/video-calls","$ref":"(sdks)/python-sdk/namespaces/video-calls.mdx"},{"$id":"(sdks)/python-sdk/namespaces/wearables.mdx","type":"page","name":"Wearables","description":"ovok.wearables configures the project's wearable providers and connects the signed-in user's","icon":"$undefined","url":"/python-sdk/namespaces/wearables","$ref":"(sdks)/python-sdk/namespaces/wearables.mdx"}],"$id":"(sdks)/python-sdk/namespaces","$ref":{"folder":"(sdks)/python-sdk/namespaces","meta":"(sdks)/python-sdk/namespaces/meta.json"},"icon":"$undefined"},{"type":"folder","name":"API reference","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"auth","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/python-sdk/reference/auth/access_token.mdx","type":"page","name":"access_token","description":"OAuth access tokens and their expiry.","icon":"$undefined","url":"/python-sdk/reference/auth/access_token","$ref":"(sdks)/python-sdk/reference/auth/access_token.mdx"},{"$id":"(sdks)/python-sdk/reference/auth/client_credentials.mdx","type":"page","name":"client_credentials","description":"Machine-client authentication with the OAuth client-credentials grant.","icon":"$undefined","url":"/python-sdk/reference/auth/client_credentials","$ref":"(sdks)/python-sdk/reference/auth/client_credentials.mdx"},{"$id":"(sdks)/python-sdk/reference/auth/credentials.mdx","type":"page","name":"credentials","description":"The interface that supplies bearer tokens to requests.","icon":"$undefined","url":"/python-sdk/reference/auth/credentials","$ref":"(sdks)/python-sdk/reference/auth/credentials.mdx"},{"$id":"(sdks)/python-sdk/reference/auth/pkce.mdx","type":"page","name":"pkce","description":"PKCE (RFC 7636) verifier and challenge generation.","icon":"$undefined","url":"/python-sdk/reference/auth/pkce","$ref":"(sdks)/python-sdk/reference/auth/pkce.mdx"},{"$id":"(sdks)/python-sdk/reference/auth/session.mdx","type":"page","name":"session","description":"The signed-in user's session and its JSON conversions.","icon":"$undefined","url":"/python-sdk/reference/auth/session","$ref":"(sdks)/python-sdk/reference/auth/session.mdx"},{"$id":"(sdks)/python-sdk/reference/auth/session_store.mdx","type":"page","name":"session_store","description":"Persistence of the user session in `OvokStorage`.","icon":"$undefined","url":"/python-sdk/reference/auth/session_store","$ref":"(sdks)/python-sdk/reference/auth/session_store.mdx"},{"$id":"(sdks)/python-sdk/reference/auth/single_flight.mdx","type":"page","name":"single_flight","description":"Deduplication of concurrent calls, such as token refreshes.","icon":"$undefined","url":"/python-sdk/reference/auth/single_flight","$ref":"(sdks)/python-sdk/reference/auth/single_flight.mdx"},{"$id":"(sdks)/python-sdk/reference/auth/token_endpoint.mdx","type":"page","name":"token_endpoint","description":"The OAuth token endpoint.","icon":"$undefined","url":"/python-sdk/reference/auth/token_endpoint","$ref":"(sdks)/python-sdk/reference/auth/token_endpoint.mdx"},{"$id":"(sdks)/python-sdk/reference/auth/user_session.mdx","type":"page","name":"user_session","description":"The signed-in user's session and its token refresh.","icon":"$undefined","url":"/python-sdk/reference/auth/user_session","$ref":"(sdks)/python-sdk/reference/auth/user_session.mdx"}],"$id":"(sdks)/python-sdk/reference/auth","$ref":{"folder":"(sdks)/python-sdk/reference/auth","meta":"(sdks)/python-sdk/reference/auth/meta.json"},"icon":"$undefined"},{"$id":"(sdks)/python-sdk/reference/clock.mdx","type":"page","name":"clock","description":"Wall-clock time in epoch milliseconds.","icon":"$undefined","url":"/python-sdk/reference/clock","$ref":"(sdks)/python-sdk/reference/clock.mdx"},{"$id":"(sdks)/python-sdk/reference/config.mdx","type":"page","name":"config","description":"Client options, checked once when the client is constructed.","icon":"$undefined","url":"/python-sdk/reference/config","$ref":"(sdks)/python-sdk/reference/config.mdx"},{"$id":"(sdks)/python-sdk/reference/errors.mdx","type":"page","name":"errors","description":"Errors the SDK raises, one class per kind of failure.","icon":"$undefined","url":"/python-sdk/reference/errors","$ref":"(sdks)/python-sdk/reference/errors.mdx"},{"type":"folder","name":"http","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/python-sdk/reference/http/client.mdx","type":"page","name":"client","description":"The authenticated JSON client every namespace sends through.","icon":"$undefined","url":"/python-sdk/reference/http/client","$ref":"(sdks)/python-sdk/reference/http/client.mdx"},{"$id":"(sdks)/python-sdk/reference/http/error_response.mdx","type":"page","name":"error_response","description":"Conversion of error responses into `OvokError`s.","icon":"$undefined","url":"/python-sdk/reference/http/error_response","$ref":"(sdks)/python-sdk/reference/http/error_response.mdx"},{"$id":"(sdks)/python-sdk/reference/http/request.mdx","type":"page","name":"request","description":"The description of one API call before it is sent.","icon":"$undefined","url":"/python-sdk/reference/http/request","$ref":"(sdks)/python-sdk/reference/http/request.mdx"},{"$id":"(sdks)/python-sdk/reference/http/retry.mdx","type":"page","name":"retry","description":"When and how long to wait before retrying a request.","icon":"$undefined","url":"/python-sdk/reference/http/retry","$ref":"(sdks)/python-sdk/reference/http/retry.mdx"},{"$id":"(sdks)/python-sdk/reference/http/transport.mdx","type":"page","name":"transport","description":"The pluggable transport that sends HTTP requests.","icon":"$undefined","url":"/python-sdk/reference/http/transport","$ref":"(sdks)/python-sdk/reference/http/transport.mdx"},{"$id":"(sdks)/python-sdk/reference/http/url.mdx","type":"page","name":"url","description":"URL path and query encoding.","icon":"$undefined","url":"/python-sdk/reference/http/url","$ref":"(sdks)/python-sdk/reference/http/url.mdx"}],"$id":"(sdks)/python-sdk/reference/http","$ref":{"folder":"(sdks)/python-sdk/reference/http","meta":"(sdks)/python-sdk/reference/http/meta.json"},"icon":"$undefined"},{"$id":"(sdks)/python-sdk/reference/ovok.mdx","type":"page","name":"ovok","description":"The `Ovok` client, the entry point to every API namespace.","icon":"$undefined","url":"/python-sdk/reference/ovok","$ref":"(sdks)/python-sdk/reference/ovok.mdx"},{"$id":"(sdks)/python-sdk/reference/paging.mdx","type":"page","name":"paging","description":"Paged results and the loaders for each list format Ovok returns.","icon":"$undefined","url":"/python-sdk/reference/paging","$ref":"(sdks)/python-sdk/reference/paging.mdx"},{"type":"folder","name":"resources","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/python-sdk/reference/resources/ai.mdx","type":"page","name":"ai","description":"AI features: translation, natural-language FHIR search and chat.","icon":"$undefined","url":"/python-sdk/reference/resources/ai","$ref":"(sdks)/python-sdk/reference/resources/ai.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/auth.mdx","type":"page","name":"auth","description":"The `ovok.auth` namespace: sign-in, registration and account management.","icon":"$undefined","url":"/python-sdk/reference/resources/auth","$ref":"(sdks)/python-sdk/reference/resources/auth.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/auth_sessions.mdx","type":"page","name":"auth_sessions","description":"The `ovok.auth.sessions` namespace: the account's server-side sessions.","icon":"$undefined","url":"/python-sdk/reference/resources/auth_sessions","$ref":"(sdks)/python-sdk/reference/resources/auth_sessions.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/bots.mdx","type":"page","name":"bots","description":"The `ovok.bots` namespace: run server-side bots.","icon":"$undefined","url":"/python-sdk/reference/resources/bots","$ref":"(sdks)/python-sdk/reference/resources/bots.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/cms.mdx","type":"page","name":"cms","description":"Published CMS content for the configured tenant: documents, legal pages and translations.","icon":"$undefined","url":"/python-sdk/reference/resources/cms","$ref":"(sdks)/python-sdk/reference/resources/cms.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/consent.mdx","type":"page","name":"consent","description":"The `ovok.consent` namespace: the signed-in user's legal and medical consent.","icon":"$undefined","url":"/python-sdk/reference/resources/consent","$ref":"(sdks)/python-sdk/reference/resources/consent.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/content.mdx","type":"page","name":"content","description":"Project-managed CMS content by content type and language.","icon":"$undefined","url":"/python-sdk/reference/resources/content","$ref":"(sdks)/python-sdk/reference/resources/content.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/documents.mdx","type":"page","name":"documents","description":"Stored documents: uploads, metadata and download links.","icon":"$undefined","url":"/python-sdk/reference/resources/documents","$ref":"(sdks)/python-sdk/reference/resources/documents.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/fhir.mdx","type":"page","name":"fhir","description":"Generic FHIR R4 reads, searches, writes and batches.","icon":"$undefined","url":"/python-sdk/reference/resources/fhir","$ref":"(sdks)/python-sdk/reference/resources/fhir.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/health.mdx","type":"page","name":"health","description":"The `ovok.health` namespace: the API health check.","icon":"$undefined","url":"/python-sdk/reference/resources/health","$ref":"(sdks)/python-sdk/reference/resources/health.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/invites.mdx","type":"page","name":"invites","description":"The `ovok.invites` namespace: create and accept invitations.","icon":"$undefined","url":"/python-sdk/reference/resources/invites","$ref":"(sdks)/python-sdk/reference/resources/invites.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/measurement_builder.mdx","type":"page","name":"measurement_builder","description":"Builds FHIR Observations from typed measurement readings.","icon":"$undefined","url":"/python-sdk/reference/resources/measurement_builder","$ref":"(sdks)/python-sdk/reference/resources/measurement_builder.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/measurements.mdx","type":"page","name":"measurements","description":"Measurement building, saving with an offline retry queue, and latest-value reads.","icon":"$undefined","url":"/python-sdk/reference/resources/measurements","$ref":"(sdks)/python-sdk/reference/resources/measurements.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/patient.mdx","type":"page","name":"patient","description":"FHIR reads for the signed-in patient: appointments, measurements, care plans and more.","icon":"$undefined","url":"/python-sdk/reference/resources/patient","$ref":"(sdks)/python-sdk/reference/resources/patient.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/platform.mdx","type":"page","name":"platform","description":"Platform administration: accounts, projects, locales, localizations and email templates.","icon":"$undefined","url":"/python-sdk/reference/resources/platform","$ref":"(sdks)/python-sdk/reference/resources/platform.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/questionnaires.mdx","type":"page","name":"questionnaires","description":"Questionnaire population and QuestionnaireResponse submission and extraction.","icon":"$undefined","url":"/python-sdk/reference/resources/questionnaires","$ref":"(sdks)/python-sdk/reference/resources/questionnaires.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/registration.mdx","type":"page","name":"registration","description":"Sign-up requests for `ovok.auth.register` and `ovok.auth.register_practitioner`.","icon":"$undefined","url":"/python-sdk/reference/resources/registration","$ref":"(sdks)/python-sdk/reference/resources/registration.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/sharing.mdx","type":"page","name":"sharing","description":"The `ovok.sharing` namespace: patient record sharing.","icon":"$undefined","url":"/python-sdk/reference/resources/sharing","$ref":"(sdks)/python-sdk/reference/resources/sharing.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/signals.mdx","type":"page","name":"signals","description":"Signals enablement, the proxied Signals API and undeliverable-config repair.","icon":"$undefined","url":"/python-sdk/reference/resources/signals","$ref":"(sdks)/python-sdk/reference/resources/signals.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/slim.mdx","type":"page","name":"slim","description":"The `ovok.slim` namespace: Ovok's compact care-facility API for patients, devices and alerts.","icon":"$undefined","url":"/python-sdk/reference/resources/slim","$ref":"(sdks)/python-sdk/reference/resources/slim.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/video_calls.mdx","type":"page","name":"video_calls","description":"LiveKit video calls: appointments, access and email notices.","icon":"$undefined","url":"/python-sdk/reference/resources/video_calls","$ref":"(sdks)/python-sdk/reference/resources/video_calls.mdx"},{"$id":"(sdks)/python-sdk/reference/resources/wearables.mdx","type":"page","name":"wearables","description":"Wearable providers and the signed-in user's connections to them.","icon":"$undefined","url":"/python-sdk/reference/resources/wearables","$ref":"(sdks)/python-sdk/reference/resources/wearables.mdx"}],"$id":"(sdks)/python-sdk/reference/resources","$ref":{"folder":"(sdks)/python-sdk/reference/resources","meta":"(sdks)/python-sdk/reference/resources/meta.json"},"icon":"$undefined"},{"$id":"(sdks)/python-sdk/reference/storage.mdx","type":"page","name":"storage","description":"Key-value storage the client keeps its session in.","icon":"$undefined","url":"/python-sdk/reference/storage","$ref":"(sdks)/python-sdk/reference/storage.mdx"},{"$id":"(sdks)/python-sdk/reference/values.mdx","type":"page","name":"values","description":"Checks on loosely typed values.","icon":"$undefined","url":"/python-sdk/reference/values","$ref":"(sdks)/python-sdk/reference/values.mdx"}],"$id":"(sdks)/python-sdk/reference","$ref":{"folder":"(sdks)/python-sdk/reference","meta":"(sdks)/python-sdk/reference/meta.json"},"index":{"$id":"(sdks)/python-sdk/reference/index.mdx","type":"page","name":"Overview","description":"Every public module, class and method of the Python SDK.","icon":"$undefined","url":"/python-sdk/reference","$ref":"(sdks)/python-sdk/reference/index.mdx"},"icon":"$undefined"},{"$id":"_46","type":"separator","icon":"$undefined","name":"Java SDK"},{"$id":"(sdks)/java-sdk/index.mdx","type":"page","name":"Java SDK","description":"Integrate Ovok Core from Java applications.","icon":"$undefined","url":"/java-sdk","$ref":"(sdks)/java-sdk/index.mdx"},{"$id":"(sdks)/java-sdk/getting-started.mdx","type":"page","name":"Get started","description":"The Java SDK requires Java 17 or later.","icon":"$undefined","url":"/java-sdk/getting-started","$ref":"(sdks)/java-sdk/getting-started.mdx"},{"$id":"(sdks)/java-sdk/client-configuration.mdx","type":"page","name":"Client configuration","description":"Build an OvokConfig and pass it to new Ovok(config).","icon":"$undefined","url":"/java-sdk/client-configuration","$ref":"(sdks)/java-sdk/client-configuration.mdx"},{"$id":"(sdks)/java-sdk/errors-and-retries.mdx","type":"page","name":"Errors and retries","description":"Errors","icon":"$undefined","url":"/java-sdk/errors-and-retries","$ref":"(sdks)/java-sdk/errors-and-retries.mdx"},{"$id":"_47","type":"separator","icon":"$undefined","name":"Namespaces"},{"$id":"(sdks)/java-sdk/authentication.mdx","type":"page","name":"Authentication","description":"Sign in","icon":"$undefined","url":"/java-sdk/authentication","$ref":"(sdks)/java-sdk/authentication.mdx"},{"$id":"(sdks)/java-sdk/fhir-and-observations.mdx","type":"page","name":"FHIR and observations","description":"ovok.fhir() calls the FHIR R4 API.","icon":"$undefined","url":"/java-sdk/fhir-and-observations","$ref":"(sdks)/java-sdk/fhir-and-observations.mdx"},{"$id":"(sdks)/java-sdk/measurements.mdx","type":"page","name":"Measurements","description":"ovok.measurements().save(parameters) builds FHIR Observations from a measurement and saves them in a transaction:","icon":"$undefined","url":"/java-sdk/measurements","$ref":"(sdks)/java-sdk/measurements.mdx"},{"$id":"(sdks)/java-sdk/patient.mdx","type":"page","name":"Patient","description":"ovok.patient() reads and writes the signed-in patient's FHIR records: appointments, care plans, devices, measurements, notifications, questionnaires and responses, schedules and slots, plus the dashboard and latest observations.","icon":"$undefined","url":"/java-sdk/patient","$ref":"(sdks)/java-sdk/patient.mdx"},{"$id":"(sdks)/java-sdk/slim-apis.mdx","type":"page","name":"Slim APIs","description":"ovok.slim() groups the care home routes. Methods return a JsonNode or a Page, and request bodies accept a Map or a JsonNode.","icon":"$undefined","url":"/java-sdk/slim-apis","$ref":"(sdks)/java-sdk/slim-apis.mdx"},{"$id":"(sdks)/java-sdk/signals.mdx","type":"page","name":"Signals","description":"ovok.signals() manages Signals delivery for patients.","icon":"$undefined","url":"/java-sdk/signals","$ref":"(sdks)/java-sdk/signals.mdx"},{"$id":"(sdks)/java-sdk/projects.mdx","type":"page","name":"Projects","description":"ovok.projects() lists projects and manages the current project's members(), features() and settings().","icon":"$undefined","url":"/java-sdk/projects","$ref":"(sdks)/java-sdk/projects.mdx"},{"$id":"(sdks)/java-sdk/accounts.mdx","type":"page","name":"Accounts","description":"ovok.accounts() lists the accounts the caller can see.","icon":"$undefined","url":"/java-sdk/accounts","$ref":"(sdks)/java-sdk/accounts.mdx"},{"$id":"(sdks)/java-sdk/invites.mdx","type":"page","name":"Invites","description":"ovok.invites() creates and accepts invites. Each flow, recordShares() and care(), has create and accept. practitioners() and patients() are deprecated.","icon":"$undefined","url":"/java-sdk/invites","$ref":"(sdks)/java-sdk/invites.mdx"},{"$id":"(sdks)/java-sdk/sharing.mdx","type":"page","name":"Sharing","description":"ovok.sharing() shares patient records: create and redeem invites(), list and revoke shares(), and read or change sharing settings().","icon":"$undefined","url":"/java-sdk/sharing","$ref":"(sdks)/java-sdk/sharing.mdx"},{"$id":"(sdks)/java-sdk/consent.mdx","type":"page","name":"Consent","description":"ovok.consent() reads and records the signed-in user's legal() and medical() consent, and requests consent signatures.","icon":"$undefined","url":"/java-sdk/consent","$ref":"(sdks)/java-sdk/consent.mdx"},{"$id":"(sdks)/java-sdk/locales.mdx","type":"page","name":"Locales","description":"ovok.locales() reads and changes the project's locales.","icon":"$undefined","url":"/java-sdk/locales","$ref":"(sdks)/java-sdk/locales.mdx"},{"$id":"(sdks)/java-sdk/localizations.mdx","type":"page","name":"Localizations","description":"ovok.localizations() manages localization strings per language, and i18next() reads and writes a whole language as an i18next document.","icon":"$undefined","url":"/java-sdk/localizations","$ref":"(sdks)/java-sdk/localizations.mdx"},{"$id":"(sdks)/java-sdk/email.mdx","type":"page","name":"Email","description":"ovok.email() reads the project's email templates().","icon":"$undefined","url":"/java-sdk/email","$ref":"(sdks)/java-sdk/email.mdx"},{"$id":"(sdks)/java-sdk/cms.mdx","type":"page","name":"CMS","description":"ovok.cms() reads CMS content. Every read includes the configured tenantCode.","icon":"$undefined","url":"/java-sdk/cms","$ref":"(sdks)/java-sdk/cms.mdx"},{"$id":"(sdks)/java-sdk/content.mdx","type":"page","name":"Content","description":"ovok.content() manages localized content entries by type, language and key, and copies entries from the parent project.","icon":"$undefined","url":"/java-sdk/content","$ref":"(sdks)/java-sdk/content.mdx"},{"$id":"(sdks)/java-sdk/documents.mdx","type":"page","name":"Documents","description":"ovok.documents() lists the project's documents, creates and replaces uploads, edits metadata, and builds download URLs.","icon":"$undefined","url":"/java-sdk/documents","$ref":"(sdks)/java-sdk/documents.mdx"},{"$id":"(sdks)/java-sdk/questionnaires.mdx","type":"page","name":"Questionnaires","description":"ovok.questionnaires() runs FHIR Questionnaire operations, such as $populate.","icon":"$undefined","url":"/java-sdk/questionnaires","$ref":"(sdks)/java-sdk/questionnaires.mdx"},{"$id":"(sdks)/java-sdk/questionnaire-responses.mdx","type":"page","name":"Questionnaire responses","description":"ovok.questionnaireResponses() submits QuestionnaireResponses, optionally with Observations in the same transaction, and extracts data from them.","icon":"$undefined","url":"/java-sdk/questionnaire-responses","$ref":"(sdks)/java-sdk/questionnaire-responses.mdx"},{"$id":"(sdks)/java-sdk/video-calls.mdx","type":"page","name":"Video calls","description":"ovok.videoCalls() runs LiveKit video calls: call appointments(), access() for users and guests, and invite emails().","icon":"$undefined","url":"/java-sdk/video-calls","$ref":"(sdks)/java-sdk/video-calls.mdx"},{"$id":"(sdks)/java-sdk/ai.mdx","type":"page","name":"AI","description":"ovok.ai() calls the Ovok AI routes: chat() sessions and messages, translate, and fhirSearch.","icon":"$undefined","url":"/java-sdk/ai","$ref":"(sdks)/java-sdk/ai.mdx"},{"$id":"(sdks)/java-sdk/wearables.mdx","type":"page","name":"Wearables","description":"ovok.wearables() manages wearable providers() and the user's connections(): authorize, sync and remove.","icon":"$undefined","url":"/java-sdk/wearables","$ref":"(sdks)/java-sdk/wearables.mdx"},{"$id":"(sdks)/java-sdk/bots.mdx","type":"page","name":"Bots","description":"ovok.bots() runs an Ovok bot with an input.","icon":"$undefined","url":"/java-sdk/bots","$ref":"(sdks)/java-sdk/bots.mdx"},{"$id":"(sdks)/java-sdk/health.mdx","type":"page","name":"Health","description":"ovok.health() checks that the Ovok API is up.","icon":"$undefined","url":"/java-sdk/health","$ref":"(sdks)/java-sdk/health.mdx"},{"$id":"(sdks)/java-sdk/compatibility.mdx","type":"page","name":"Compatibility","description":"OvokClient","icon":"$undefined","url":"/java-sdk/compatibility","$ref":"(sdks)/java-sdk/compatibility.mdx"},{"type":"folder","name":"API reference","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/java-sdk/reference/accounts-resource.mdx","type":"page","name":"AccountsResource","description":"Lists Ovok accounts.","icon":"$undefined","url":"/java-sdk/reference/accounts-resource","$ref":"(sdks)/java-sdk/reference/accounts-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/ai-resource.mdx","type":"page","name":"AiResource","description":"Calls the Ovok AI routes under /ai.","icon":"$undefined","url":"/java-sdk/reference/ai-resource","$ref":"(sdks)/java-sdk/reference/ai-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/alarms-resource.mdx","type":"page","name":"AlarmsResource","description":"Reads and acknowledges device alarm notifications.","icon":"$undefined","url":"/java-sdk/reference/alarms-resource","$ref":"(sdks)/java-sdk/reference/alarms-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/auth-resource.mdx","type":"page","name":"AuthResource","description":"Signs users in and out and manages their account.","icon":"$undefined","url":"/java-sdk/reference/auth-resource","$ref":"(sdks)/java-sdk/reference/auth-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/auth-sessions-resource.mdx","type":"page","name":"AuthSessionsResource","description":"Lists and revokes the signed-in user's sessions.","icon":"$undefined","url":"/java-sdk/reference/auth-sessions-resource","$ref":"(sdks)/java-sdk/reference/auth-sessions-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/bots-resource.mdx","type":"page","name":"BotsResource","description":"Runs Ovok bots.","icon":"$undefined","url":"/java-sdk/reference/bots-resource","$ref":"(sdks)/java-sdk/reference/bots-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/change-history-resource.mdx","type":"page","name":"ChangeHistoryResource","description":"Reads the change history.","icon":"$undefined","url":"/java-sdk/reference/change-history-resource","$ref":"(sdks)/java-sdk/reference/change-history-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/child-projects-resource.mdx","type":"page","name":"ChildProjectsResource","description":"Manages child projects of the current project.","icon":"$undefined","url":"/java-sdk/reference/child-projects-resource","$ref":"(sdks)/java-sdk/reference/child-projects-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/cms-resource.mdx","type":"page","name":"CmsResource","description":"Reads published CMS content for the configured tenant.","icon":"$undefined","url":"/java-sdk/reference/cms-resource","$ref":"(sdks)/java-sdk/reference/cms-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/consent-resource.mdx","type":"page","name":"ConsentResource","description":"Reads and records the signed-in user's consents and requests consent signatures.","icon":"$undefined","url":"/java-sdk/reference/consent-resource","$ref":"(sdks)/java-sdk/reference/consent-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/content-resource.mdx","type":"page","name":"ContentResource","description":"Manages localized content entries in the project's CMS.","icon":"$undefined","url":"/java-sdk/reference/content-resource","$ref":"(sdks)/java-sdk/reference/content-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/devices-resource.mdx","type":"page","name":"DevicesResource","description":"Manages Slim devices, their live rows and telemetry.","icon":"$undefined","url":"/java-sdk/reference/devices-resource","$ref":"(sdks)/java-sdk/reference/devices-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/documents-resource.mdx","type":"page","name":"DocumentsResource","description":"Lists, uploads and links to the project's documents.","icon":"$undefined","url":"/java-sdk/reference/documents-resource","$ref":"(sdks)/java-sdk/reference/documents-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/email-resource.mdx","type":"page","name":"EmailResource","description":"Reads project email settings.","icon":"$undefined","url":"/java-sdk/reference/email-resource","$ref":"(sdks)/java-sdk/reference/email-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/exports-resource.mdx","type":"page","name":"ExportsResource","description":"Exports patient data.","icon":"$undefined","url":"/java-sdk/reference/exports-resource","$ref":"(sdks)/java-sdk/reference/exports-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/fhir-resource.mdx","type":"page","name":"FhirResource","description":"Reads and writes FHIR R4 resources under the configured FHIR path.","icon":"$undefined","url":"/java-sdk/reference/fhir-resource","$ref":"(sdks)/java-sdk/reference/fhir-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/health-resource.mdx","type":"page","name":"HealthResource","description":"Checks API health.","icon":"$undefined","url":"/java-sdk/reference/health-resource","$ref":"(sdks)/java-sdk/reference/health-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/invites-resource.mdx","type":"page","name":"InvitesResource","description":"Creates and accepts invites.","icon":"$undefined","url":"/java-sdk/reference/invites-resource","$ref":"(sdks)/java-sdk/reference/invites-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/locales-resource.mdx","type":"page","name":"LocalesResource","description":"Reads and changes the project locales.","icon":"$undefined","url":"/java-sdk/reference/locales-resource","$ref":"(sdks)/java-sdk/reference/locales-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/localizations-resource.mdx","type":"page","name":"LocalizationsResource","description":"Manages localization strings.","icon":"$undefined","url":"/java-sdk/reference/localizations-resource","$ref":"(sdks)/java-sdk/reference/localizations-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/locations-resource.mdx","type":"page","name":"LocationsResource","description":"Manages locations through the slim API.","icon":"$undefined","url":"/java-sdk/reference/locations-resource","$ref":"(sdks)/java-sdk/reference/locations-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/login-credentials.mdx","type":"page","name":"LoginCredentials","description":"Email and password for AuthResource.login(LoginCredentials).","icon":"$undefined","url":"/java-sdk/reference/login-credentials","$ref":"(sdks)/java-sdk/reference/login-credentials.mdx"},{"$id":"(sdks)/java-sdk/reference/login-result.mdx","type":"page","name":"LoginResult","description":"Result of a sign-in.","icon":"$undefined","url":"/java-sdk/reference/login-result","$ref":"(sdks)/java-sdk/reference/login-result.mdx"},{"$id":"(sdks)/java-sdk/reference/measurements-resource.mdx","type":"page","name":"MeasurementsResource","description":"Builds, saves and reads measurement Observations.","icon":"$undefined","url":"/java-sdk/reference/measurements-resource","$ref":"(sdks)/java-sdk/reference/measurements-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/medical-notifications-resource.mdx","type":"page","name":"MedicalNotificationsResource","description":"Reads and acknowledges medical notification episodes.","icon":"$undefined","url":"/java-sdk/reference/medical-notifications-resource","$ref":"(sdks)/java-sdk/reference/medical-notifications-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/memory-storage.mdx","type":"page","name":"MemoryStorage","description":"In-memory OvokStorage; the session is lost when the process exits.","icon":"$undefined","url":"/java-sdk/reference/memory-storage","$ref":"(sdks)/java-sdk/reference/memory-storage.mdx"},{"$id":"(sdks)/java-sdk/reference/mfa-challenge.mdx","type":"page","name":"MfaChallenge","description":"Pending MFA sign-in, answered with AuthResource.verifyMfa(MfaChallenge, String).","icon":"$undefined","url":"/java-sdk/reference/mfa-challenge","$ref":"(sdks)/java-sdk/reference/mfa-challenge.mdx"},{"$id":"(sdks)/java-sdk/reference/notification-notes-resource.mdx","type":"page","name":"NotificationNotesResource","description":"Manages notes on notifications.","icon":"$undefined","url":"/java-sdk/reference/notification-notes-resource","$ref":"(sdks)/java-sdk/reference/notification-notes-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/notifications-resource.mdx","type":"page","name":"NotificationsResource","description":"Reads Slim notifications and groups the alarm, out-of-bed, medical and note routes.","icon":"$undefined","url":"/java-sdk/reference/notifications-resource","$ref":"(sdks)/java-sdk/reference/notifications-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/organizations-resource.mdx","type":"page","name":"OrganizationsResource","description":"Manages organizations through the slim API.","icon":"$undefined","url":"/java-sdk/reference/organizations-resource","$ref":"(sdks)/java-sdk/reference/organizations-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/out-of-bed-resource.mdx","type":"page","name":"OutOfBedResource","description":"Reads out-of-bed notifications.","icon":"$undefined","url":"/java-sdk/reference/out-of-bed-resource","$ref":"(sdks)/java-sdk/reference/out-of-bed-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-api-exception.mdx","type":"page","name":"OvokApiException","description":"Thrown when the Ovok API answers with a non-2xx status that has no more specific subclass.","icon":"$undefined","url":"/java-sdk/reference/ovok-api-exception","$ref":"(sdks)/java-sdk/reference/ovok-api-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-authentication-exception.mdx","type":"page","name":"OvokAuthenticationException","description":"Thrown for HTTP 401: missing or invalid credentials.","icon":"$undefined","url":"/java-sdk/reference/ovok-authentication-exception","$ref":"(sdks)/java-sdk/reference/ovok-authentication-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-client.mdx","type":"page","name":"OvokClient","description":"Minimal FHIR reader that uses a fixed access token.","icon":"$undefined","url":"/java-sdk/reference/ovok-client","$ref":"(sdks)/java-sdk/reference/ovok-client.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-config-exception.mdx","type":"page","name":"OvokConfigException","description":"Thrown when the SDK configuration or a call's inputs are invalid before any request is sent.","icon":"$undefined","url":"/java-sdk/reference/ovok-config-exception","$ref":"(sdks)/java-sdk/reference/ovok-config-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-config.mdx","type":"page","name":"OvokConfig","description":"Settings for an Ovok client; build one with builder().","icon":"$undefined","url":"/java-sdk/reference/ovok-config","$ref":"(sdks)/java-sdk/reference/ovok-config.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-conflict-exception.mdx","type":"page","name":"OvokConflictException","description":"Thrown for HTTP 409: the request conflicts with the current state.","icon":"$undefined","url":"/java-sdk/reference/ovok-conflict-exception","$ref":"(sdks)/java-sdk/reference/ovok-conflict-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-connection-exception.mdx","type":"page","name":"OvokConnectionException","description":"Thrown when the SDK cannot reach the Ovok API or a paged read is interrupted.","icon":"$undefined","url":"/java-sdk/reference/ovok-connection-exception","$ref":"(sdks)/java-sdk/reference/ovok-connection-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-exception.mdx","type":"page","name":"OvokException","description":"Base class of every exception the SDK throws; carries the API's error details when there is a response.","icon":"$undefined","url":"/java-sdk/reference/ovok-exception","$ref":"(sdks)/java-sdk/reference/ovok-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-not-found-exception.mdx","type":"page","name":"OvokNotFoundException","description":"Thrown for HTTP 404: the resource does not exist.","icon":"$undefined","url":"/java-sdk/reference/ovok-not-found-exception","$ref":"(sdks)/java-sdk/reference/ovok-not-found-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-permission-exception.mdx","type":"page","name":"OvokPermissionException","description":"Thrown for HTTP 403: signed in but not allowed.","icon":"$undefined","url":"/java-sdk/reference/ovok-permission-exception","$ref":"(sdks)/java-sdk/reference/ovok-permission-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-rate-limit-exception.mdx","type":"page","name":"OvokRateLimitException","description":"Thrown for HTTP 429: rate limited; see retryAfter().","icon":"$undefined","url":"/java-sdk/reference/ovok-rate-limit-exception","$ref":"(sdks)/java-sdk/reference/ovok-rate-limit-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-service-exception.mdx","type":"page","name":"OvokServiceException","description":"Thrown for HTTP 5xx: the Ovok API failed.","icon":"$undefined","url":"/java-sdk/reference/ovok-service-exception","$ref":"(sdks)/java-sdk/reference/ovok-service-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-storage.mdx","type":"page","name":"OvokStorage","description":"Key-value store that keeps the signed-in session between runs.","icon":"$undefined","url":"/java-sdk/reference/ovok-storage","$ref":"(sdks)/java-sdk/reference/ovok-storage.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok-validation-exception.mdx","type":"page","name":"OvokValidationException","description":"Thrown for HTTP 400 and 422, and when the SDK rejects an invalid argument.","icon":"$undefined","url":"/java-sdk/reference/ovok-validation-exception","$ref":"(sdks)/java-sdk/reference/ovok-validation-exception.mdx"},{"$id":"(sdks)/java-sdk/reference/ovok.mdx","type":"page","name":"Ovok","description":"Entry point of the Ovok SDK; exposes one resource per API namespace.","icon":"$undefined","url":"/java-sdk/reference/ovok","$ref":"(sdks)/java-sdk/reference/ovok.mdx"},{"$id":"(sdks)/java-sdk/reference/page.mdx","type":"page","name":"Page","description":"One page of results that can iterate through every later page.","icon":"$undefined","url":"/java-sdk/reference/page","$ref":"(sdks)/java-sdk/reference/page.mdx"},{"$id":"(sdks)/java-sdk/reference/patient-resource.mdx","type":"page","name":"PatientResource","description":"Reads and writes the signed-in patient's FHIR records.","icon":"$undefined","url":"/java-sdk/reference/patient-resource","$ref":"(sdks)/java-sdk/reference/patient-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/patient-thresholds-resource.mdx","type":"page","name":"PatientThresholdsResource","description":"Reads and sets one patient's vital thresholds.","icon":"$undefined","url":"/java-sdk/reference/patient-thresholds-resource","$ref":"(sdks)/java-sdk/reference/patient-thresholds-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/patients-resource.mdx","type":"page","name":"PatientsResource","description":"Manages Slim patients.","icon":"$undefined","url":"/java-sdk/reference/patients-resource","$ref":"(sdks)/java-sdk/reference/patients-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/policies-resource.mdx","type":"page","name":"PoliciesResource","description":"Manages access policies through the slim API.","icon":"$undefined","url":"/java-sdk/reference/policies-resource","$ref":"(sdks)/java-sdk/reference/policies-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/practitioners-resource.mdx","type":"page","name":"PractitionersResource","description":"Invites practitioners.","icon":"$undefined","url":"/java-sdk/reference/practitioners-resource","$ref":"(sdks)/java-sdk/reference/practitioners-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/profile-type.mdx","type":"page","name":"ProfileType","description":"FHIR profile type a user signs in as.","icon":"$undefined","url":"/java-sdk/reference/profile-type","$ref":"(sdks)/java-sdk/reference/profile-type.mdx"},{"$id":"(sdks)/java-sdk/reference/projects-resource.mdx","type":"page","name":"ProjectsResource","description":"Lists projects and manages the current project's members, features and settings.","icon":"$undefined","url":"/java-sdk/reference/projects-resource","$ref":"(sdks)/java-sdk/reference/projects-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/questionnaire-responses-resource.mdx","type":"page","name":"QuestionnaireResponsesResource","description":"Submits QuestionnaireResponses and extracts data from them.","icon":"$undefined","url":"/java-sdk/reference/questionnaire-responses-resource","$ref":"(sdks)/java-sdk/reference/questionnaire-responses-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/questionnaires-resource.mdx","type":"page","name":"QuestionnairesResource","description":"Runs FHIR Questionnaire operations.","icon":"$undefined","url":"/java-sdk/reference/questionnaires-resource","$ref":"(sdks)/java-sdk/reference/questionnaires-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/register-result.mdx","type":"page","name":"RegisterResult","description":"Result of AuthResource.register(Map).","icon":"$undefined","url":"/java-sdk/reference/register-result","$ref":"(sdks)/java-sdk/reference/register-result.mdx"},{"$id":"(sdks)/java-sdk/reference/request-options.mdx","type":"page","name":"RequestOptions","description":"Per-request options.","icon":"$undefined","url":"/java-sdk/reference/request-options","$ref":"(sdks)/java-sdk/reference/request-options.mdx"},{"$id":"(sdks)/java-sdk/reference/save-observations-options.mdx","type":"page","name":"SaveObservationsOptions","description":"Options for saving observations through MeasurementsResource.","icon":"$undefined","url":"/java-sdk/reference/save-observations-options","$ref":"(sdks)/java-sdk/reference/save-observations-options.mdx"},{"$id":"(sdks)/java-sdk/reference/session.mdx","type":"page","name":"Session","description":"Signed-in user session.","icon":"$undefined","url":"/java-sdk/reference/session","$ref":"(sdks)/java-sdk/reference/session.mdx"},{"$id":"(sdks)/java-sdk/reference/sharing-resource.mdx","type":"page","name":"SharingResource","description":"Shares patient records through invites.","icon":"$undefined","url":"/java-sdk/reference/sharing-resource","$ref":"(sdks)/java-sdk/reference/sharing-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/signals-resource.mdx","type":"page","name":"SignalsResource","description":"Enables Signals for patients and repairs undeliverable Signals config.","icon":"$undefined","url":"/java-sdk/reference/signals-resource","$ref":"(sdks)/java-sdk/reference/signals-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/sleep-resource.mdx","type":"page","name":"SleepResource","description":"Reads sleep statistics.","icon":"$undefined","url":"/java-sdk/reference/sleep-resource","$ref":"(sdks)/java-sdk/reference/sleep-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/slim-projects-resource.mdx","type":"page","name":"SlimProjectsResource","description":"Reads and updates Slim projects and their users.","icon":"$undefined","url":"/java-sdk/reference/slim-projects-resource","$ref":"(sdks)/java-sdk/reference/slim-projects-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/slim-resource.mdx","type":"page","name":"SlimResource","description":"Groups the Slim care-home routes (/v1/slim) by resource.","icon":"$undefined","url":"/java-sdk/reference/slim-resource","$ref":"(sdks)/java-sdk/reference/slim-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/thresholds-resource.mdx","type":"page","name":"ThresholdsResource","description":"Reads and sets the project vital thresholds.","icon":"$undefined","url":"/java-sdk/reference/thresholds-resource","$ref":"(sdks)/java-sdk/reference/thresholds-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/trends-resource.mdx","type":"page","name":"TrendsResource","description":"Reads vital trend graphs.","icon":"$undefined","url":"/java-sdk/reference/trends-resource","$ref":"(sdks)/java-sdk/reference/trends-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/unauthenticated-reason.mdx","type":"page","name":"UnauthenticatedReason","description":"Why the SDK signed the user out; passed to OvokConfig.Builder.onUnauthenticated(Consumer).","icon":"$undefined","url":"/java-sdk/reference/unauthenticated-reason","$ref":"(sdks)/java-sdk/reference/unauthenticated-reason.mdx"},{"$id":"(sdks)/java-sdk/reference/users-resource.mdx","type":"page","name":"UsersResource","description":"Deletes users.","icon":"$undefined","url":"/java-sdk/reference/users-resource","$ref":"(sdks)/java-sdk/reference/users-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/video-calls-resource.mdx","type":"page","name":"VideoCallsResource","description":"Runs LiveKit video calls under /video-call/livekit.","icon":"$undefined","url":"/java-sdk/reference/video-calls-resource","$ref":"(sdks)/java-sdk/reference/video-calls-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/wearables-resource.mdx","type":"page","name":"WearablesResource","description":"Manages wearable providers and connections under /v1/wearables.","icon":"$undefined","url":"/java-sdk/reference/wearables-resource","$ref":"(sdks)/java-sdk/reference/wearables-resource.mdx"},{"$id":"(sdks)/java-sdk/reference/zones-resource.mdx","type":"page","name":"ZonesResource","description":"Reads zones.","icon":"$undefined","url":"/java-sdk/reference/zones-resource","$ref":"(sdks)/java-sdk/reference/zones-resource.mdx"}],"$id":"(sdks)/java-sdk/reference","$ref":{"folder":"(sdks)/java-sdk/reference","meta":"(sdks)/java-sdk/reference/meta.json"},"index":{"$id":"(sdks)/java-sdk/reference/index.mdx","type":"page","name":"API reference","description":"Generated reference for every public class of the Java SDK.","icon":"$undefined","url":"/java-sdk/reference","$ref":"(sdks)/java-sdk/reference/index.mdx"},"icon":"$undefined"},{"$id":"_48","type":"separator","icon":"$undefined","name":"Flutter SDK"},{"$id":"(sdks)/flutter-sdk/index.mdx","type":"page","name":"Flutter SDK","description":"Call the Ovok API from Dart and Flutter apps.","icon":"$undefined","url":"/flutter-sdk","$ref":"(sdks)/flutter-sdk/index.mdx"},{"$id":"(sdks)/flutter-sdk/getting-started.mdx","type":"page","name":"Get started","description":"The SDK requires Dart 3.6 or later. Flutter apps can use ovok_flutter, which re-exports","icon":"$undefined","url":"/flutter-sdk/getting-started","$ref":"(sdks)/flutter-sdk/getting-started.mdx"},{"$id":"(sdks)/flutter-sdk/flutter.mdx","type":"page","name":"Flutter package","description":"What ovok_flutter adds over ovok_sdk, and how to set it up in a Flutter app.","icon":"$undefined","url":"/flutter-sdk/flutter","$ref":"(sdks)/flutter-sdk/flutter.mdx"},{"$id":"(sdks)/flutter-sdk/authentication.mdx","type":"page","name":"Authentication","description":"ovok.auth signs users in to the configured tenant and keeps their session in the","icon":"$undefined","url":"/flutter-sdk/authentication","$ref":"(sdks)/flutter-sdk/authentication.mdx"},{"$id":"(sdks)/flutter-sdk/auth-widgets.mdx","type":"page","name":"Auth widgets","description":"Sign-in, registration, password reset and account widgets for Flutter.","icon":"$undefined","url":"/flutter-sdk/auth-widgets","$ref":"(sdks)/flutter-sdk/auth-widgets.mdx"},{"$id":"(sdks)/flutter-sdk/fhir.mdx","type":"page","name":"FHIR and paging","description":"ovok.fhir reads and writes FHIR R4 resources as decoded JSON (JsonMap).","icon":"$undefined","url":"/flutter-sdk/fhir","$ref":"(sdks)/flutter-sdk/fhir.mdx"},{"$id":"(sdks)/flutter-sdk/bluetooth.mdx","type":"page","name":"Bluetooth devices","description":"Scan for supported BLE peripherals and collect their readings.","icon":"$undefined","url":"/flutter-sdk/bluetooth","$ref":"(sdks)/flutter-sdk/bluetooth.mdx"},{"$id":"(sdks)/flutter-sdk/questionnaire-forms.mdx","type":"page","name":"Questionnaire forms","description":"Render FHIR Questionnaires as validated Flutter forms.","icon":"$undefined","url":"/flutter-sdk/questionnaire-forms","$ref":"(sdks)/flutter-sdk/questionnaire-forms.mdx"},{"$id":"(sdks)/flutter-sdk/realtime.mdx","type":"page","name":"Realtime updates","description":"ovok.realtime.subscribe() creates a FHIR Subscription, opens its authenticated","icon":"$undefined","url":"/flutter-sdk/realtime","$ref":"(sdks)/flutter-sdk/realtime.mdx"},{"$id":"(sdks)/flutter-sdk/measurements.mdx","type":"page","name":"Measurements","description":"ovok.measurements turns device readings into FHIR Observations and saves them so a","icon":"$undefined","url":"/flutter-sdk/measurements","$ref":"(sdks)/flutter-sdk/measurements.mdx"},{"$id":"(sdks)/flutter-sdk/background-sync.mdx","type":"page","name":"Background sync","description":"Schedule secure offline measurement delivery on Android and iOS.","icon":"$undefined","url":"/flutter-sdk/background-sync","$ref":"(sdks)/flutter-sdk/background-sync.mdx"},{"$id":"(sdks)/flutter-sdk/data-sync.mdx","type":"page","name":"Data sync","description":"Display health data sync progress in a Flutter app.","icon":"$undefined","url":"/flutter-sdk/data-sync","$ref":"(sdks)/flutter-sdk/data-sync.mdx"},{"$id":"(sdks)/flutter-sdk/health-sync.mdx","type":"page","name":"Health data sync","description":"Read step counts and heart rate from Apple Health and Health Connect.","icon":"$undefined","url":"/flutter-sdk/health-sync","$ref":"(sdks)/flutter-sdk/health-sync.mdx"},{"$id":"(sdks)/flutter-sdk/patient-apps.mdx","type":"page","name":"Patient apps","description":"These namespaces serve apps used by a signed-in patient.","icon":"$undefined","url":"/flutter-sdk/patient-apps","$ref":"(sdks)/flutter-sdk/patient-apps.mdx"},{"$id":"(sdks)/flutter-sdk/care-platform.mdx","type":"page","name":"Care platform","description":"These namespaces serve care teams and administrators.","icon":"$undefined","url":"/flutter-sdk/care-platform","$ref":"(sdks)/flutter-sdk/care-platform.mdx"},{"$id":"(sdks)/flutter-sdk/errors-and-retries.mdx","type":"page","name":"Errors and retries","description":"Every failure is an OvokException with status, code, type, message,","icon":"$undefined","url":"/flutter-sdk/errors-and-retries","$ref":"(sdks)/flutter-sdk/errors-and-retries.mdx"},{"type":"folder","name":"API reference","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"ovok_sdk","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/ai-resource.mdx","type":"page","name":"AI resource","description":"Generated reference for ovok_sdk: ai resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/ai-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/ai-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/auth-resource.mdx","type":"page","name":"Auth resource","description":"Generated reference for ovok_sdk: auth resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/auth-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/auth-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/auth-sessions-resource.mdx","type":"page","name":"Auth sessions resource","description":"Generated reference for ovok_sdk: auth sessions resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/auth-sessions-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/auth-sessions-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/bots-resource.mdx","type":"page","name":"Bots resource","description":"Generated reference for ovok_sdk: bots resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/bots-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/bots-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/cms-resource.mdx","type":"page","name":"CMS resource","description":"Generated reference for ovok_sdk: cms resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/cms-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/cms-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/consent-resource.mdx","type":"page","name":"Consent resource","description":"Generated reference for ovok_sdk: consent resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/consent-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/consent-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/content-resource.mdx","type":"page","name":"Content resource","description":"Generated reference for ovok_sdk: content resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/content-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/content-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/documents-resource.mdx","type":"page","name":"Documents resource","description":"Generated reference for ovok_sdk: documents resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/documents-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/documents-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/fhir-resource.mdx","type":"page","name":"FHIR resource","description":"Generated reference for ovok_sdk: fhir resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/fhir-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/fhir-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/health-resource.mdx","type":"page","name":"Health resource","description":"Generated reference for ovok_sdk: health resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/health-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/health-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/measurement-types.mdx","type":"page","name":"Measurement types","description":"Generated reference for ovok_sdk: measurement types.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/measurement-types","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/measurement-types.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/measurements-resource.mdx","type":"page","name":"Measurements resource","description":"Generated reference for ovok_sdk: measurements resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/measurements-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/measurements-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/offline-measurement-queue.mdx","type":"page","name":"Offline measurement queue","description":"Generated reference for ovok_sdk: offline measurement queue.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/offline-measurement-queue","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/offline-measurement-queue.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/ovok-exception.mdx","type":"page","name":"Ovok exception","description":"Generated reference for ovok_sdk: ovok exception.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/ovok-exception","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/ovok-exception.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/ovok-secure-store.mdx","type":"page","name":"Ovok secure store","description":"Generated reference for ovok_sdk: ovok secure store.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/ovok-secure-store","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/ovok-secure-store.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/ovok.mdx","type":"page","name":"Ovok","description":"Generated reference for ovok_sdk: ovok.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/ovok","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/ovok.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/page.mdx","type":"page","name":"Page","description":"Generated reference for ovok_sdk: page.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/page","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/page.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/patch-operation.mdx","type":"page","name":"Patch operation","description":"Generated reference for ovok_sdk: patch operation.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/patch-operation","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/patch-operation.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/patient-resource.mdx","type":"page","name":"Patient resource","description":"Generated reference for ovok_sdk: patient resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/patient-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/patient-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/platform-resources.mdx","type":"page","name":"Platform resources","description":"Generated reference for ovok_sdk: platform resources.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/platform-resources","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/platform-resources.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/questionnaires-resource.mdx","type":"page","name":"Questionnaires resource","description":"Generated reference for ovok_sdk: questionnaires resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/questionnaires-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/questionnaires-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/realtime-resource.mdx","type":"page","name":"Realtime resource","description":"Generated reference for ovok_sdk: realtime resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/realtime-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/realtime-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/registration.mdx","type":"page","name":"Registration","description":"Generated reference for ovok_sdk: registration.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/registration","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/registration.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/resource-types.mdx","type":"page","name":"Resource types","description":"Generated reference for ovok_sdk: resource types.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/resource-types","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/resource-types.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/session.mdx","type":"page","name":"Session","description":"Generated reference for ovok_sdk: session.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/session","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/session.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/sign-in-results.mdx","type":"page","name":"Sign in results","description":"Generated reference for ovok_sdk: sign in results.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/sign-in-results","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/sign-in-results.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/signals-resource.mdx","type":"page","name":"Signals resource","description":"Generated reference for ovok_sdk: signals resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/signals-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/signals-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/slim-resource.mdx","type":"page","name":"Slim resource","description":"Generated reference for ovok_sdk: slim resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/slim-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/slim-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/url.mdx","type":"page","name":"URL","description":"Generated reference for ovok_sdk: url.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/url","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/url.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/user-session.mdx","type":"page","name":"User session","description":"Generated reference for ovok_sdk: user session.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/user-session","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/user-session.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/video-calls-resource.mdx","type":"page","name":"Video calls resource","description":"Generated reference for ovok_sdk: video calls resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/video-calls-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/video-calls-resource.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/wearables-resource.mdx","type":"page","name":"Wearables resource","description":"Generated reference for ovok_sdk: wearables resource.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk/wearables-resource","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/wearables-resource.mdx"}],"$id":"(sdks)/flutter-sdk/reference/ovok_sdk","$ref":{"folder":"(sdks)/flutter-sdk/reference/ovok_sdk","meta":"(sdks)/flutter-sdk/reference/ovok_sdk/meta.json"},"index":{"$id":"(sdks)/flutter-sdk/reference/ovok_sdk/index.mdx","type":"page","name":"ovok_sdk","description":"Generated reference for ovok_sdk.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_sdk","$ref":"(sdks)/flutter-sdk/reference/ovok_sdk/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"ovok_flutter","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/account-actions.mdx","type":"page","name":"Account actions","description":"Generated reference for ovok_flutter: account actions.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/account-actions","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/account-actions.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/auth-translations.mdx","type":"page","name":"Auth translations","description":"Generated reference for ovok_flutter: auth translations.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/auth-translations","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/auth-translations.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/background-safe-storage.mdx","type":"page","name":"Background safe storage","description":"Generated reference for ovok_flutter: background safe storage.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/background-safe-storage","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/background-safe-storage.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/bluetooth-device-instructions.mdx","type":"page","name":"Bluetooth device instructions","description":"Generated reference for ovok_flutter: bluetooth device instructions.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/bluetooth-device-instructions","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/bluetooth-device-instructions.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/bluetooth-device-manager.mdx","type":"page","name":"Bluetooth device manager","description":"Generated reference for ovok_flutter: bluetooth device manager.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/bluetooth-device-manager","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/bluetooth-device-manager.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/bluetooth-device-picker.mdx","type":"page","name":"Bluetooth device picker","description":"Generated reference for ovok_flutter: bluetooth device picker.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/bluetooth-device-picker","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/bluetooth-device-picker.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/bluetooth-provider.mdx","type":"page","name":"Bluetooth provider","description":"Generated reference for ovok_flutter: bluetooth provider.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/bluetooth-provider","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/bluetooth-provider.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/built-in-devices.mdx","type":"page","name":"Built in devices","description":"Generated reference for ovok_flutter: built in devices.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/built-in-devices","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/built-in-devices.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/driver.mdx","type":"page","name":"Driver","description":"Generated reference for ovok_flutter: driver.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/driver","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/driver.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/errors.mdx","type":"page","name":"Errors","description":"Generated reference for ovok_flutter: errors.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/errors","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/errors.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/flutter-reactive-ble-scanner.mdx","type":"page","name":"Flutter reactive ble scanner","description":"Generated reference for ovok_flutter: flutter reactive ble scanner.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/flutter-reactive-ble-scanner","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/flutter-reactive-ble-scanner.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/health-data-mode.mdx","type":"page","name":"Health data mode","description":"Generated reference for ovok_flutter: health data mode.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/health-data-mode","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/health-data-mode.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/health-import-provider.mdx","type":"page","name":"Health import provider","description":"Generated reference for ovok_flutter: health import provider.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/health-import-provider","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/health-import-provider.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/health-import.mdx","type":"page","name":"Health import","description":"Generated reference for ovok_flutter: health import.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/health-import","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/health-import.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/health-sync-configuration.mdx","type":"page","name":"Health sync configuration","description":"Generated reference for ovok_flutter: health sync configuration.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/health-sync-configuration","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/health-sync-configuration.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/health-sync-mobile.mdx","type":"page","name":"Health sync mobile","description":"Generated reference for ovok_flutter: health sync mobile.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/health-sync-mobile","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/health-sync-mobile.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/health-sync-types.mdx","type":"page","name":"Health sync types","description":"Generated reference for ovok_flutter: health sync types.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/health-sync-types","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/health-sync-types.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/integrated-devices.mdx","type":"page","name":"Integrated devices","description":"Generated reference for ovok_flutter: integrated devices.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/integrated-devices","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/integrated-devices.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/models.mdx","type":"page","name":"Models","description":"Generated reference for ovok_flutter: models.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/models","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/models.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/notifications.mdx","type":"page","name":"Notifications","description":"Generated reference for ovok_flutter: notifications.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/notifications","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/notifications.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/offline-measurement-background-sync.mdx","type":"page","name":"Offline measurement background sync","description":"Generated reference for ovok_flutter: offline measurement background sync.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/offline-measurement-background-sync","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/offline-measurement-background-sync.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/os-permissions.mdx","type":"page","name":"Os permissions","description":"Generated reference for ovok_flutter: os permissions.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/os-permissions","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/os-permissions.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/ports.mdx","type":"page","name":"Ports","description":"Generated reference for ovok_flutter: ports.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/ports","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/ports.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/profile-form.mdx","type":"page","name":"Profile form","description":"Generated reference for ovok_flutter: profile form.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/profile-form","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/profile-form.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/questionnaire-form.mdx","type":"page","name":"Questionnaire form","description":"Generated reference for ovok_flutter: questionnaire form.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/questionnaire-form","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/questionnaire-form.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/reading-sink.mdx","type":"page","name":"Reading sink","description":"Generated reference for ovok_flutter: reading sink.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/reading-sink","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/reading-sink.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/register.mdx","type":"page","name":"Register","description":"Generated reference for ovok_flutter: register.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/register","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/register.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/reset-password.mdx","type":"page","name":"Reset password","description":"Generated reference for ovok_flutter: reset password.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/reset-password","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/reset-password.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/result-policy.mdx","type":"page","name":"Result policy","description":"Generated reference for ovok_flutter: result policy.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/result-policy","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/result-policy.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/runtime-factory.mdx","type":"page","name":"Runtime factory","description":"Generated reference for ovok_flutter: runtime factory.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/runtime-factory","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/runtime-factory.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/runtime.mdx","type":"page","name":"Runtime","description":"Generated reference for ovok_flutter: runtime.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/runtime","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/runtime.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/session-list.mdx","type":"page","name":"Session list","description":"Generated reference for ovok_flutter: session list.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/session-list","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/session-list.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/sig-profiles.mdx","type":"page","name":"Sig profiles","description":"Generated reference for ovok_flutter: sig profiles.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/sig-profiles","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/sig-profiles.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/sign-in.mdx","type":"page","name":"Sign in","description":"Generated reference for ovok_flutter: sign in.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/sign-in","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/sign-in.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/sync-progress-list.mdx","type":"page","name":"Sync progress list","description":"Generated reference for ovok_flutter: sync progress list.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/sync-progress-list","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/sync-progress-list.mdx"},{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/sync-progress.mdx","type":"page","name":"Sync progress","description":"Generated reference for ovok_flutter: sync progress.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter/sync-progress","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/sync-progress.mdx"}],"$id":"(sdks)/flutter-sdk/reference/ovok_flutter","$ref":{"folder":"(sdks)/flutter-sdk/reference/ovok_flutter","meta":"(sdks)/flutter-sdk/reference/ovok_flutter/meta.json"},"index":{"$id":"(sdks)/flutter-sdk/reference/ovok_flutter/index.mdx","type":"page","name":"ovok_flutter","description":"Generated reference for ovok_flutter.","icon":"$undefined","url":"/flutter-sdk/reference/ovok_flutter","$ref":"(sdks)/flutter-sdk/reference/ovok_flutter/index.mdx"},"icon":"$undefined"}],"$id":"(sdks)/flutter-sdk/reference","$ref":{"folder":"(sdks)/flutter-sdk/reference","meta":"(sdks)/flutter-sdk/reference/meta.json"},"index":{"$id":"(sdks)/flutter-sdk/reference/index.mdx","type":"page","name":"API reference","description":"Generated reference for every public symbol of the Flutter SDK packages.","icon":"$undefined","url":"/flutter-sdk/reference","$ref":"(sdks)/flutter-sdk/reference/index.mdx"},"icon":"$undefined"}],"$id":"(sdks)","$ref":{"folder":"(sdks)","meta":"(sdks)/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Guides","root":true,"defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"_49","type":"separator","icon":"$undefined","name":"Guides"},{"$id":"(guides)/guides/index.mdx","type":"page","name":"Guides","description":"Step-by-step guides for building with OVOK.","icon":"$undefined","url":"/guides","$ref":"(guides)/guides/index.mdx"},{"type":"folder","name":"Blood-pressure monitoring","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(guides)/guides/chf-remote-monitoring/create-the-react-native-app.mdx","type":"page","name":"1. Create the app","description":"Create an Expo project, install Ovok Native and its required peer packages, and configure Bluetooth native permissions.","icon":"$undefined","url":"/guides/chf-remote-monitoring/create-the-react-native-app","$ref":"(guides)/guides/chf-remote-monitoring/create-the-react-native-app.mdx"},{"$id":"(guides)/guides/chf-remote-monitoring/create-and-configure-the-ovok-project.mdx","type":"page","name":"2. Configure Ovok","description":"Set up a sandbox project, patient registration, login, AccessPolicy, and atomic measurement writes in Ovok Console.","icon":"$undefined","url":"/guides/chf-remote-monitoring/create-and-configure-the-ovok-project","$ref":"(guides)/guides/chf-remote-monitoring/create-and-configure-the-ovok-project.mdx"},{"$id":"(guides)/guides/chf-remote-monitoring/configure-localisation.mdx","type":"page","name":"3. Localisation","description":"Initialize i18next and load published app translations from Ovok CMS rather than bundling translation files.","icon":"$undefined","url":"/guides/chf-remote-monitoring/configure-localisation","$ref":"(guides)/guides/chf-remote-monitoring/configure-localisation.mdx"},{"$id":"(guides)/guides/chf-remote-monitoring/choose-connected-devices.mdx","type":"page","name":"4. Choose devices","description":"Select the Viatom BP2 and F4 / LeScale from the current React Native SDK catalog and verify their measurement capabilities.","icon":"$undefined","url":"/guides/chf-remote-monitoring/choose-connected-devices","$ref":"(guides)/guides/chf-remote-monitoring/choose-connected-devices.mdx"},{"$id":"(guides)/guides/chf-remote-monitoring/initialise-ovok-and-bluetooth.mdx","type":"page","name":"5. Initialise Ovok","description":"Create one persisted Ovok client and mount the native Bluetooth runtime for the authenticated patient area.","icon":"$undefined","url":"/guides/chf-remote-monitoring/initialise-ovok-and-bluetooth","$ref":"(guides)/guides/chf-remote-monitoring/initialise-ovok-and-bluetooth.mdx"},{"$id":"(guides)/guides/chf-remote-monitoring/build-onboarding-and-authentication.mdx","type":"page","name":"6. Onboarding and auth","description":"Add patient sign-in, patient registration, and a protected app area using the native Ovok authentication components.","icon":"$undefined","url":"/guides/chf-remote-monitoring/build-onboarding-and-authentication","$ref":"(guides)/guides/chf-remote-monitoring/build-onboarding-and-authentication.mdx"},{"$id":"(guides)/guides/chf-remote-monitoring/build-the-measurement-screen.mdx","type":"page","name":"7. Measurement screen","description":"Save blood-pressure, ECG, and LeScale weight readings through Ovok and render recent values and ECG waveforms.","icon":"$undefined","url":"/guides/chf-remote-monitoring/build-the-measurement-screen","$ref":"(guides)/guides/chf-remote-monitoring/build-the-measurement-screen.mdx"},{"$id":"(guides)/guides/chf-remote-monitoring/build-the-devices-section.mdx","type":"page","name":"8. Devices","description":"Let patients discover, pair, review, and forget the two supported tutorial devices.","icon":"$undefined","url":"/guides/chf-remote-monitoring/build-the-devices-section","$ref":"(guides)/guides/chf-remote-monitoring/build-the-devices-section.mdx"},{"$id":"(guides)/guides/chf-remote-monitoring/build-settings.mdx","type":"page","name":"9. Settings","description":"Build an account settings screen with supported profile editing, language selection, device access, consent information, and sign-out.","icon":"$undefined","url":"/guides/chf-remote-monitoring/build-settings","$ref":"(guides)/guides/chf-remote-monitoring/build-settings.mdx"},{"$id":"(guides)/guides/chf-remote-monitoring/complete-localisation.mdx","type":"page","name":"10. Localisation","description":"Publish every patient-app and native-auth translation in Ovok CMS, then switch languages through i18next.","icon":"$undefined","url":"/guides/chf-remote-monitoring/complete-localisation","$ref":"(guides)/guides/chf-remote-monitoring/complete-localisation.mdx"}],"$id":"(guides)/guides/chf-remote-monitoring","$ref":{"folder":"(guides)/guides/chf-remote-monitoring","meta":"(guides)/guides/chf-remote-monitoring/meta.json"},"index":{"$id":"(guides)/guides/chf-remote-monitoring/index.mdx","type":"page","name":"Blood-pressure monitoring","description":"Build a patient app that pairs a blood-pressure monitor and a scale over Bluetooth, saves every reading to Ovok, and shows the history.","icon":"$undefined","url":"/guides/chf-remote-monitoring","$ref":"(guides)/guides/chf-remote-monitoring/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Medication Reminder","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(guides)/guides/medication-reminder/create-the-react-native-app.mdx","type":"page","name":"1. Create the app","description":"Set up Expo, the Ovok SDKs, local notifications, SQLCipher storage, and native builds for the medication reminder tutorial.","icon":"$undefined","url":"/guides/medication-reminder/create-the-react-native-app","$ref":"(guides)/guides/medication-reminder/create-the-react-native-app.mdx"},{"$id":"(guides)/guides/medication-reminder/create-and-configure-the-ovok-project.mdx","type":"page","name":"2. Configure Ovok","description":"Configure a sandbox project, patient access, medication resource permissions, transactions, and CMS translations for the tutorial app.","icon":"$undefined","url":"/guides/medication-reminder/create-and-configure-the-ovok-project","$ref":"(guides)/guides/medication-reminder/create-and-configure-the-ovok-project.mdx"},{"$id":"(guides)/guides/medication-reminder/model-the-medication-plan.mdx","type":"page","name":"3. Model the plan","description":"Represent a synthetic medication schedule with supported FHIR R4 resources and read it without inventing an Ovok medication abstraction.","icon":"$undefined","url":"/guides/medication-reminder/model-the-medication-plan","$ref":"(guides)/guides/medication-reminder/model-the-medication-plan.mdx"},{"$id":"(guides)/guides/medication-reminder/set-up-localisation-and-time-handling.mdx","type":"page","name":"4. Localisation and time","description":"Load interface strings from Ovok CMS and define how the app interprets FHIR wall-clock medication times across locales and timezones.","icon":"$undefined","url":"/guides/medication-reminder/set-up-localisation-and-time-handling","$ref":"(guides)/guides/medication-reminder/set-up-localisation-and-time-handling.mdx"},{"$id":"(guides)/guides/medication-reminder/initialise-ovok-and-authentication.mdx","type":"page","name":"5. Ovok and auth","description":"Configure a persisted Ovok client, sign in through React Native SDK patient forms, and load the authenticated Patient's medication plan.","icon":"$undefined","url":"/guides/medication-reminder/initialise-ovok-and-authentication","$ref":"(guides)/guides/medication-reminder/initialise-ovok-and-authentication.mdx"},{"$id":"(guides)/guides/medication-reminder/build-the-today-screen.mdx","type":"page","name":"6. Today screen","description":"Turn supported MedicationRequest timing into a patient-facing daily schedule with explicit upcoming, due, recorded, and app-derived missed states.","icon":"$undefined","url":"/guides/medication-reminder/build-the-today-screen","$ref":"(guides)/guides/medication-reminder/build-the-today-screen.mdx"},{"$id":"(guides)/guides/medication-reminder/add-medication-reminders.mdx","type":"page","name":"7. Local reminders","description":"Schedule, replace, and cancel privacy-conscious local medication reminders with Expo Notifications.","icon":"$undefined","url":"/guides/medication-reminder/add-medication-reminders","$ref":"(guides)/guides/medication-reminder/add-medication-reminders.mdx"},{"$id":"(guides)/guides/medication-reminder/record-medication-adherence.mdx","type":"page","name":"8. Record adherence","description":"Save patient-reported taken and skipped dose occurrences as supported FHIR MedicationAdministration resources.","icon":"$undefined","url":"/guides/medication-reminder/record-medication-adherence","$ref":"(guides)/guides/medication-reminder/record-medication-adherence.mdx"},{"$id":"(guides)/guides/medication-reminder/build-history-and-medication-details.mdx","type":"page","name":"9. History and details","description":"Show the source MedicationRequest and patient-reported MedicationAdministration history with paginated FHIR searches.","icon":"$undefined","url":"/guides/medication-reminder/build-history-and-medication-details","$ref":"(guides)/guides/medication-reminder/build-history-and-medication-details.mdx"},{"$id":"(guides)/guides/medication-reminder/offline-settings-and-localisation.mdx","type":"page","name":"10. Offline and finish","description":"Add an encrypted app-owned FHIR cache and adherence outbox, then finish settings and CMS-backed English/German UI text.","icon":"$undefined","url":"/guides/medication-reminder/offline-settings-and-localisation","$ref":"(guides)/guides/medication-reminder/offline-settings-and-localisation.mdx"}],"$id":"(guides)/guides/medication-reminder","$ref":{"folder":"(guides)/guides/medication-reminder","meta":"(guides)/guides/medication-reminder/meta.json"},"index":{"$id":"(guides)/guides/medication-reminder/index.mdx","type":"page","name":"Build a Medication Reminder App with Ovok in 30 Minutes","description":"A hands-on Expo and React Native tutorial for medication plans, local reminders, patient-reported adherence, and offline behavior with Ovok.","icon":"$undefined","url":"/guides/medication-reminder","$ref":"(guides)/guides/medication-reminder/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Type 2 Diabetes Risk Screening","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(guides)/guides/type-2-diabetes/create-the-react-native-app.mdx","type":"page","name":"1. Create the app","description":"Create an Expo Router app with current Ovok packages, native Bluetooth permissions, and a reproducible development build.","icon":"$undefined","url":"/guides/type-2-diabetes/create-the-react-native-app","$ref":"(guides)/guides/type-2-diabetes/create-the-react-native-app.mdx"},{"$id":"(guides)/guides/type-2-diabetes/create-and-configure-the-ovok-project.mdx","type":"page","name":"2. Configure Ovok","description":"Configure a sandbox project for patient registration, least-privilege Questionnaire access, QuestionnaireResponse writes, and glucose Observations.","icon":"$undefined","url":"/guides/type-2-diabetes/create-and-configure-the-ovok-project","$ref":"(guides)/guides/type-2-diabetes/create-and-configure-the-ovok-project.mdx"},{"$id":"(guides)/guides/type-2-diabetes/configure-localisation.mdx","type":"page","name":"3. Localisation","description":"Initialize i18next and load the app's published interface strings from Ovok CMS, keeping clinical Questionnaire content separate.","icon":"$undefined","url":"/guides/type-2-diabetes/configure-localisation","$ref":"(guides)/guides/type-2-diabetes/configure-localisation.mdx"},{"$id":"(guides)/guides/type-2-diabetes/choose-the-glucose-device.mdx","type":"page","name":"4. Choose the device","description":"Verify TeleBGM Gen1 BLE in the current supported-device catalogue and use its Ovok runtime declaration.","icon":"$undefined","url":"/guides/type-2-diabetes/choose-the-glucose-device","$ref":"(guides)/guides/type-2-diabetes/choose-the-glucose-device.mdx"},{"$id":"(guides)/guides/type-2-diabetes/add-the-findrisc-questionnaire.mdx","type":"page","name":"5. FINDRISC Questionnaire","description":"Load a licensed FHIR Questionnaire, render its answers as QuestionnaireResponse, and verify an app-owned scoring map with boundary tests.","icon":"$undefined","url":"/guides/type-2-diabetes/add-the-findrisc-questionnaire","$ref":"(guides)/guides/type-2-diabetes/add-the-findrisc-questionnaire.mdx"},{"$id":"(guides)/guides/type-2-diabetes/initialise-ovok-auth-and-bluetooth.mdx","type":"page","name":"6. Initialise and authenticate","description":"Create one persistent OvokClient, compose providers, protect Patient routes, and start one authenticated TeleBGM Bluetooth runtime.","icon":"$undefined","url":"/guides/type-2-diabetes/initialise-ovok-auth-and-bluetooth","$ref":"(guides)/guides/type-2-diabetes/initialise-ovok-auth-and-bluetooth.mdx"},{"$id":"(guides)/guides/type-2-diabetes/build-the-screening-home.mdx","type":"page","name":"7. Screening home","description":"Build an independent FINDRISC assessment card and glucose card, render the approved FHIR Questionnaire, and persist its response.","icon":"$undefined","url":"/guides/type-2-diabetes/build-the-screening-home","$ref":"(guides)/guides/type-2-diabetes/build-the-screening-home.mdx"},{"$id":"(guides)/guides/type-2-diabetes/connect-telebgm-and-save-readings.mdx","type":"page","name":"8. Connect and measure","description":"Discover and pair TeleBGM Gen1 BLE, receive normalized mg/dL readings, and save them through Ovok as FHIR Observations.","icon":"$undefined","url":"/guides/type-2-diabetes/connect-telebgm-and-save-readings","$ref":"(guides)/guides/type-2-diabetes/connect-telebgm-and-save-readings.mdx"},{"$id":"(guides)/guides/type-2-diabetes/build-results-and-history.mdx","type":"page","name":"9. Results and history","description":"Read Patient-scoped QuestionnaireResponses and blood-glucose Observations, preserving the distinction between a risk assessment and a measurement.","icon":"$undefined","url":"/guides/type-2-diabetes/build-results-and-history","$ref":"(guides)/guides/type-2-diabetes/build-results-and-history.mdx"},{"$id":"(guides)/guides/type-2-diabetes/settings-localisation-and-validation.mdx","type":"page","name":"10. Finish and validate","description":"Add a Patient settings screen, persist the UI language, finish CMS translations, and verify the complete sandbox journey.","icon":"$undefined","url":"/guides/type-2-diabetes/settings-localisation-and-validation","$ref":"(guides)/guides/type-2-diabetes/settings-localisation-and-validation.mdx"}],"$id":"(guides)/guides/type-2-diabetes","$ref":{"folder":"(guides)/guides/type-2-diabetes","meta":"(guides)/guides/type-2-diabetes/meta.json"},"index":{"$id":"(guides)/guides/type-2-diabetes/index.mdx","type":"page","name":"Build a Type 2 Diabetes Risk Screening App with Ovok in 30 Minutes","description":"A ten-step Expo and React Native implementation guide for FINDRISC, FHIR questionnaires, TeleBGM Gen1 BLE, and blood-glucose Observations.","icon":"$undefined","url":"/guides/type-2-diabetes","$ref":"(guides)/guides/type-2-diabetes/index.mdx"},"icon":"$undefined"},{"type":"folder","name":"Whole-Person Healthspan & Coaching","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(guides)/guides/whole-person-wellness/create-the-react-native-app.mdx","type":"page","name":"1. Create the app","description":"Create the Expo project, install Ovok packages and configure native health-platform permissions.","icon":"$undefined","url":"/guides/whole-person-wellness/create-the-react-native-app","$ref":"(guides)/guides/whole-person-wellness/create-the-react-native-app.mdx"},{"$id":"(guides)/guides/whole-person-wellness/create-and-configure-the-ovok-project.mdx","type":"page","name":"2. Configure Ovok","description":"Configure a sandbox project, patient registration and least-privilege access for the tutorial.","icon":"$undefined","url":"/guides/whole-person-wellness/create-and-configure-the-ovok-project","$ref":"(guides)/guides/whole-person-wellness/create-and-configure-the-ovok-project.mdx"},{"$id":"(guides)/guides/whole-person-wellness/build-onboarding-authentication-and-profile.mdx","type":"page","name":"3. Onboarding and auth","description":"Build patient registration and sign-in with Ovok Native, then load the authenticated Patient profile.","icon":"$undefined","url":"/guides/whole-person-wellness/build-onboarding-authentication-and-profile","$ref":"(guides)/guides/whole-person-wellness/build-onboarding-authentication-and-profile.mdx"},{"$id":"(guides)/guides/whole-person-wellness/connect-apple-health-and-health-connect.mdx","type":"page","name":"4. Connect health data","description":"Request optional, read-only health access and import supported sleep, step-count and resting-heart-rate records.","icon":"$undefined","url":"/guides/whole-person-wellness/connect-apple-health-and-health-connect","$ref":"(guides)/guides/whole-person-wellness/connect-apple-health-and-health-connect.mdx"},{"$id":"(guides)/guides/whole-person-wellness/build-the-five-domain-wellness-model.mdx","type":"page","name":"5. Model the five domains","description":"Separate imported measurements from sleep, movement, nutrition, stress and recovery reflections.","icon":"$undefined","url":"/guides/whole-person-wellness/build-the-five-domain-wellness-model","$ref":"(guides)/guides/whole-person-wellness/build-the-five-domain-wellness-model.mdx"},{"$id":"(guides)/guides/whole-person-wellness/build-weekly-wellness-reflection.mdx","type":"page","name":"6. Weekly reflection","description":"Create a FHIR Questionnaire for a short non-clinical weekly check-in and save responses with QuestionnaireForm.","icon":"$undefined","url":"/guides/whole-person-wellness/build-weekly-wellness-reflection","$ref":"(guides)/guides/whole-person-wellness/build-weekly-wellness-reflection.mdx"},{"$id":"(guides)/guides/whole-person-wellness/build-the-healthspan-dashboard-and-trends.mdx","type":"page","name":"7. Dashboard and trends","description":"Render reflections and supported measurements as separate, descriptive trends.","icon":"$undefined","url":"/guides/whole-person-wellness/build-the-healthspan-dashboard-and-trends","$ref":"(guides)/guides/whole-person-wellness/build-the-healthspan-dashboard-and-trends.mdx"},{"$id":"(guides)/guides/whole-person-wellness/add-the-coach-relationship.mdx","type":"page","name":"8. Add a coach","description":"Represent a coach with FHIR resources and use Ovok's server-enforced practitioner-sharing flow.","icon":"$undefined","url":"/guides/whole-person-wellness/add-the-coach-relationship","$ref":"(guides)/guides/whole-person-wellness/add-the-coach-relationship.mdx"},{"$id":"(guides)/guides/whole-person-wellness/add-goals-and-progress-reviews.mdx","type":"page","name":"9. Goals and reviews","description":"Store member-chosen goals as FHIR Goal resources and review them with a coach.","icon":"$undefined","url":"/guides/whole-person-wellness/add-goals-and-progress-reviews","$ref":"(guides)/guides/whole-person-wellness/add-goals-and-progress-reviews.mdx"},{"$id":"(guides)/guides/whole-person-wellness/finish-history-settings-localisation-and-validation.mdx","type":"page","name":"10. Finish the app","description":"Complete longitudinal history, health-data settings, Ovok CMS translations and end-to-end checks.","icon":"$undefined","url":"/guides/whole-person-wellness/finish-history-settings-localisation-and-validation","$ref":"(guides)/guides/whole-person-wellness/finish-history-settings-localisation-and-validation.mdx"}],"$id":"(guides)/guides/whole-person-wellness","$ref":{"folder":"(guides)/guides/whole-person-wellness","meta":"(guides)/guides/whole-person-wellness/meta.json"},"index":{"$id":"(guides)/guides/whole-person-wellness/index.mdx","type":"page","name":"Build a Whole-Person Healthspan & Coaching App with Ovok","description":"Build a React Native coaching app with Ovok authentication, structured wellness reflections, FHIR data and a human coach.","icon":"$undefined","url":"/guides/whole-person-wellness","$ref":"(guides)/guides/whole-person-wellness/index.mdx"},"icon":"$undefined"}],"$id":"(guides)","$ref":{"folder":"(guides)","meta":"(guides)/meta.json"},"icon":"$undefined"},{"type":"folder","name":"API reference","root":true,"defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/index.mdx","type":"page","name":"Overview","description":"Every public route of the Ovok API, with its parameters, responses, errors and a request you can try.","icon":"$undefined","url":"/api","$ref":"(api-reference)/api/index.mdx"},{"$id":"_50","type":"separator","icon":"$undefined","name":"Ovok API"},{"type":"folder","name":"Accounts","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/accounts/fetch-data-of-existing-accounts.mdx","type":"page","name":"$L19","description":"Lists the email addresses of every account in the caller's project. Use it to build a participant picker, for example for a video call.\n\n**Auth:** bearer token. The caller must be a Practitioner, a project admin or a super admin, or hold an access policy named \"System Owner\". Other callers get 403.\n**Scope:** the project of the token.\n\n## Behaviour\n\n- Every project membership with a Patient or Practitioner profile and a User is included. Accounts whose User has no email are left out.\n- The handler returns only the `email` of each account.\n- The list is not paginated and has no defined sort order.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/accounts' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/accounts/fetch-data-of-existing-accounts","$ref":"(api-reference)/api/(operations)/accounts/fetch-data-of-existing-accounts.mdx"}],"$id":"(api-reference)/api/(operations)/accounts","$ref":{"folder":"(api-reference)/api/(operations)/accounts","meta":"(api-reference)/api/(operations)/accounts/meta.json"},"icon":"$undefined"},{"type":"folder","name":"AI Translation","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/ai-translation/translate-text.mdx","type":"page","name":"$L1a","description":"$1b","icon":"$undefined","url":"/api/ai-translation/translate-text","$ref":"(api-reference)/api/(operations)/ai-translation/translate-text.mdx"}],"$id":"(api-reference)/api/(operations)/ai-translation","$ref":{"folder":"(api-reference)/api/(operations)/ai-translation","meta":"(api-reference)/api/(operations)/ai-translation/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Authentication","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/authentication/change-user-password.mdx","type":"page","name":"$L1c","description":"$1d","icon":"$undefined","url":"/api/authentication/change-user-password","$ref":"(api-reference)/api/(operations)/authentication/change-user-password.mdx"},{"$id":"(api-reference)/api/(operations)/authentication/refresh-access-token.mdx","type":"page","name":"$L1e","description":"$1f","icon":"$undefined","url":"/api/authentication/refresh-access-token","$ref":"(api-reference)/api/(operations)/authentication/refresh-access-token.mdx"},{"$id":"(api-reference)/api/(operations)/authentication/log-out-server-side-token-revocation.mdx","type":"page","name":"$L20","description":"$21","icon":"$undefined","url":"/api/authentication/log-out-server-side-token-revocation","$ref":"(api-reference)/api/(operations)/authentication/log-out-server-side-token-revocation.mdx"},{"$id":"(api-reference)/api/(operations)/authentication/log-out-server-side-token-revocation-2.mdx","type":"page","name":"$L22","description":"$23","icon":"$undefined","url":"/api/authentication/log-out-server-side-token-revocation-2","$ref":"(api-reference)/api/(operations)/authentication/log-out-server-side-token-revocation-2.mdx"},{"$id":"(api-reference)/api/(operations)/authentication/schedule-user-account-deletion.mdx","type":"page","name":"$L24","description":"$25","icon":"$undefined","url":"/api/authentication/schedule-user-account-deletion","$ref":"(api-reference)/api/(operations)/authentication/schedule-user-account-deletion.mdx"},{"$id":"(api-reference)/api/(operations)/authentication/login.mdx","type":"page","name":"$L26","description":"$27","icon":"$undefined","url":"/api/authentication/login","$ref":"(api-reference)/api/(operations)/authentication/login.mdx"},{"$id":"(api-reference)/api/(operations)/authentication/get-account-information.mdx","type":"page","name":"$L28","description":"Returns the signed-in user's context: project, membership, profile, user configuration, access policy and security details such as MFA status and sessions. Call it after sign-in to learn who the token belongs to.\n\n**Auth:** bearer token. A missing, non-bearer or invalid token gives 401.\n**Scope:** the project of the token.\n\n## Behaviour\n\n- The answer is Medplum's `auth/me` for the token's session.\n- The call always discards Ovok's cached copy of this session's profile and reads a fresh one, so changes to the profile or access policy show up in the response and in later requests with the same token.\n- Use the returned `profile.resourceType` to tell Patients from Practitioners.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/auth/me' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/authentication/get-account-information","$ref":"(api-reference)/api/(operations)/authentication/get-account-information.mdx"}],"$id":"(api-reference)/api/(operations)/authentication","$ref":{"folder":"(api-reference)/api/(operations)/authentication","meta":"(api-reference)/api/(operations)/authentication/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Authentication - Session Management","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/authentication---session-management/get-all-sessions.mdx","type":"page","name":"$L29","description":"Lists the caller's live sessions (one per sign-in). Use it to build a \"where you are signed in\" screen.\n\n**Auth:** bearer token.\n**Scope:** the signed-in user's own sessions.\n\n## Behaviour\n\n- A session is listed when its Login belongs to the user, has a project membership and is not revoked. Sessions that have been idle for a long time are listed as long as they are not revoked.\n- The list is ordered newest first.\n- `browser` and `os` are `null` for sessions that Medplum does not report them for.\n- The call only reads. It does not change any session.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/auth/session' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/authentication---session-management/get-all-sessions","$ref":"(api-reference)/api/(operations)/authentication---session-management/get-all-sessions.mdx"},{"$id":"(api-reference)/api/(operations)/authentication---session-management/revoke-sessions.mdx","type":"page","name":"$L2a","description":"$2b","icon":"$undefined","url":"/api/authentication---session-management/revoke-sessions","$ref":"(api-reference)/api/(operations)/authentication---session-management/revoke-sessions.mdx"}],"$id":"(api-reference)/api/(operations)/authentication---session-management","$ref":{"folder":"(api-reference)/api/(operations)/authentication---session-management","meta":"(api-reference)/api/(operations)/authentication---session-management/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Bots - Execute a custom script","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/bots---execute-a-custom-script/execute-a-bot.mdx","type":"page","name":"$L2c","description":"Runs a Medplum Bot of your project, found by its identifier, and returns its output. Use it to call custom server-side logic without knowing the Bot's id.\n\n**Auth:** bearer token. The Bot is searched and run with your token, so you need read access to the Bot and permission to execute it.\n\n## Behaviour\n\n- `identifier` uses FHIR token search syntax: `system|value`, `system|`, or just `value`. Exactly one Bot must match.\n- The JSON request body is passed to the Bot as its input, unchanged. The body is optional.\n- The response is whatever the Bot returns.\n\n## Example\n\n```bash\ncurl -X POST 'https://api.sandbox.ovok.com/bots?identifier=https://example.com|get-users' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \\\n -H 'Content-Type: application/json' \\\n -d '{ \"parameter1\": \"value1\" }'\n```\n","icon":"$undefined","url":"/api/bots---execute-a-custom-script/execute-a-bot","$ref":"(api-reference)/api/(operations)/bots---execute-a-custom-script/execute-a-bot.mdx"}],"$id":"(api-reference)/api/(operations)/bots---execute-a-custom-script","$ref":{"folder":"(api-reference)/api/(operations)/bots---execute-a-custom-script","meta":"(api-reference)/api/(operations)/bots---execute-a-custom-script/meta.json"},"icon":"$undefined"},{"type":"folder","name":"CMS (FHIR Legacy)","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/list-content-with-translations.mdx","type":"page","name":"$L2d","description":"$2e","icon":"$undefined","url":"/api/cms-(fhir-legacy)/list-content-with-translations","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/list-content-with-translations.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/list-content-with-translations-2.mdx","type":"page","name":"$L2f","description":"$30","icon":"$undefined","url":"/api/cms-(fhir-legacy)/list-content-with-translations-2","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/list-content-with-translations-2.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/copy-all-content-from-the-parent-project.mdx","type":"page","name":"$L31","description":"$32","icon":"$undefined","url":"/api/cms-(fhir-legacy)/copy-all-content-from-the-parent-project","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/copy-all-content-from-the-parent-project.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/copy-all-content-from-the-parent-project-2.mdx","type":"page","name":"$L33","description":"$34","icon":"$undefined","url":"/api/cms-(fhir-legacy)/copy-all-content-from-the-parent-project-2","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/copy-all-content-from-the-parent-project-2.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/copy-one-content-item-from-the-parent-project.mdx","type":"page","name":"$L35","description":"$36","icon":"$undefined","url":"/api/cms-(fhir-legacy)/copy-one-content-item-from-the-parent-project","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/copy-one-content-item-from-the-parent-project.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/copy-one-content-item-from-the-parent-project-2.mdx","type":"page","name":"$L37","description":"$38","icon":"$undefined","url":"/api/cms-(fhir-legacy)/copy-one-content-item-from-the-parent-project-2","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/copy-one-content-item-from-the-parent-project-2.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/list-content.mdx","type":"page","name":"$L39","description":"$3a","icon":"$undefined","url":"/api/cms-(fhir-legacy)/list-content","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/list-content.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/create-content.mdx","type":"page","name":"$L3b","description":"$3c","icon":"$undefined","url":"/api/cms-(fhir-legacy)/create-content","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/create-content.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/list-content-2.mdx","type":"page","name":"$L3d","description":"$3e","icon":"$undefined","url":"/api/cms-(fhir-legacy)/list-content-2","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/list-content-2.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/create-content-2.mdx","type":"page","name":"$L3f","description":"$40","icon":"$undefined","url":"/api/cms-(fhir-legacy)/create-content-2","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/create-content-2.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/get-content-by-key-and-language.mdx","type":"page","name":"$L41","description":"Returns one content item by type, language and key.\n\n**Auth:** bearer token.\n**Scope:** the caller's project (from the token). Only items in that project are found.\n\n## Behaviour\n\n- `type` is one of `blog`, `video`, `audio`, `template` or `export-template`.\n- `language` must be one of the languages in your project's locale settings.\n- The route is also served under `/internal/cms/{type}`.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/cms/blog/en-US/blog-sleeping-well-a1b2c3d4' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/cms-(fhir-legacy)/get-content-by-key-and-language","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/get-content-by-key-and-language.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/delete-content.mdx","type":"page","name":"$L42","description":"Deletes a content item, or all its translations when you name the default language.\n\n**Auth:** bearer token.\n**Scope:** the caller's project (from the token). Only items in that project are deleted.\n\n## Behaviour\n\n- `type` is one of `blog`, `video`, `audio`, `template` or `export-template`.\n- If `language` is the project's default language, the item is deleted in every project language. Otherwise only that language's item is deleted.\n- Deleting a key that does not exist succeeds and changes nothing.\n- The response has no body.\n- The route is also served under `/internal/cms/{type}`.\n\n## Example\n\n```bash\ncurl -X DELETE 'https://api.sandbox.ovok.com/cms/blog/en-US/blog-sleeping-well-a1b2c3d4' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/cms-(fhir-legacy)/delete-content","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/delete-content.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/update-content.mdx","type":"page","name":"$L43","description":"$44","icon":"$undefined","url":"/api/cms-(fhir-legacy)/update-content","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/update-content.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/get-content-by-key-and-language-2.mdx","type":"page","name":"$L45","description":"Returns one content item by type, language and key.\n\n**Auth:** bearer token.\n**Scope:** the caller's project (from the token). Only items in that project are found.\n\n## Behaviour\n\n- `type` is one of `blog`, `video`, `audio`, `template` or `export-template`.\n- `language` must be one of the languages in your project's locale settings.\n- The route is also served under `/internal/cms/{type}`.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/cms/blog/en-US/blog-sleeping-well-a1b2c3d4' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/cms-(fhir-legacy)/get-content-by-key-and-language-2","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/get-content-by-key-and-language-2.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/delete-content-2.mdx","type":"page","name":"$L46","description":"Deletes a content item, or all its translations when you name the default language.\n\n**Auth:** bearer token.\n**Scope:** the caller's project (from the token). Only items in that project are deleted.\n\n## Behaviour\n\n- `type` is one of `blog`, `video`, `audio`, `template` or `export-template`.\n- If `language` is the project's default language, the item is deleted in every project language. Otherwise only that language's item is deleted.\n- Deleting a key that does not exist succeeds and changes nothing.\n- The response has no body.\n- The route is also served under `/internal/cms/{type}`.\n\n## Example\n\n```bash\ncurl -X DELETE 'https://api.sandbox.ovok.com/cms/blog/en-US/blog-sleeping-well-a1b2c3d4' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/cms-(fhir-legacy)/delete-content-2","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/delete-content-2.mdx"},{"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)/update-content-2.mdx","type":"page","name":"$L47","description":"$48","icon":"$undefined","url":"/api/cms-(fhir-legacy)/update-content-2","$ref":"(api-reference)/api/(operations)/cms-(fhir-legacy)/update-content-2.mdx"}],"$id":"(api-reference)/api/(operations)/cms-(fhir-legacy)","$ref":{"folder":"(api-reference)/api/(operations)/cms-(fhir-legacy)","meta":"(api-reference)/api/(operations)/cms-(fhir-legacy)/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Consent Signature","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/consent-signature/request-consent-signature.mdx","type":"page","name":"$L49","description":"$4a","icon":"$undefined","url":"/api/consent-signature/request-consent-signature","$ref":"(api-reference)/api/(operations)/consent-signature/request-consent-signature.mdx"}],"$id":"(api-reference)/api/(operations)/consent-signature","$ref":{"folder":"(api-reference)/api/(operations)/consent-signature","meta":"(api-reference)/api/(operations)/consent-signature/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Document","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/document/search-documents.mdx","type":"page","name":"$L4b","description":"Lists the documents you can read, newest first by default. Use it to build a file list.\n\n**Auth:** bearer token. The search runs with your token, so Medplum returns only DocumentReferences you can read.\n\n## Behaviour\n\n- `_count` sets the page size (default `100`), `_offset` the number of documents to skip (default `0`), and `_sort` the order (default `-_lastUpdated`).\n- `total` is an estimate from Medplum, not an exact count. Use it for a page counter, not for logic that needs the exact number.\n- Each entry has `id`, `meta.lastUpdated`, `author`, `fileName`, `contentType`, and `publicToken` when the document is public. Entries never include `uploadOptions`.\n\n## Example\n\n```bash\ncurl -G 'https://api.sandbox.ovok.com/document' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \\\n -d '_count=20' \\\n -d '_offset=0'\n```\n","icon":"$undefined","url":"/api/document/search-documents","$ref":"(api-reference)/api/(operations)/document/search-documents.mdx"},{"$id":"(api-reference)/api/(operations)/document/create-document-upload-credentials.mdx","type":"page","name":"$L4c","description":"$4d","icon":"$undefined","url":"/api/document/create-document-upload-credentials","$ref":"(api-reference)/api/(operations)/document/create-document-upload-credentials.mdx"},{"$id":"(api-reference)/api/(operations)/document/download-a-public-document.mdx","type":"page","name":"$L4e","description":"Downloads the file of a public document, without a bearer token. Use it to embed a file in a web page or an email, for example in an `` tag.\n\n**Auth:** none. The public token in the path is the credential: anyone with the URL can get the file.\n\n## Behaviour\n\n- The token is the document's `publicToken`. A document gets one when it is created or updated with `isPublic` set to true.\n- The response is `307 Temporary Redirect` to a signed file URL, as in `GET /document/{id}`, including the same resizing options (`width`, `height`, `fit`).\n- A token stops working when the document is made private again, or when its public token is replaced.\n\n## Example\n\n```bash\ncurl -L 'https://api.sandbox.ovok.com/document/public/example.jwt.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' -o file.png\n```\n","icon":"$undefined","url":"/api/document/download-a-public-document","$ref":"(api-reference)/api/(operations)/document/download-a-public-document.mdx"},{"$id":"(api-reference)/api/(operations)/document/download-a-document.mdx","type":"page","name":"$L4f","description":"$50","icon":"$undefined","url":"/api/document/download-a-document","$ref":"(api-reference)/api/(operations)/document/download-a-document.mdx"},{"$id":"(api-reference)/api/(operations)/document/create-document-replacement-credentials.mdx","type":"page","name":"$L51","description":"$52","icon":"$undefined","url":"/api/document/create-document-replacement-credentials","$ref":"(api-reference)/api/(operations)/document/create-document-replacement-credentials.mdx"},{"$id":"(api-reference)/api/(operations)/document/update-document-metadata.mdx","type":"page","name":"$L53","description":"$54","icon":"$undefined","url":"/api/document/update-document-metadata","$ref":"(api-reference)/api/(operations)/document/update-document-metadata.mdx"},{"$id":"(api-reference)/api/(operations)/document/delete-a-document.mdx","type":"page","name":"$L55","description":"Deletes a document and its stored file. This cannot be undone.\n\n**Auth:** bearer token. The document is read and deleted with your token, so you need read and delete access to the DocumentReference.\n\n## Behaviour\n\n- The stored file is deleted first, then the DocumentReference.\n- If deleting the stored file fails, the DocumentReference is still deleted.\n- Public links to the document stop working.\n\n## Example\n\n```bash\ncurl -X DELETE 'https://api.sandbox.ovok.com/document/c3499c27-2973-0a7f-807e-fb8676a92dcb' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n\n```json\n{ \"message\": \"Document deleted successfully\" }\n```\n","icon":"$undefined","url":"/api/document/delete-a-document","$ref":"(api-reference)/api/(operations)/document/delete-a-document.mdx"}],"$id":"(api-reference)/api/(operations)/document","$ref":{"folder":"(api-reference)/api/(operations)/document","meta":"(api-reference)/api/(operations)/document/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Email","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/email/get-example-email-template-params.mdx","type":"page","name":"$L56","description":"Returns one example set of params for every email template, keyed by template name. Use it to preview what a template receives. For the types, nullability and audience of each param, use `GET /v1/email/templates` instead.\n\n**Auth:** bearer token. Any signed-in user can call it. The response is the same for every project.\n\n## Behaviour\n\n- The response is an object with one key per template name. Each value is an example of the params that template receives when it is sent.\n- The values are fixed sample data, not data from your project.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/email/templates' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/email/get-example-email-template-params","$ref":"(api-reference)/api/(operations)/email/get-example-email-template-params.mdx"},{"$id":"(api-reference)/api/(operations)/email/list-email-templates-and-their-params.mdx","type":"page","name":"$L57","description":"$58","icon":"$undefined","url":"/api/email/list-email-templates-and-their-params","$ref":"(api-reference)/api/(operations)/email/list-email-templates-and-their-params.mdx"},{"$id":"(api-reference)/api/(operations)/email/list-the-project-s-email-template-mappings.mdx","type":"page","name":"$L59","description":"$5a","icon":"$undefined","url":"/api/email/list-the-project-s-email-template-mappings","$ref":"(api-reference)/api/(operations)/email/list-the-project-s-email-template-mappings.mdx"},{"$id":"(api-reference)/api/(operations)/email/get-an-email-template-mapping.mdx","type":"page","name":"$L5b","description":"$5c","icon":"$undefined","url":"/api/email/get-an-email-template-mapping","$ref":"(api-reference)/api/(operations)/email/get-an-email-template-mapping.mdx"},{"$id":"(api-reference)/api/(operations)/email/remove-an-email-template-mapping.mdx","type":"page","name":"$L5d","description":"$5e","icon":"$undefined","url":"/api/email/remove-an-email-template-mapping","$ref":"(api-reference)/api/(operations)/email/remove-an-email-template-mapping.mdx"},{"$id":"(api-reference)/api/(operations)/email/map-an-email-template.mdx","type":"page","name":"$L5f","description":"$60","icon":"$undefined","url":"/api/email/map-an-email-template","$ref":"(api-reference)/api/(operations)/email/map-an-email-template.mdx"},{"$id":"(api-reference)/api/(operations)/email/get-the-project-s-email-providers.mdx","type":"page","name":"$L61","description":"$62","icon":"$undefined","url":"/api/email/get-the-project-s-email-providers","$ref":"(api-reference)/api/(operations)/email/get-the-project-s-email-providers.mdx"},{"$id":"(api-reference)/api/(operations)/email/set-up-an-email-provider.mdx","type":"page","name":"$L63","description":"$64","icon":"$undefined","url":"/api/email/set-up-an-email-provider","$ref":"(api-reference)/api/(operations)/email/set-up-an-email-provider.mdx"},{"$id":"(api-reference)/api/(operations)/email/change-an-email-provider.mdx","type":"page","name":"$L65","description":"$66","icon":"$undefined","url":"/api/email/change-an-email-provider","$ref":"(api-reference)/api/(operations)/email/change-an-email-provider.mdx"}],"$id":"(api-reference)/api/(operations)/email","$ref":{"folder":"(api-reference)/api/(operations)/email","meta":"(api-reference)/api/(operations)/email/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Healthcheck","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/healthcheck/get-application-health.mdx","type":"page","name":"$L67","description":"$68","icon":"$undefined","url":"/api/healthcheck/get-application-health","$ref":"(api-reference)/api/(operations)/healthcheck/get-application-health.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/get-application-health-2.mdx","type":"page","name":"$L69","description":"$6a","icon":"$undefined","url":"/api/healthcheck/get-application-health-2","$ref":"(api-reference)/api/(operations)/healthcheck/get-application-health-2.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/get-application-health-3.mdx","type":"page","name":"$L6b","description":"$6c","icon":"$undefined","url":"/api/healthcheck/get-application-health-3","$ref":"(api-reference)/api/(operations)/healthcheck/get-application-health-3.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/get-application-readiness.mdx","type":"page","name":"$L6d","description":"Returns the same body as the liveness healthcheck, but with the verdict in the HTTP status. Use it for monitors and alerts that page on status code.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Runs the same bounded Redis and FHIR store probes as `GET /healthcheck`.\n- Answers `200` when `ok` is `true` and `503` when it is `false`. The `503` body is the same healthcheck result, so `dependencies` still names the failing dependency.\n- Do not use this route for container liveness probes: a failing dependency would make the orchestrator restart a backend that is merely degraded.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/ready'\n```\n","icon":"$undefined","url":"/api/healthcheck/get-application-readiness","$ref":"(api-reference)/api/(operations)/healthcheck/get-application-readiness.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/get-application-readiness-2.mdx","type":"page","name":"$L6e","description":"Returns the same body as the liveness healthcheck, but with the verdict in the HTTP status. Use it for monitors and alerts that page on status code.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Runs the same bounded Redis and FHIR store probes as `GET /healthcheck`.\n- Answers `200` when `ok` is `true` and `503` when it is `false`. The `503` body is the same healthcheck result, so `dependencies` still names the failing dependency.\n- Do not use this route for container liveness probes: a failing dependency would make the orchestrator restart a backend that is merely degraded.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/ready'\n```\n","icon":"$undefined","url":"/api/healthcheck/get-application-readiness-2","$ref":"(api-reference)/api/(operations)/healthcheck/get-application-readiness-2.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/get-application-readiness-3.mdx","type":"page","name":"$L6f","description":"Returns the same body as the liveness healthcheck, but with the verdict in the HTTP status. Use it for monitors and alerts that page on status code.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Runs the same bounded Redis and FHIR store probes as `GET /healthcheck`.\n- Answers `200` when `ok` is `true` and `503` when it is `false`. The `503` body is the same healthcheck result, so `dependencies` still names the failing dependency.\n- Do not use this route for container liveness probes: a failing dependency would make the orchestrator restart a backend that is merely degraded.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/ready'\n```\n","icon":"$undefined","url":"/api/healthcheck/get-application-readiness-3","$ref":"(api-reference)/api/(operations)/healthcheck/get-application-readiness-3.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/check-redis-health.mdx","type":"page","name":"$L70","description":"Checks whether the backend can reach Redis.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Sends a `PING` to Redis. `ok` is `true` only when Redis answers `PONG`, and `false` on any error.\n- The status is `200` in both cases.\n- Unlike `GET /healthcheck`, this probe has no time limit of its own.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/redis'\n```\n\n```json\n{ \"ok\": true }\n```\n","icon":"$undefined","url":"/api/healthcheck/check-redis-health","$ref":"(api-reference)/api/(operations)/healthcheck/check-redis-health.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/check-redis-health-2.mdx","type":"page","name":"$L71","description":"Checks whether the backend can reach Redis.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Sends a `PING` to Redis. `ok` is `true` only when Redis answers `PONG`, and `false` on any error.\n- The status is `200` in both cases.\n- Unlike `GET /healthcheck`, this probe has no time limit of its own.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/redis'\n```\n\n```json\n{ \"ok\": true }\n```\n","icon":"$undefined","url":"/api/healthcheck/check-redis-health-2","$ref":"(api-reference)/api/(operations)/healthcheck/check-redis-health-2.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/check-redis-health-3.mdx","type":"page","name":"$L72","description":"Checks whether the backend can reach Redis.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Sends a `PING` to Redis. `ok` is `true` only when Redis answers `PONG`, and `false` on any error.\n- The status is `200` in both cases.\n- Unlike `GET /healthcheck`, this probe has no time limit of its own.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/redis'\n```\n\n```json\n{ \"ok\": true }\n```\n","icon":"$undefined","url":"/api/healthcheck/check-redis-health-3","$ref":"(api-reference)/api/(operations)/healthcheck/check-redis-health-3.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/check-email-service-health.mdx","type":"page","name":"$L73","description":"Reports the email service status.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Contacts nothing. It always answers `{ \"ok\": true, \"skipped\": true }`, so the result says nothing about whether email delivery works.\n- `GET /healthcheck` does not include email for the same reason.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/email'\n```\n","icon":"$undefined","url":"/api/healthcheck/check-email-service-health","$ref":"(api-reference)/api/(operations)/healthcheck/check-email-service-health.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/check-email-service-health-2.mdx","type":"page","name":"$L74","description":"Reports the email service status.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Contacts nothing. It always answers `{ \"ok\": true, \"skipped\": true }`, so the result says nothing about whether email delivery works.\n- `GET /healthcheck` does not include email for the same reason.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/email'\n```\n","icon":"$undefined","url":"/api/healthcheck/check-email-service-health-2","$ref":"(api-reference)/api/(operations)/healthcheck/check-email-service-health-2.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/check-email-service-health-3.mdx","type":"page","name":"$L75","description":"Reports the email service status.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Contacts nothing. It always answers `{ \"ok\": true, \"skipped\": true }`, so the result says nothing about whether email delivery works.\n- `GET /healthcheck` does not include email for the same reason.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/email'\n```\n","icon":"$undefined","url":"/api/healthcheck/check-email-service-health-3","$ref":"(api-reference)/api/(operations)/healthcheck/check-email-service-health-3.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/check-fhir-store-health.mdx","type":"page","name":"$L76","description":"Checks whether the backend can reach the FHIR store and returns the FHIR store's own health report. Its old paths, `GET /healthcheck/fhir-store` and `GET /healthcheck/medplum`, answer `301` with `Location: /healthcheck/fhir`.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Calls the FHIR store's `healthcheck` endpoint and returns `ok`, `version`, `platform`, `runtime`, `postgres` and `redis` from its answer.\n- When the call fails, the route still answers `200`, with `ok`, `postgres` and `redis` set to `false` and `version`, `platform` and `runtime` set to empty strings.\n- Unlike `GET /healthcheck`, this probe has no time limit of its own.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/fhir'\n```\n","icon":"$undefined","url":"/api/healthcheck/check-fhir-store-health","$ref":"(api-reference)/api/(operations)/healthcheck/check-fhir-store-health.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/check-cms-health.mdx","type":"page","name":"$L77","description":"Checks whether the backend can reach the CMS.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Calls the CMS's own health endpoint, `GET /api/_ovok/health`. `ok` is `true` only when it answers `200` with `status: \"ok\"`, which it does once it has read its database.\n- `ok` is `false` when the CMS answers anything else, cannot be reached, takes longer than 2 seconds, or no CMS URL is configured.\n- The status is `200` in every case.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/cms'\n```\n\n```json\n{ \"ok\": true }\n```\n","icon":"$undefined","url":"/api/healthcheck/check-cms-health","$ref":"(api-reference)/api/(operations)/healthcheck/check-cms-health.mdx"},{"$id":"(api-reference)/api/(operations)/healthcheck/check-signals-health.mdx","type":"page","name":"$L78","description":"Checks whether the backend can reach Signals.\n\n**Auth:** none. The route needs no bearer token.\n\n## Behaviour\n\n- Calls Signals' own `GET /health`. `ok` is `true` only when Signals answers with `ok: true`, which it does while its database answers.\n- `ok` is `false` when Signals reports `ok: false`, cannot be reached, takes longer than 2 seconds, or no Signals URL is configured.\n- The status is `200` in every case.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/healthcheck/signals'\n```\n\n```json\n{ \"ok\": true }\n```\n","icon":"$undefined","url":"/api/healthcheck/check-signals-health","$ref":"(api-reference)/api/(operations)/healthcheck/check-signals-health.mdx"}],"$id":"(api-reference)/api/(operations)/healthcheck","$ref":{"folder":"(api-reference)/api/(operations)/healthcheck","meta":"(api-reference)/api/(operations)/healthcheck/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Invites","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/invites/share-my-record.mdx","type":"page","name":"$L79","description":"$7a","icon":"$undefined","url":"/api/invites/share-my-record","$ref":"(api-reference)/api/(operations)/invites/share-my-record.mdx"},{"$id":"(api-reference)/api/(operations)/invites/accept-a-patient-s-record-share.mdx","type":"page","name":"$L7b","description":"$7c","icon":"$undefined","url":"/api/invites/accept-a-patient-s-record-share","$ref":"(api-reference)/api/(operations)/invites/accept-a-patient-s-record-share.mdx"},{"$id":"(api-reference)/api/(operations)/invites/invite-a-patient-into-my-care.mdx","type":"page","name":"$L7d","description":"$7e","icon":"$undefined","url":"/api/invites/invite-a-patient-into-my-care","$ref":"(api-reference)/api/(operations)/invites/invite-a-patient-into-my-care.mdx"},{"$id":"(api-reference)/api/(operations)/invites/accept-a-practitioner-s-care-invite.mdx","type":"page","name":"$L7f","description":"$80","icon":"$undefined","url":"/api/invites/accept-a-practitioner-s-care-invite","$ref":"(api-reference)/api/(operations)/invites/accept-a-practitioner-s-care-invite.mdx"}],"$id":"(api-reference)/api/(operations)/invites","$ref":{"folder":"(api-reference)/api/(operations)/invites","meta":"(api-reference)/api/(operations)/invites/meta.json"},"icon":"$undefined"},{"type":"folder","name":"IotDevice","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/iotdevice/get-pulsene-mqtt-settings.mdx","type":"page","name":"$L81","description":"$82","icon":"$undefined","url":"/api/iotdevice/get-pulsene-mqtt-settings","$ref":"(api-reference)/api/(operations)/iotdevice/get-pulsene-mqtt-settings.mdx"}],"$id":"(api-reference)/api/(operations)/iotdevice","$ref":{"folder":"(api-reference)/api/(operations)/iotdevice","meta":"(api-reference)/api/(operations)/iotdevice/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Localization","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/localization/get-project-locales.mdx","type":"page","name":"$L83","description":"Returns the languages enabled for your project and its default language.\n\n**Auth:** bearer token. You need `List:read` and `List:search` access, or be a project admin.\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- The locale settings are stored as a FHIR `List` in your project.\n- If the project has no locale settings yet, the route returns 404. Create them with `PATCH /locales`.\n- Localization and content routes accept only the languages returned here.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/locales' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/localization/get-project-locales","$ref":"(api-reference)/api/(operations)/localization/get-project-locales.mdx"},{"$id":"(api-reference)/api/(operations)/localization/set-project-locales.mdx","type":"page","name":"$L84","description":"$85","icon":"$undefined","url":"/api/localization/set-project-locales","$ref":"(api-reference)/api/(operations)/localization/set-project-locales.mdx"}],"$id":"(api-reference)/api/(operations)/localization","$ref":{"folder":"(api-reference)/api/(operations)/localization","meta":"(api-reference)/api/(operations)/localization/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Localization Keys","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/localization-keys/get-i18next-resources-for-a-language.mdx","type":"page","name":"$L86","description":"$87","icon":"$undefined","url":"/api/localization-keys/get-i18next-resources-for-a-language","$ref":"(api-reference)/api/(operations)/localization-keys/get-i18next-resources-for-a-language.mdx"},{"$id":"(api-reference)/api/(operations)/localization-keys/write-i18next-resources-for-a-language.mdx","type":"page","name":"$L88","description":"$89","icon":"$undefined","url":"/api/localization-keys/write-i18next-resources-for-a-language","$ref":"(api-reference)/api/(operations)/localization-keys/write-i18next-resources-for-a-language.mdx"},{"$id":"(api-reference)/api/(operations)/localization-keys/list-localizations-with-translations.mdx","type":"page","name":"$L8a","description":"$8b","icon":"$undefined","url":"/api/localization-keys/list-localizations-with-translations","$ref":"(api-reference)/api/(operations)/localization-keys/list-localizations-with-translations.mdx"},{"$id":"(api-reference)/api/(operations)/localization-keys/list-localizations-for-a-language.mdx","type":"page","name":"$L8c","description":"$8d","icon":"$undefined","url":"/api/localization-keys/list-localizations-for-a-language","$ref":"(api-reference)/api/(operations)/localization-keys/list-localizations-for-a-language.mdx"},{"$id":"(api-reference)/api/(operations)/localization-keys/get-a-localization.mdx","type":"page","name":"$L8e","description":"Returns the localization for one key in one language.\n\n**Auth:** bearer token.\n**Scope:** the caller's project (from the token). Localizations are read and written with your token.\n\n## Behaviour\n\n- `language` must be one of the languages in your project's locale settings (`GET /locales`).\n- `key` is a dot-separated path such as `home.screen.title`. It may contain letters, digits, `_`, `-` and `.`, and must not start with `.`.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/localization/en-US/home.screen.title' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/localization-keys/get-a-localization","$ref":"(api-reference)/api/(operations)/localization-keys/get-a-localization.mdx"},{"$id":"(api-reference)/api/(operations)/localization-keys/delete-a-localization.mdx","type":"page","name":"$L8f","description":"Deletes one key in one language, or in every language when you name the default language.\n\n**Auth:** bearer token.\n**Scope:** the caller's project (from the token). Localizations are read and written with your token.\n\n## Behaviour\n\n- `language` must be one of the languages in your project's locale settings (`GET /locales`).\n- If `language` is the project's default language, the key is deleted in every project language. Otherwise only that language's entry is deleted.\n- Deleting a key that does not exist succeeds and changes nothing.\n- The response has no body.\n\n## Example\n\n```bash\ncurl -X DELETE 'https://api.sandbox.ovok.com/localization/en-US/home.screen.title' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/localization-keys/delete-a-localization","$ref":"(api-reference)/api/(operations)/localization-keys/delete-a-localization.mdx"},{"$id":"(api-reference)/api/(operations)/localization-keys/create-or-update-a-localization.mdx","type":"page","name":"$L90","description":"$91","icon":"$undefined","url":"/api/localization-keys/create-or-update-a-localization","$ref":"(api-reference)/api/(operations)/localization-keys/create-or-update-a-localization.mdx"}],"$id":"(api-reference)/api/(operations)/localization-keys","$ref":{"folder":"(api-reference)/api/(operations)/localization-keys","meta":"(api-reference)/api/(operations)/localization-keys/meta.json"},"icon":"$undefined"},{"type":"folder","name":"MCP","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/mcp/mcp-endpoint-post-only.mdx","type":"page","name":"$L92","description":"This MCP server is stateless: use POST.","icon":"$undefined","url":"/api/mcp/mcp-endpoint-post-only","$ref":"(api-reference)/api/(operations)/mcp/mcp-endpoint-post-only.mdx"},{"$id":"(api-reference)/api/(operations)/mcp/mcp-endpoint.mdx","type":"page","name":"$L93","description":"$94","icon":"$undefined","url":"/api/mcp/mcp-endpoint","$ref":"(api-reference)/api/(operations)/mcp/mcp-endpoint.mdx"},{"$id":"(api-reference)/api/(operations)/mcp/mcp-endpoint-post-only-2.mdx","type":"page","name":"$L95","description":"This MCP server is stateless: use POST.","icon":"$undefined","url":"/api/mcp/mcp-endpoint-post-only-2","$ref":"(api-reference)/api/(operations)/mcp/mcp-endpoint-post-only-2.mdx"}],"$id":"(api-reference)/api/(operations)/mcp","$ref":{"folder":"(api-reference)/api/(operations)/mcp","meta":"(api-reference)/api/(operations)/mcp/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Me","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Me/Consent","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/me/consent/get-legal-consent.mdx","type":"page","name":"$L96","description":"$97","icon":"$undefined","url":"/api/me/consent/get-legal-consent","$ref":"(api-reference)/api/(operations)/me/consent/get-legal-consent.mdx"},{"$id":"(api-reference)/api/(operations)/me/consent/accept-or-withdraw-the-terms.mdx","type":"page","name":"$L98","description":"$99","icon":"$undefined","url":"/api/me/consent/accept-or-withdraw-the-terms","$ref":"(api-reference)/api/(operations)/me/consent/accept-or-withdraw-the-terms.mdx"},{"$id":"(api-reference)/api/(operations)/me/consent/get-medical-consent.mdx","type":"page","name":"$L9a","description":"$9b","icon":"$undefined","url":"/api/me/consent/get-medical-consent","$ref":"(api-reference)/api/(operations)/me/consent/get-medical-consent.mdx"},{"$id":"(api-reference)/api/(operations)/me/consent/give-or-withdraw-the-medical-consent.mdx","type":"page","name":"$L9c","description":"$9d","icon":"$undefined","url":"/api/me/consent/give-or-withdraw-the-medical-consent","$ref":"(api-reference)/api/(operations)/me/consent/give-or-withdraw-the-medical-consent.mdx"}],"$id":"(api-reference)/api/(operations)/me/consent","$ref":{"folder":"(api-reference)/api/(operations)/me/consent","meta":"(api-reference)/api/(operations)/me/consent/meta.json"},"icon":"$undefined"}],"$id":"(api-reference)/api/(operations)/me","$ref":{"folder":"(api-reference)/api/(operations)/me","meta":"$undefined"},"icon":"$undefined"},{"type":"folder","name":"Organization Code Information","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/organization-code-information/email-organization-codes.mdx","type":"page","name":"$L9e","description":"Emails a user the tenant codes of every organization (project) they have an account in. Use it on a sign-in screen for users who forgot their organization code.\n\n**Auth:** none.\n\n## Behaviour\n\n- The route always answers 202 with no body and does the work in the background, so the answer does not tell you whether the email has an account.\n- The background job finds every account with this email, then looks up the tenant code of each project. If there are no accounts or no codes, no email is sent.\n- The email lists each project's name and code. It uses the `PATIENT_ORGANIZATION_CODES` template when the first account found is a Patient, and `OVOK_ORGANIZATION_CODES` otherwise. Language and domain come from the request.\n- The email address is lowercased.\n\n## Example\n\n```bash\ncurl -X POST 'https://api.sandbox.ovok.com/organizations/code/email' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"email\": \"max.mustermann@example.com\"\n }'\n```\n","icon":"$undefined","url":"/api/organization-code-information/email-organization-codes","$ref":"(api-reference)/api/(operations)/organization-code-information/email-organization-codes.mdx"},{"$id":"(api-reference)/api/(operations)/organization-code-information/get-organization-code.mdx","type":"page","name":"$L9f","description":"Returns the tenant code of the caller's project. Users type the code on sign-in screens to choose their organization.\n\n**Auth:** bearer token.\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- The response holds `code` and `projectId`.\n- If the project has no tenant code, the request fails with 400 (`Tenant code not found`).\n- If more than one code row exists for a project, the most recently updated one is returned.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/organizations/code' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/organization-code-information/get-organization-code","$ref":"(api-reference)/api/(operations)/organization-code-information/get-organization-code.mdx"}],"$id":"(api-reference)/api/(operations)/organization-code-information","$ref":{"folder":"(api-reference)/api/(operations)/organization-code-information","meta":"(api-reference)/api/(operations)/organization-code-information/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Patient sharing","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/patient-sharing/get-patient-sharing-settings.mdx","type":"page","name":"$La0","description":"$a1","icon":"$undefined","url":"/api/patient-sharing/get-patient-sharing-settings","$ref":"(api-reference)/api/(operations)/patient-sharing/get-patient-sharing-settings.mdx"},{"$id":"(api-reference)/api/(operations)/patient-sharing/update-patient-sharing-settings.mdx","type":"page","name":"$La2","description":"$a3","icon":"$undefined","url":"/api/patient-sharing/update-patient-sharing-settings","$ref":"(api-reference)/api/(operations)/patient-sharing/update-patient-sharing-settings.mdx"},{"$id":"(api-reference)/api/(operations)/patient-sharing/create-a-share-invite.mdx","type":"page","name":"$La4","description":"$a5","icon":"$undefined","url":"/api/patient-sharing/create-a-share-invite","$ref":"(api-reference)/api/(operations)/patient-sharing/create-a-share-invite.mdx"},{"$id":"(api-reference)/api/(operations)/patient-sharing/accept-a-share-invite.mdx","type":"page","name":"$La6","description":"$a7","icon":"$undefined","url":"/api/patient-sharing/accept-a-share-invite","$ref":"(api-reference)/api/(operations)/patient-sharing/accept-a-share-invite.mdx"},{"$id":"(api-reference)/api/(operations)/patient-sharing/list-shares.mdx","type":"page","name":"$La8","description":"$a9","icon":"$undefined","url":"/api/patient-sharing/list-shares","$ref":"(api-reference)/api/(operations)/patient-sharing/list-shares.mdx"},{"$id":"(api-reference)/api/(operations)/patient-sharing/end-a-share.mdx","type":"page","name":"$Laa","description":"$ab","icon":"$undefined","url":"/api/patient-sharing/end-a-share","$ref":"(api-reference)/api/(operations)/patient-sharing/end-a-share.mdx"}],"$id":"(api-reference)/api/(operations)/patient-sharing","$ref":{"folder":"(api-reference)/api/(operations)/patient-sharing","meta":"(api-reference)/api/(operations)/patient-sharing/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Payload CMS API Keys","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/payload-cms-api-keys/list-the-project-s-cms-api-keys.mdx","type":"page","name":"$Lac","description":"$ad","icon":"$undefined","url":"/api/payload-cms-api-keys/list-the-project-s-cms-api-keys","$ref":"(api-reference)/api/(operations)/payload-cms-api-keys/list-the-project-s-cms-api-keys.mdx"},{"$id":"(api-reference)/api/(operations)/payload-cms-api-keys/create-a-cms-api-key.mdx","type":"page","name":"$Lae","description":"$af","icon":"$undefined","url":"/api/payload-cms-api-keys/create-a-cms-api-key","$ref":"(api-reference)/api/(operations)/payload-cms-api-keys/create-a-cms-api-key.mdx"},{"$id":"(api-reference)/api/(operations)/payload-cms-api-keys/revoke-a-cms-api-key.mdx","type":"page","name":"$Lb0","description":"Revokes one of your current project's CMS API keys. Public delivery stops taking it at once.\n\n**Auth:** bearer token of a project admin. The caller must also be a Practitioner, an admin or hold the System Owner access policy.\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- `id` is a key's `id` from `GET /v1/cms/api-keys`; `default` revokes the default key.\n- A key the project does not hold returns 404 `CMS_API_KEY_NOT_FOUND`.\n- A 409 means the project changed while the server wrote. Retry.\n- Public responses a CDN already cached may still be served for up to a minute.\n- The answer is 204.\n\n## Example\n\n```bash\ncurl -X DELETE 'https://api.sandbox.ovok.com/v1/cms/api-keys/default' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/payload-cms-api-keys/revoke-a-cms-api-key","$ref":"(api-reference)/api/(operations)/payload-cms-api-keys/revoke-a-cms-api-key.mdx"}],"$id":"(api-reference)/api/(operations)/payload-cms-api-keys","$ref":{"folder":"(api-reference)/api/(operations)/payload-cms-api-keys","meta":"(api-reference)/api/(operations)/payload-cms-api-keys/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Payload CMS Public Delivery","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/payload-cms-public-delivery/list-published-documents-of-a-public-collection.mdx","type":"page","name":"$Lb1","description":"$b2","icon":"$undefined","url":"/api/payload-cms-public-delivery/list-published-documents-of-a-public-collection","$ref":"(api-reference)/api/(operations)/payload-cms-public-delivery/list-published-documents-of-a-public-collection.mdx"},{"$id":"(api-reference)/api/(operations)/payload-cms-public-delivery/get-a-published-document-by-slug.mdx","type":"page","name":"$Lb3","description":"$b4","icon":"$undefined","url":"/api/payload-cms-public-delivery/get-a-published-document-by-slug","$ref":"(api-reference)/api/(operations)/payload-cms-public-delivery/get-a-published-document-by-slug.mdx"},{"$id":"(api-reference)/api/(operations)/payload-cms-public-delivery/list-published-items-of-a-content-type.mdx","type":"page","name":"$Lb5","description":"$b6","icon":"$undefined","url":"/api/payload-cms-public-delivery/list-published-items-of-a-content-type","$ref":"(api-reference)/api/(operations)/payload-cms-public-delivery/list-published-items-of-a-content-type.mdx"}],"$id":"(api-reference)/api/(operations)/payload-cms-public-delivery","$ref":{"folder":"(api-reference)/api/(operations)/payload-cms-public-delivery","meta":"(api-reference)/api/(operations)/payload-cms-public-delivery/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Projects","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/projects/get-current-project-settings.mdx","type":"page","name":"$Lb7","description":"$b8","icon":"$undefined","url":"/api/projects/get-current-project-settings","$ref":"(api-reference)/api/(operations)/projects/get-current-project-settings.mdx"},{"$id":"(api-reference)/api/(operations)/projects/update-a-project-setting.mdx","type":"page","name":"$Lb9","description":"$ba","icon":"$undefined","url":"/api/projects/update-a-project-setting","$ref":"(api-reference)/api/(operations)/projects/update-a-project-setting.mdx"},{"$id":"(api-reference)/api/(operations)/projects/update-a-project-text-setting.mdx","type":"page","name":"$Lbb","description":"$bc","icon":"$undefined","url":"/api/projects/update-a-project-text-setting","$ref":"(api-reference)/api/(operations)/projects/update-a-project-text-setting.mdx"},{"$id":"(api-reference)/api/(operations)/projects/list-administered-projects.mdx","type":"page","name":"$Lbd","description":"$be","icon":"$undefined","url":"/api/projects/list-administered-projects","$ref":"(api-reference)/api/(operations)/projects/list-administered-projects.mdx"},{"$id":"(api-reference)/api/(operations)/projects/list-current-project-members.mdx","type":"page","name":"$Lbf","description":"Lists the Practitioner members of your current project, one page at a time.\n\n**Auth:** bearer token. The caller must be a Practitioner, a project admin, or hold the System Owner access policy.\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- Only memberships with a Practitioner profile are returned; patient, bot and client memberships are left out.\n- Filters: `accessPolicyId` (the membership's access policy), `profileId` (a Practitioner id) and `userId`.\n- `page` (from 0, default 0) and `count` (1 to 100, default 20) page the results. `total` is the exact number of matches.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/projects/me/members?page=0&count=20' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/projects/list-current-project-members","$ref":"(api-reference)/api/(operations)/projects/list-current-project-members.mdx"},{"$id":"(api-reference)/api/(operations)/projects/invite-a-practitioner-to-the-project.mdx","type":"page","name":"$Lc0","description":"$c1","icon":"$undefined","url":"/api/projects/invite-a-practitioner-to-the-project","$ref":"(api-reference)/api/(operations)/projects/invite-a-practitioner-to-the-project.mdx"},{"$id":"(api-reference)/api/(operations)/projects/get-a-project-member.mdx","type":"page","name":"$Lc2","description":"Reads one Practitioner member of your current project.\n\n**Auth:** bearer token of a project admin (`ProjectMembership.admin`).\n**Scope:** the caller's project (from the token). A membership of another project answers 404.\n\n## Behaviour\n\n- `emailVerified` is `true` once the member has used an emailed set-password link, and `null` when the User cannot be read.\n- `pending` is always `false` on this route.\n- The route requires a Practitioner membership; any other membership type is refused with 400.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/projects/me/members/c3499c27-2973-0a7f-807e-fb8676a92dcb' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/projects/get-a-project-member","$ref":"(api-reference)/api/(operations)/projects/get-a-project-member.mdx"},{"$id":"(api-reference)/api/(operations)/projects/update-a-project-member.mdx","type":"page","name":"$Lc3","description":"$c4","icon":"$undefined","url":"/api/projects/update-a-project-member","$ref":"(api-reference)/api/(operations)/projects/update-a-project-member.mdx"},{"$id":"(api-reference)/api/(operations)/projects/remove-a-project-member.mdx","type":"page","name":"$Lc5","description":"Removes a Practitioner from your current project.\n\n**Auth:** bearer token of a project admin (`ProjectMembership.admin`).\n**Scope:** the caller's project (from the token). A membership of another project answers 404.\n\n## Behaviour\n\n- Deletes the membership and its Practitioner profile. The User is deleted only when it has no other membership in any project.\n- All or nothing: if one delete fails, the others are undone and the request fails.\n- Removing the last admin of the project is refused.\n- The response is `{ \"success\": true }`.\n\n## Example\n\n```bash\ncurl -X DELETE 'https://api.sandbox.ovok.com/v1/projects/me/members/c3499c27-2973-0a7f-807e-fb8676a92dcb' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/projects/remove-a-project-member","$ref":"(api-reference)/api/(operations)/projects/remove-a-project-member.mdx"},{"$id":"(api-reference)/api/(operations)/projects/get-current-project-features.mdx","type":"page","name":"$Lc6","description":"Returns the Medplum features (`Project.features`) enabled on your current project, such as `bots` or `cron`.\n\n**Auth:** bearer token. The caller must be a Practitioner, a project admin, or hold the System Owner access policy.\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- Values are returned as stored, without checking them against the list `PATCH` accepts. An empty array means no features are enabled.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/projects/me/features' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/projects/get-current-project-features","$ref":"(api-reference)/api/(operations)/projects/get-current-project-features.mdx"},{"$id":"(api-reference)/api/(operations)/projects/update-current-project-features.mdx","type":"page","name":"$Lc7","description":"Replaces the Medplum features (`Project.features`) of your current project with the list you send.\n\n**Auth:** bearer token of a project admin. The caller must also be a Practitioner, an admin or hold the System Owner access policy.\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- The list replaces the stored one; it is not merged. Send every feature you want enabled. Sending the same list twice has the same result.\n- Each value must be one of the FHIR `Project.features` codes.\n- The write only succeeds if the project did not change since the server read it; otherwise it answers 409.\n\n## Example\n\n```bash\ncurl -X PATCH 'https://api.sandbox.ovok.com/v1/projects/me/features' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \\\n -H 'Content-Type: application/json' \\\n -d '{ \"features\": [\"bots\", \"cron\", \"websocket-subscriptions\"] }'\n```\n","icon":"$undefined","url":"/api/projects/update-current-project-features","$ref":"(api-reference)/api/(operations)/projects/update-current-project-features.mdx"}],"$id":"(api-reference)/api/(operations)/projects","$ref":{"folder":"(api-reference)/api/(operations)/projects","meta":"(api-reference)/api/(operations)/projects/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Public Resource Access","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/public-resource-access/get-a-public-resource.mdx","type":"page","name":"$Lc8","description":"Reads a FHIR resource through its public token, without a bearer token. Use it to share one resource, such as a form or a document, with people who have no Ovok account.\n\n**Auth:** none. The public token in the path is the credential: anyone with it can read the resource.\n\n## Behaviour\n\n- A resource becomes public when it gets a token in `meta.extension`, with the URL `https://api.ovok.com/fhir/StructureDefinition/public-resource-token`. Use `PATCH /public/{resourceType}/{id}` to give a resource a token.\n- The token names exactly one resource. The response is that resource as stored, including its `meta.extension`.\n- A token stops working when the resource's token is replaced or deleted, or when the resource is deleted.\n\n## Example\n\n```bash\ncurl 'https://api.sandbox.ovok.com/public/example.jwt.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/public-resource-access/get-a-public-resource","$ref":"(api-reference)/api/(operations)/public-resource-access/get-a-public-resource.mdx"},{"$id":"(api-reference)/api/(operations)/public-resource-access/change-public-resource-token.mdx","type":"page","name":"$Lc9","description":"$ca","icon":"$undefined","url":"/api/public-resource-access/change-public-resource-token","$ref":"(api-reference)/api/(operations)/public-resource-access/change-public-resource-token.mdx"},{"$id":"(api-reference)/api/(operations)/public-resource-access/delete-public-resource-token.mdx","type":"page","name":"$Lcb","description":"Removes the public token from a resource, so it can no longer be read with `GET /public/{token}`. The resource itself is kept.\n\n**Auth:** bearer token of a project admin.\n\n## Behaviour\n\n- The resource must be in the caller's project or one of its sub-projects. A resource of any other project, the parent project included, answers `403` and is left unchanged; an unknown id answers `404`.\n- Removes the `meta.extension` entry with the URL `https://api.ovok.com/fhir/StructureDefinition/public-resource-token`. Other extensions are kept.\n- Calling it on a resource without a token succeeds.\n- The response is `{ token: null, resource }` with the updated resource.\n\n## Example\n\n```bash\ncurl -X DELETE 'https://api.sandbox.ovok.com/public/DocumentReference/87ea5dfc-8b8e-384d-8489-79496e706390' \\\n -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/public-resource-access/delete-public-resource-token","$ref":"(api-reference)/api/(operations)/public-resource-access/delete-public-resource-token.mdx"}],"$id":"(api-reference)/api/(operations)/public-resource-access","$ref":{"folder":"(api-reference)/api/(operations)/public-resource-access","meta":"(api-reference)/api/(operations)/public-resource-access/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Reset Password","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/reset-password/send-reset-password-email.mdx","type":"page","name":"$Lcc","description":"$cd","icon":"$undefined","url":"/api/reset-password/send-reset-password-email","$ref":"(api-reference)/api/(operations)/reset-password/send-reset-password-email.mdx"},{"$id":"(api-reference)/api/(operations)/reset-password/reset-user-password-with-the-information-from-the-email.mdx","type":"page","name":"$Lce","description":"$cf","icon":"$undefined","url":"/api/reset-password/reset-user-password-with-the-information-from-the-email","$ref":"(api-reference)/api/(operations)/reset-password/reset-user-password-with-the-information-from-the-email.mdx"}],"$id":"(api-reference)/api/(operations)/reset-password","$ref":{"folder":"(api-reference)/api/(operations)/reset-password","meta":"(api-reference)/api/(operations)/reset-password/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Signals API - Alerts","root":"$undefined","defaultOpen":"$undefined","description":"Alerts raised by evaluation. An alert opens on a breach, deduplicates on its `TRIGGER:

` key while it stays open, and closes when a trigger resolves it.","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/signals-api---alerts/list-alerts-or-the-episodes-they-were-folded-into.mdx","type":"page","name":"$Ld0","description":"$d1","icon":"$undefined","url":"/api/signals-api---alerts/list-alerts-or-the-episodes-they-were-folded-into","$ref":"(api-reference)/api/(operations)/signals-api---alerts/list-alerts-or-the-episodes-they-were-folded-into.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---alerts/get-one-alert-or-one-episode-with-its-readings.mdx","type":"page","name":"$Ld2","description":"$d3","icon":"$undefined","url":"/api/signals-api---alerts/get-one-alert-or-one-episode-with-its-readings","$ref":"(api-reference)/api/(operations)/signals-api---alerts/get-one-alert-or-one-episode-with-its-readings.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---alerts/acknowledge-an-alert-or-an-episode.mdx","type":"page","name":"$Ld4","description":"$d5","icon":"$undefined","url":"/api/signals-api---alerts/acknowledge-an-alert-or-an-episode","$ref":"(api-reference)/api/(operations)/signals-api---alerts/acknowledge-an-alert-or-an-episode.mdx"}],"$id":"(api-reference)/api/(operations)/signals-api---alerts","$ref":{"folder":"(api-reference)/api/(operations)/signals-api---alerts","meta":"(api-reference)/api/(operations)/signals-api---alerts/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Signals API - Clients","root":"$undefined","defaultOpen":"$undefined","description":"API credentials and their webhook subscriptions.","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/signals-api---clients/list-users.mdx","type":"page","name":"$Ld6","description":"The tenant's API clients, newest first, in v1's paginate envelope (`page`, `limit` defaulting to 10) with nest's `nextCursor`. `role` and `name` filter as in v1.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_clients:read`. Project admins have every capability; client applications get no admin bypass.","icon":"$undefined","url":"/api/signals-api---clients/list-users","$ref":"(api-reference)/api/(operations)/signals-api---clients/list-users.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---clients/create-a-user.mdx","type":"page","name":"$Ld7","description":"$d8","icon":"$undefined","url":"/api/signals-api---clients/create-a-user","$ref":"(api-reference)/api/(operations)/signals-api---clients/create-a-user.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---clients/get-one-user.mdx","type":"page","name":"$Ld9","description":"Without its secret, which is not retrievable.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_clients:read`. Project admins have every capability; client applications get no admin bypass.","icon":"$undefined","url":"/api/signals-api---clients/get-one-user","$ref":"(api-reference)/api/(operations)/signals-api---clients/get-one-user.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---clients/update-a-user.mdx","type":"page","name":"$Lda","description":"Sets the name, webhook target, signing secret, events, event schema, reach or credential secret.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_webhooks:update`, `signals_events:read`. Project admins have every capability; client applications get no admin bypass.\n- Only subscribers are changed through ovok. Their `role`, `eventSchema`, `clientId`, `secret` and `webhookSecret` can't be sent.\n- It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.","icon":"$undefined","url":"/api/signals-api---clients/update-a-user","$ref":"(api-reference)/api/(operations)/signals-api---clients/update-a-user.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---clients/delete-a-user.mdx","type":"page","name":"$Ldb","description":"Revokes the credential at once and drops its undelivered webhook events.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_webhooks:delete`. Project admins have every capability; client applications get no admin bypass.\n- Only subscribers are deleted through ovok.\n- It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.","icon":"$undefined","url":"/api/signals-api---clients/delete-a-user","$ref":"(api-reference)/api/(operations)/signals-api---clients/delete-a-user.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---clients/read-the-webhook-endpoint.mdx","type":"page","name":"$Ldc","description":"The URL, whether it is `enabled`, `failing` or `disabled` (and why), when its current run of failures began, and its newest delivered and failed attempts. Five days of failures with no delivery, or one 410, disable it.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_webhooks:read`. Project admins have every capability; client applications get no admin bypass.","icon":"$undefined","url":"/api/signals-api---clients/read-the-webhook-endpoint","$ref":"(api-reference)/api/(operations)/signals-api---clients/read-the-webhook-endpoint.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---clients/enable-the-webhook-endpoint.mdx","type":"page","name":"$Ldd","description":"Resumes deliveries of new events. It re-queues nothing: events held while it was disabled go out only through `POST /api/events/redeliver?status=held`. Enabling an enabled endpoint changes nothing.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_webhooks:update`. Project admins have every capability; client applications get no admin bypass.\n- It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.","icon":"$undefined","url":"/api/signals-api---clients/enable-the-webhook-endpoint","$ref":"(api-reference)/api/(operations)/signals-api---clients/enable-the-webhook-endpoint.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---clients/disable-the-webhook-endpoint.mdx","type":"page","name":"$Lde","description":"Stops deliveries. Queued events and new ones are held, not dropped, for a redeliver once it is enabled again. Disabling a disabled endpoint keeps its first reason.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_webhooks:update`. Project admins have every capability; client applications get no admin bypass.\n- It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.","icon":"$undefined","url":"/api/signals-api---clients/disable-the-webhook-endpoint","$ref":"(api-reference)/api/(operations)/signals-api---clients/disable-the-webhook-endpoint.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---clients/send-a-test-event.mdx","type":"page","name":"$Ldf","description":"Sends a signed `webhook.test` event (`{ event, subscriber, sentAt }`) now, with every header a real delivery carries, and answers what the receiver did. It is not queued, retried or listed, and it works on a disabled endpoint, so a receiver can be checked before it is enabled.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_webhooks:update`. Project admins have every capability; client applications get no admin bypass.\n- It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.","icon":"$undefined","url":"/api/signals-api---clients/send-a-test-event","$ref":"(api-reference)/api/(operations)/signals-api---clients/send-a-test-event.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---clients/rotate-the-webhook-signing-secret.mdx","type":"page","name":"$Le0","description":"$e1","icon":"$undefined","url":"/api/signals-api---clients/rotate-the-webhook-signing-secret","$ref":"(api-reference)/api/(operations)/signals-api---clients/rotate-the-webhook-signing-secret.mdx"}],"$id":"(api-reference)/api/(operations)/signals-api---clients","$ref":{"folder":"(api-reference)/api/(operations)/signals-api---clients","meta":"(api-reference)/api/(operations)/signals-api---clients/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Signals API - Events","root":"$undefined","defaultOpen":"$undefined","description":"Every webhook event queued, with how its delivery went, and sending it again: the safety net after a receiver outage.","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/signals-api---events/list-webhook-events.mdx","type":"page","name":"$Le2","description":"$e3","icon":"$undefined","url":"/api/signals-api---events/list-webhook-events","$ref":"(api-reference)/api/(operations)/signals-api---events/list-webhook-events.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---events/list-a-delivery-s-attempts.mdx","type":"page","name":"$Le4","description":"Each POST made for it, oldest first: when, how long, the status code or the error, and the first 2 KB of the answer.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_events:read`. Project admins have every capability; client applications get no admin bypass.\n- It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.","icon":"$undefined","url":"/api/signals-api---events/list-a-delivery-s-attempts","$ref":"(api-reference)/api/(operations)/signals-api---events/list-a-delivery-s-attempts.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---events/redeliver-events.mdx","type":"page","name":"$Le5","description":"Queues the oldest 1 000 deliveries in `status` (default `failed`) queued since `since` to be sent again, each with a fresh retry ladder: the same `webhook-id`, so receivers dedupe, and a new `webhook-timestamp`. An alert is sent whatever its age. Deliveries to a disabled endpoint, and ones being sent right now, are skipped. While it answers `queued: 1000`, call it again for the next ones.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_webhooks:update`. Project admins have every capability; client applications get no admin bypass.\n- It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.","icon":"$undefined","url":"/api/signals-api---events/redeliver-events","$ref":"(api-reference)/api/(operations)/signals-api---events/redeliver-events.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---events/redeliver-one-event.mdx","type":"page","name":"$Le6","description":"Queues this delivery to be sent now, whatever its status, with a fresh retry ladder: the same `webhook-id` and a new `webhook-timestamp`. An alert is sent whatever its age.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_webhooks:update`. Project admins have every capability; client applications get no admin bypass.\n- It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.","icon":"$undefined","url":"/api/signals-api---events/redeliver-one-event","$ref":"(api-reference)/api/(operations)/signals-api---events/redeliver-one-event.mdx"}],"$id":"(api-reference)/api/(operations)/signals-api---events","$ref":{"folder":"(api-reference)/api/(operations)/signals-api---events","meta":"(api-reference)/api/(operations)/signals-api---events/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Signals API - Health","root":"$undefined","defaultOpen":"$undefined","description":"Liveness plus the pipeline check that alarms when readings arrive and nothing alerts, or alerts queue and nothing is delivered.","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/signals-api---health/liveness.mdx","type":"page","name":"$Le7","description":"Unauthenticated, always 200: the HTTP status reports that the process is serving, not that its dependencies are well, because this route gates container liveness. `healthy` is false while the database does not answer (`db.ok`); page on it.\n\n### Through ovok\n\n- **Who can call it:** any caller with an ovok access token, or a client id and secret. It needs no capability.","icon":"$undefined","url":"/api/signals-api---health/liveness","$ref":"(api-reference)/api/(operations)/signals-api---health/liveness.mdx"}],"$id":"(api-reference)/api/(operations)/signals-api---health","$ref":{"folder":"(api-reference)/api/(operations)/signals-api---health","meta":"(api-reference)/api/(operations)/signals-api---health/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Signals API - Observations","root":"$undefined","defaultOpen":"$undefined","description":"Submitting readings. This is the hot path: one POST per reading (or a batch), judged by the patient's triggers in force (its own over its home's) before the response returns unless the tenant is in async mode.","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/signals-api---observations/submit-a-reading-by-patient-refid.mdx","type":"page","name":"$Le8","description":"$e9","icon":"$undefined","url":"/api/signals-api---observations/submit-a-reading-by-patient-refid","$ref":"(api-reference)/api/(operations)/signals-api---observations/submit-a-reading-by-patient-refid.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---observations/list-a-patient-s-readings.mdx","type":"page","name":"$Lea","description":"$eb","icon":"$undefined","url":"/api/signals-api---observations/list-a-patient-s-readings","$ref":"(api-reference)/api/(operations)/signals-api---observations/list-a-patient-s-readings.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---observations/submit-a-reading-for-a-patient-id.mdx","type":"page","name":"$Lec","description":"$ed","icon":"$undefined","url":"/api/signals-api---observations/submit-a-reading-for-a-patient-id","$ref":"(api-reference)/api/(operations)/signals-api---observations/submit-a-reading-for-a-patient-id.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---observations/submit-several-readings-for-one-patient.mdx","type":"page","name":"$Lee","description":"$ef","icon":"$undefined","url":"/api/signals-api---observations/submit-several-readings-for-one-patient","$ref":"(api-reference)/api/(operations)/signals-api---observations/submit-several-readings-for-one-patient.mdx"}],"$id":"(api-reference)/api/(operations)/signals-api---observations","$ref":{"folder":"(api-reference)/api/(operations)/signals-api---observations","meta":"(api-reference)/api/(operations)/signals-api---observations/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Signals API - Patient config","root":"$undefined","defaultOpen":"$undefined","description":"v1's config writes addressed by a list of patient ids. A trigger is stored as sent in the patient's settings, where it judges its code; one without logic is rejected and reported. Reads are POSTs here too — a thousand ids do not fit in a query string.","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/signals-api---patient-config/write-one-config-to-many-patients.mdx","type":"page","name":"$Lf0","description":"$f1","icon":"$undefined","url":"/api/signals-api---patient-config/write-one-config-to-many-patients","$ref":"(api-reference)/api/(operations)/signals-api---patient-config/write-one-config-to-many-patients.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patient-config/write-a-different-config-to-each-of-many-patients.mdx","type":"page","name":"$Lf2","description":"The per-patient form, each entry with its own triggers, flags, `metadata` and `resolvedAt`. `results[]` has v1's `{id, matched, modified}` per entry; `staleIgnored` and `misses` are additions.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_config:update`, `signals_silence:update`. Project admins have every capability; client applications get no admin bypass.\n- A patient stamped with another project is refused.\n- If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), every patient the body names must be one you can update. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a `refId`; ovok asks Signals which patient a Signals id is.","icon":"$undefined","url":"/api/signals-api---patient-config/write-a-different-config-to-each-of-many-patients","$ref":"(api-reference)/api/(operations)/signals-api---patient-config/write-a-different-config-to-each-of-many-patients.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patient-config/read-the-config-status-of-many-patients.mdx","type":"page","name":"$Lf3","description":"Each patient's `configUpdatedAt` and trigger codes, so a caller can confirm a push landed without re-reading every trigger; `triggerFingerprints` adds what each rule says.\n\nExactly one row per requested id, in the order asked. An id that resolves to nothing answers `refId: null` with no codes, as v1 did.\n\nA POST because the id list is the request; it writes nothing.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_config:read`. Project admins have every capability; client applications get no admin bypass.\n- If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), every patient the body names must be one you can read. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a `refId`; ovok asks Signals which patient a Signals id is.","icon":"$undefined","url":"/api/signals-api---patient-config/read-the-config-status-of-many-patients","$ref":"(api-reference)/api/(operations)/signals-api---patient-config/read-the-config-status-of-many-patients.mdx"}],"$id":"(api-reference)/api/(operations)/signals-api---patient-config","$ref":{"folder":"(api-reference)/api/(operations)/signals-api---patient-config","meta":"(api-reference)/api/(operations)/signals-api---patient-config/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Signals API - Patients","root":"$undefined","defaultOpen":"$undefined","description":"Patients and their alerting flags. `refId` is the caller's own identifier.","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/signals-api---patients/list-patients-2.mdx","type":"page","name":"$Lf4","description":"$f5","icon":"$undefined","url":"/api/signals-api---patients/list-patients-2","$ref":"(api-reference)/api/(operations)/signals-api---patients/list-patients-2.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/create-patients.mdx","type":"page","name":"$Lf6","description":"$f7","icon":"$undefined","url":"/api/signals-api---patients/create-patients","$ref":"(api-reference)/api/(operations)/signals-api---patients/create-patients.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/resolve-refids-to-signals-ids.mdx","type":"page","name":"$Lf8","description":"An object from each `patientRefId` this tenant holds to its Signals id. A refId the tenant does not hold is left out rather than failing the request.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_patients:read`. Project admins have every capability; client applications get no admin bypass.\n- If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), name them with `patientRefId`, each one you can read, at most 100. Signals then pages over just those patients, so pages and totals stay true. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a `refId`; ovok asks Signals which patient a Signals id is.","icon":"$undefined","url":"/api/signals-api---patients/resolve-refids-to-signals-ids","$ref":"(api-reference)/api/(operations)/signals-api---patients/resolve-refids-to-signals-ids.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/get-one-patient.mdx","type":"page","name":"$Lf9","description":"The patient with its config, triggers keyed by code. A SUBMITTER or SUBSCRIBER reads only patients it is attached to.\n\n### Through ovok\n\n- **Who can call it:** Manager apps and Submitter apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_patients:read`. Project admins have every capability; client applications get no admin bypass.\n- If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), the patient must be one you can read. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a `refId`; ovok asks Signals which patient a Signals id is.","icon":"$undefined","url":"/api/signals-api---patients/get-one-patient","$ref":"(api-reference)/api/(operations)/signals-api---patients/get-one-patient.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/update-a-patient.mdx","type":"page","name":"$Lfa","description":"Only the fields present are changed; `metadata` is merged, not replaced. Answered with the v1 document.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_patients:update`. Project admins have every capability; client applications get no admin bypass.\n- When you send `submitters` or `metadata`, ovok keeps your project's submitter and stamp in them. Sending `alertsPaused`, `alertIfEmpty`, `alertIfNote` or `alertInactiveDays` also needs `signals_config:update` and `signals_silence:update`.\n- If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), the patient, and one a `refId` in the body names, must be ones you can update. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a `refId`; ovok asks Signals which patient a Signals id is.","icon":"$undefined","url":"/api/signals-api---patients/update-a-patient","$ref":"(api-reference)/api/(operations)/signals-api---patients/update-a-patient.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/delete-a-patient.mdx","type":"page","name":"$Lfb","description":"Deletes the patient with its triggers, alerts, episodes and readings. This can't be undone through the API.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_patients:delete`. Project admins have every capability; client applications get no admin bypass.\n- If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), the patient must be one you can delete. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a `refId`; ovok asks Signals which patient a Signals id is.","icon":"$undefined","url":"/api/signals-api---patients/delete-a-patient","$ref":"(api-reference)/api/(operations)/signals-api---patients/delete-a-patient.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/list-a-submitter-s-patients.mdx","type":"page","name":"$Lfc","description":"The ids of the patients in this tenant the submitter may post readings for.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_associations:read`. Project admins have every capability; client applications get no admin bypass.\n- It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.","icon":"$undefined","url":"/api/signals-api---patients/list-a-submitter-s-patients","$ref":"(api-reference)/api/(operations)/signals-api---patients/list-a-submitter-s-patients.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/attach-patients-to-a-submitter.mdx","type":"page","name":"$Lfd","description":"Grants the client permission to post readings for those patients. Unknown patient ids are skipped, so a caller can re-post a superset of ids without a 404.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_associations:update`. Project admins have every capability; client applications get no admin bypass.\n- If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), every patient the body names must be one you can update. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a `refId`; ovok asks Signals which patient a Signals id is.","icon":"$undefined","url":"/api/signals-api---patients/attach-patients-to-a-submitter","$ref":"(api-reference)/api/(operations)/signals-api---patients/attach-patients-to-a-submitter.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/detach-a-patient-from-a-submitter.mdx","type":"page","name":"$Lfe","description":"The submitter may no longer post readings for the patient.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_associations:update`. Project admins have every capability; client applications get no admin bypass.\n- Your project's own submitter stays attached to its patients.\n- If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), the patient must be one you can update. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a `refId`; ovok asks Signals which patient a Signals id is.","icon":"$undefined","url":"/api/signals-api---patients/detach-a-patient-from-a-submitter","$ref":"(api-reference)/api/(operations)/signals-api---patients/detach-a-patient-from-a-submitter.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/list-a-subscriber-s-patients.mdx","type":"page","name":"$Lff","description":"The ids of the patients in this tenant the subscriber reads and receives alerts for.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_associations:read`. Project admins have every capability; client applications get no admin bypass.\n- It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.","icon":"$undefined","url":"/api/signals-api---patients/list-a-subscriber-s-patients","$ref":"(api-reference)/api/(operations)/signals-api---patients/list-a-subscriber-s-patients.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/attach-patients-to-a-subscriber.mdx","type":"page","name":"$L100","description":"Grants the client permission to read those patients' records and receive their alert webhooks. Unknown patient ids are skipped, so a caller can re-post a superset of ids without a 404.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_associations:update`. Project admins have every capability; client applications get no admin bypass.\n- If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), every patient the body names must be one you can update. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a `refId`; ovok asks Signals which patient a Signals id is.","icon":"$undefined","url":"/api/signals-api---patients/attach-patients-to-a-subscriber","$ref":"(api-reference)/api/(operations)/signals-api---patients/attach-patients-to-a-subscriber.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---patients/detach-a-patient-from-a-subscriber.mdx","type":"page","name":"$L101","description":"The subscriber no longer reads the patient's records or receives its alerts.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_associations:update`. Project admins have every capability; client applications get no admin bypass.\n- If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), the patient must be one you can update. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a `refId`; ovok asks Signals which patient a Signals id is.","icon":"$undefined","url":"/api/signals-api---patients/detach-a-patient-from-a-subscriber","$ref":"(api-reference)/api/(operations)/signals-api---patients/detach-a-patient-from-a-subscriber.mdx"}],"$id":"(api-reference)/api/(operations)/signals-api---patients","$ref":{"folder":"(api-reference)/api/(operations)/signals-api---patients","meta":"(api-reference)/api/(operations)/signals-api---patients/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Signals API - Settings","root":"$undefined","defaultOpen":"$undefined","description":"What the triggers judge by, per org (tenant and project) and per patient: the triggers themselves, bands per code and the out-of-bed limit. Opaque to Signals beyond `triggers`: the triggers give the other keys their meaning.","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/signals-api---settings/get-a-patient-s-own-rule-settings.mdx","type":"page","name":"$L102","description":"$103","icon":"$undefined","url":"/api/signals-api---settings/get-a-patient-s-own-rule-settings","$ref":"(api-reference)/api/(operations)/signals-api---settings/get-a-patient-s-own-rule-settings.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---settings/replace-a-patient-s-own-rule-settings.mdx","type":"page","name":"$L104","description":"$105","icon":"$undefined","url":"/api/signals-api---settings/replace-a-patient-s-own-rule-settings","$ref":"(api-reference)/api/(operations)/signals-api---settings/replace-a-patient-s-own-rule-settings.mdx"}],"$id":"(api-reference)/api/(operations)/signals-api---settings","$ref":{"folder":"(api-reference)/api/(operations)/signals-api---settings","meta":"(api-reference)/api/(operations)/signals-api---settings/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Signals API - Tenants","root":"$undefined","defaultOpen":"$undefined","description":"Tenant-level feature switches.","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/signals-api---tenants/get-the-caller-s-tenant.mdx","type":"page","name":"$L106","description":"The tenant is resolved from the credential; there is no id to pass. `orgSettings` is its tenant-wide rule settings, `{}` when none were written.\n\n### Through ovok\n\n- **Who can call it:** Manager apps, and users whose access policy grants the capabilities.\n- **Capabilities, all required:** `signals_config:read`. Project admins have every capability; client applications get no admin bypass.","icon":"$undefined","url":"/api/signals-api---tenants/get-the-caller-s-tenant","$ref":"(api-reference)/api/(operations)/signals-api---tenants/get-the-caller-s-tenant.mdx"},{"$id":"(api-reference)/api/(operations)/signals-api---tenants/update-tenant-settings.mdx","type":"page","name":"$L107","description":"$108","icon":"$undefined","url":"/api/signals-api---tenants/update-tenant-settings","$ref":"(api-reference)/api/(operations)/signals-api---tenants/update-tenant-settings.mdx"}],"$id":"(api-reference)/api/(operations)/signals-api---tenants","$ref":{"folder":"(api-reference)/api/(operations)/signals-api---tenants","meta":"(api-reference)/api/(operations)/signals-api---tenants/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Sleepiz","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/sleepiz/backfill-missed-sleepiz-nights.mdx","type":"page","name":"$L109","description":"$10a","icon":"$undefined","url":"/api/sleepiz/backfill-missed-sleepiz-nights","$ref":"(api-reference)/api/(operations)/sleepiz/backfill-missed-sleepiz-nights.mdx"}],"$id":"(api-reference)/api/(operations)/sleepiz","$ref":{"folder":"(api-reference)/api/(operations)/sleepiz","meta":"(api-reference)/api/(operations)/sleepiz/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Slim/Change History","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/change-history/list-change-history.mdx","type":"page","name":"$L10b","description":"$10c","icon":"$undefined","url":"/api/slim/change-history/list-change-history","$ref":"(api-reference)/api/(operations)/slim/change-history/list-change-history.mdx"}],"$id":"(api-reference)/api/(operations)/slim/change-history","$ref":{"folder":"(api-reference)/api/(operations)/slim/change-history","meta":"(api-reference)/api/(operations)/slim/change-history/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Device","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/device/list-projects-for-device-assignment.mdx","type":"page","name":"$L10d","description":"Lists the projects you can move a device into: your own project, its parent project and its sub-projects.\n\n**Auth:** bearer token. The caller must be a practitioner, an admin or a System Owner, and needs `Device:update`.\n**Scope:** the caller's project (from the token) and its parent and sub-projects.\n\n## Behaviour\n\n- Each entry is `{ project: { id, name } }`. `name` is an empty string when the project has none.\n- `total` is the number of projects returned.\n- Read-only.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/slim/device/assign/project' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/slim/device/list-projects-for-device-assignment","$ref":"(api-reference)/api/(operations)/slim/device/list-projects-for-device-assignment.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/move-device-to-another-project.mdx","type":"page","name":"$L10e","description":"$10f","icon":"$undefined","url":"/api/slim/device/move-device-to-another-project","$ref":"(api-reference)/api/(operations)/slim/device/move-device-to-another-project.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/list-devices.mdx","type":"page","name":"$L110","description":"$111","icon":"$undefined","url":"/api/slim/device/list-devices","$ref":"(api-reference)/api/(operations)/slim/device/list-devices.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/create-device.mdx","type":"page","name":"$L112","description":"$113","icon":"$undefined","url":"/api/slim/device/create-device","$ref":"(api-reference)/api/(operations)/slim/device/create-device.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/list-live-device-rows.mdx","type":"page","name":"$L114","description":"$115","icon":"$undefined","url":"/api/slim/device/list-live-device-rows","$ref":"(api-reference)/api/(operations)/slim/device/list-live-device-rows.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/list-live-telemetry-and-alerts-by-device.mdx","type":"page","name":"$L116","description":"$117","icon":"$undefined","url":"/api/slim/device/list-live-telemetry-and-alerts-by-device","$ref":"(api-reference)/api/(operations)/slim/device/list-live-telemetry-and-alerts-by-device.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/list-live-device-rows-lean.mdx","type":"page","name":"$L118","description":"$119","icon":"$undefined","url":"/api/slim/device/list-live-device-rows-lean","$ref":"(api-reference)/api/(operations)/slim/device/list-live-device-rows-lean.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/list-live-telemetry-and-alerts-by-device-lean.mdx","type":"page","name":"$L11a","description":"$11b","icon":"$undefined","url":"/api/slim/device/list-live-telemetry-and-alerts-by-device-lean","$ref":"(api-reference)/api/(operations)/slim/device/list-live-telemetry-and-alerts-by-device-lean.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/resolve-how-ingest-routes-device-serials.mdx","type":"page","name":"$L11c","description":"$11d","icon":"$undefined","url":"/api/slim/device/resolve-how-ingest-routes-device-serials","$ref":"(api-reference)/api/(operations)/slim/device/resolve-how-ingest-routes-device-serials.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/get-device.mdx","type":"page","name":"$L11e","description":"$11f","icon":"$undefined","url":"/api/slim/device/get-device","$ref":"(api-reference)/api/(operations)/slim/device/get-device.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/delete-device.mdx","type":"page","name":"$L120","description":"Deletes a device from your project.\n\n**Auth:** bearer token. The caller must be a practitioner, an admin or a System Owner, and needs `Device:delete`. System Owners cannot delete devices.\n**Scope:** the device must belong to the caller's project (from the token).\n\n## Behaviour\n\n- The Device resource is deleted. This cannot be undone.\n- If a resident is assigned, they are unassigned and their active out-of-bed episode is closed in the same transaction.\n- The device's use history is updated in the same transaction.\n- The delete is recorded in the change history.\n- The response has no body.\n\n## Example\n\n```bash\ncurl -X DELETE 'https://api.sandbox.ovok.com/v1/slim/device/c3499c27-2973-0a7f-807e-fb8676a92dcb' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/slim/device/delete-device","$ref":"(api-reference)/api/(operations)/slim/device/delete-device.mdx"},{"$id":"(api-reference)/api/(operations)/slim/device/update-device.mdx","type":"page","name":"$L121","description":"$122","icon":"$undefined","url":"/api/slim/device/update-device","$ref":"(api-reference)/api/(operations)/slim/device/update-device.mdx"}],"$id":"(api-reference)/api/(operations)/slim/device","$ref":{"folder":"(api-reference)/api/(operations)/slim/device","meta":"(api-reference)/api/(operations)/slim/device/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Export","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/export/create-night-report-pdf.mdx","type":"page","name":"$L123","description":"$124","icon":"$undefined","url":"/api/slim/export/create-night-report-pdf","$ref":"(api-reference)/api/(operations)/slim/export/create-night-report-pdf.mdx"}],"$id":"(api-reference)/api/(operations)/slim/export","$ref":{"folder":"(api-reference)/api/(operations)/slim/export","meta":"(api-reference)/api/(operations)/slim/export/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Health","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/health/get-health-status.mdx","type":"page","name":"$L125","description":"$126","icon":"$undefined","url":"/api/slim/health/get-health-status","$ref":"(api-reference)/api/(operations)/slim/health/get-health-status.mdx"}],"$id":"(api-reference)/api/(operations)/slim/health","$ref":{"folder":"(api-reference)/api/(operations)/slim/health","meta":"(api-reference)/api/(operations)/slim/health/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Invite","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/invite/invite-practitioner.mdx","type":"page","name":"$L127","description":"$128","icon":"$undefined","url":"/api/slim/invite/invite-practitioner","$ref":"(api-reference)/api/(operations)/slim/invite/invite-practitioner.mdx"}],"$id":"(api-reference)/api/(operations)/slim/invite","$ref":{"folder":"(api-reference)/api/(operations)/slim/invite","meta":"(api-reference)/api/(operations)/slim/invite/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Location","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/location/list-location-assignment-candidates.mdx","type":"page","name":"$L129","description":"$12a","icon":"$undefined","url":"/api/slim/location/list-location-assignment-candidates","$ref":"(api-reference)/api/(operations)/slim/location/list-location-assignment-candidates.mdx"},{"$id":"(api-reference)/api/(operations)/slim/location/list-locations.mdx","type":"page","name":"$L12b","description":"$12c","icon":"$undefined","url":"/api/slim/location/list-locations","$ref":"(api-reference)/api/(operations)/slim/location/list-locations.mdx"},{"$id":"(api-reference)/api/(operations)/slim/location/create-location.mdx","type":"page","name":"$L12d","description":"$12e","icon":"$undefined","url":"/api/slim/location/create-location","$ref":"(api-reference)/api/(operations)/slim/location/create-location.mdx"},{"$id":"(api-reference)/api/(operations)/slim/location/list-locations-in-a-project-admin.mdx","type":"page","name":"$L12f","description":"$130","icon":"$undefined","url":"/api/slim/location/list-locations-in-a-project-admin","$ref":"(api-reference)/api/(operations)/slim/location/list-locations-in-a-project-admin.mdx"},{"$id":"(api-reference)/api/(operations)/slim/location/create-location-in-a-project-admin.mdx","type":"page","name":"$L131","description":"$132","icon":"$undefined","url":"/api/slim/location/create-location-in-a-project-admin","$ref":"(api-reference)/api/(operations)/slim/location/create-location-in-a-project-admin.mdx"},{"$id":"(api-reference)/api/(operations)/slim/location/get-location.mdx","type":"page","name":"$L133","description":"$134","icon":"$undefined","url":"/api/slim/location/get-location","$ref":"(api-reference)/api/(operations)/slim/location/get-location.mdx"},{"$id":"(api-reference)/api/(operations)/slim/location/delete-location.mdx","type":"page","name":"$L135","description":"$136","icon":"$undefined","url":"/api/slim/location/delete-location","$ref":"(api-reference)/api/(operations)/slim/location/delete-location.mdx"},{"$id":"(api-reference)/api/(operations)/slim/location/update-location.mdx","type":"page","name":"$L137","description":"$138","icon":"$undefined","url":"/api/slim/location/update-location","$ref":"(api-reference)/api/(operations)/slim/location/update-location.mdx"}],"$id":"(api-reference)/api/(operations)/slim/location","$ref":{"folder":"(api-reference)/api/(operations)/slim/location","meta":"(api-reference)/api/(operations)/slim/location/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Notifications","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/notifications/list-recent-notifications.mdx","type":"page","name":"$L139","description":"$13a","icon":"$undefined","url":"/api/slim/notifications/list-recent-notifications","$ref":"(api-reference)/api/(operations)/slim/notifications/list-recent-notifications.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/list-recent-medical-notifications.mdx","type":"page","name":"$L13b","description":"$13c","icon":"$undefined","url":"/api/slim/notifications/list-recent-medical-notifications","$ref":"(api-reference)/api/(operations)/slim/notifications/list-recent-medical-notifications.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/list-recent-out-of-bed-notifications.mdx","type":"page","name":"$L13d","description":"$13e","icon":"$undefined","url":"/api/slim/notifications/list-recent-out-of-bed-notifications","$ref":"(api-reference)/api/(operations)/slim/notifications/list-recent-out-of-bed-notifications.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/list-recent-alarm-notifications.mdx","type":"page","name":"$L13f","description":"$140","icon":"$undefined","url":"/api/slim/notifications/list-recent-alarm-notifications","$ref":"(api-reference)/api/(operations)/slim/notifications/list-recent-alarm-notifications.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/list-out-of-bed-notifications.mdx","type":"page","name":"$L141","description":"$142","icon":"$undefined","url":"/api/slim/notifications/list-out-of-bed-notifications","$ref":"(api-reference)/api/(operations)/slim/notifications/list-out-of-bed-notifications.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/list-alarm-notifications.mdx","type":"page","name":"$L143","description":"$144","icon":"$undefined","url":"/api/slim/notifications/list-alarm-notifications","$ref":"(api-reference)/api/(operations)/slim/notifications/list-alarm-notifications.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/list-medical-notifications.mdx","type":"page","name":"$L145","description":"$146","icon":"$undefined","url":"/api/slim/notifications/list-medical-notifications","$ref":"(api-reference)/api/(operations)/slim/notifications/list-medical-notifications.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/get-medical-notification.mdx","type":"page","name":"$L147","description":"$148","icon":"$undefined","url":"/api/slim/notifications/get-medical-notification","$ref":"(api-reference)/api/(operations)/slim/notifications/get-medical-notification.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/acknowledge-medical-notification.mdx","type":"page","name":"$L149","description":"$14a","icon":"$undefined","url":"/api/slim/notifications/acknowledge-medical-notification","$ref":"(api-reference)/api/(operations)/slim/notifications/acknowledge-medical-notification.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/leave-a-note-on-a-notification.mdx","type":"page","name":"$L14b","description":"$14c","icon":"$undefined","url":"/api/slim/notifications/leave-a-note-on-a-notification","$ref":"(api-reference)/api/(operations)/slim/notifications/leave-a-note-on-a-notification.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/an-out-of-bed-notification-s-notes.mdx","type":"page","name":"$L14d","description":"$14e","icon":"$undefined","url":"/api/slim/notifications/an-out-of-bed-notification-s-notes","$ref":"(api-reference)/api/(operations)/slim/notifications/an-out-of-bed-notification-s-notes.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/an-alarm-notification-s-notes.mdx","type":"page","name":"$L14f","description":"$150","icon":"$undefined","url":"/api/slim/notifications/an-alarm-notification-s-notes","$ref":"(api-reference)/api/(operations)/slim/notifications/an-alarm-notification-s-notes.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/a-medical-notification-s-notes.mdx","type":"page","name":"$L151","description":"$152","icon":"$undefined","url":"/api/slim/notifications/a-medical-notification-s-notes","$ref":"(api-reference)/api/(operations)/slim/notifications/a-medical-notification-s-notes.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/a-raw-signals-alert-s-notes.mdx","type":"page","name":"$L153","description":"Lists the notes on a raw Signals alert. A note is a practitioner's comment on a notification, stored as a FHIR `Communication` whose `basedOn` points at the alert. The alert itself is never changed.\n\n**Auth:** Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the \"System Owner\" access policy. The access policy must grant `Patient:read` (an admin or super admin who holds no access policy skips this check).\n**Scope:** The alert is read from Signals first: 404 when it isn't in the caller's project or the caller can't read its resident.\n\n## Behaviour\n\n- Newest first. Deleted notes are not listed.\n- Answers 503 `signals_unavailable` while Signals is down. Retry once Signals is back.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/slim/notifications/raw-alerts/c3499c27-2973-0a7f-807e-fb8676a92dcb/notes' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/slim/notifications/a-raw-signals-alert-s-notes","$ref":"(api-reference)/api/(operations)/slim/notifications/a-raw-signals-alert-s-notes.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/edit-a-note-s-text.mdx","type":"page","name":"$L154","description":"$155","icon":"$undefined","url":"/api/slim/notifications/edit-a-note-s-text","$ref":"(api-reference)/api/(operations)/slim/notifications/edit-a-note-s-text.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/delete-a-note.mdx","type":"page","name":"$L156","description":"$157","icon":"$undefined","url":"/api/slim/notifications/delete-a-note","$ref":"(api-reference)/api/(operations)/slim/notifications/delete-a-note.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/replace-a-note-s-text.mdx","type":"page","name":"$L158","description":"$159","icon":"$undefined","url":"/api/slim/notifications/replace-a-note-s-text","$ref":"(api-reference)/api/(operations)/slim/notifications/replace-a-note-s-text.mdx"},{"$id":"(api-reference)/api/(operations)/slim/notifications/acknowledge-notification.mdx","type":"page","name":"$L15a","description":"$15b","icon":"$undefined","url":"/api/slim/notifications/acknowledge-notification","$ref":"(api-reference)/api/(operations)/slim/notifications/acknowledge-notification.mdx"}],"$id":"(api-reference)/api/(operations)/slim/notifications","$ref":{"folder":"(api-reference)/api/(operations)/slim/notifications","meta":"(api-reference)/api/(operations)/slim/notifications/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Organization","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/organization/get-organization.mdx","type":"page","name":"$L15c","description":"$15d","icon":"$undefined","url":"/api/slim/organization/get-organization","$ref":"(api-reference)/api/(operations)/slim/organization/get-organization.mdx"},{"$id":"(api-reference)/api/(operations)/slim/organization/delete-organization.mdx","type":"page","name":"$L15e","description":"$15f","icon":"$undefined","url":"/api/slim/organization/delete-organization","$ref":"(api-reference)/api/(operations)/slim/organization/delete-organization.mdx"},{"$id":"(api-reference)/api/(operations)/slim/organization/update-organization.mdx","type":"page","name":"$L160","description":"$161","icon":"$undefined","url":"/api/slim/organization/update-organization","$ref":"(api-reference)/api/(operations)/slim/organization/update-organization.mdx"},{"$id":"(api-reference)/api/(operations)/slim/organization/create-organization.mdx","type":"page","name":"$L162","description":"$163","icon":"$undefined","url":"/api/slim/organization/create-organization","$ref":"(api-reference)/api/(operations)/slim/organization/create-organization.mdx"}],"$id":"(api-reference)/api/(operations)/slim/organization","$ref":{"folder":"(api-reference)/api/(operations)/slim/organization","meta":"(api-reference)/api/(operations)/slim/organization/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Patient","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/patient/list-patients.mdx","type":"page","name":"$L164","description":"$165","icon":"$undefined","url":"/api/slim/patient/list-patients","$ref":"(api-reference)/api/(operations)/slim/patient/list-patients.mdx"},{"$id":"(api-reference)/api/(operations)/slim/patient/create-patient.mdx","type":"page","name":"$L166","description":"$167","icon":"$undefined","url":"/api/slim/patient/create-patient","$ref":"(api-reference)/api/(operations)/slim/patient/create-patient.mdx"},{"$id":"(api-reference)/api/(operations)/slim/patient/get-patient-current-vitals.mdx","type":"page","name":"$L168","description":"$169","icon":"$undefined","url":"/api/slim/patient/get-patient-current-vitals","$ref":"(api-reference)/api/(operations)/slim/patient/get-patient-current-vitals.mdx"},{"$id":"(api-reference)/api/(operations)/slim/patient/get-patient-everything.mdx","type":"page","name":"$L16a","description":"$16b","icon":"$undefined","url":"/api/slim/patient/get-patient-everything","$ref":"(api-reference)/api/(operations)/slim/patient/get-patient-everything.mdx"},{"$id":"(api-reference)/api/(operations)/slim/patient/get-patient.mdx","type":"page","name":"$L16c","description":"$16d","icon":"$undefined","url":"/api/slim/patient/get-patient","$ref":"(api-reference)/api/(operations)/slim/patient/get-patient.mdx"},{"$id":"(api-reference)/api/(operations)/slim/patient/delete-patient.mdx","type":"page","name":"$L16e","description":"$16f","icon":"$undefined","url":"/api/slim/patient/delete-patient","$ref":"(api-reference)/api/(operations)/slim/patient/delete-patient.mdx"},{"$id":"(api-reference)/api/(operations)/slim/patient/update-patient.mdx","type":"page","name":"$L170","description":"$171","icon":"$undefined","url":"/api/slim/patient/update-patient","$ref":"(api-reference)/api/(operations)/slim/patient/update-patient.mdx"},{"$id":"(api-reference)/api/(operations)/slim/patient/check-patient-name-exists.mdx","type":"page","name":"$L172","description":"$173","icon":"$undefined","url":"/api/slim/patient/check-patient-name-exists","$ref":"(api-reference)/api/(operations)/slim/patient/check-patient-name-exists.mdx"}],"$id":"(api-reference)/api/(operations)/slim/patient","$ref":{"folder":"(api-reference)/api/(operations)/slim/patient","meta":"(api-reference)/api/(operations)/slim/patient/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Policy","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/policy/list-access-policies.mdx","type":"page","name":"$L174","description":"$175","icon":"$undefined","url":"/api/slim/policy/list-access-policies","$ref":"(api-reference)/api/(operations)/slim/policy/list-access-policies.mdx"},{"$id":"(api-reference)/api/(operations)/slim/policy/create-access-policy.mdx","type":"page","name":"$L176","description":"$177","icon":"$undefined","url":"/api/slim/policy/create-access-policy","$ref":"(api-reference)/api/(operations)/slim/policy/create-access-policy.mdx"},{"$id":"(api-reference)/api/(operations)/slim/policy/get-access-policy.mdx","type":"page","name":"$L178","description":"Returns one access policy (role) with the practitioners who hold it.\n\n**Auth:** Bearer token for a practitioner, project admin or System Owner session. The caller's access policy must grant `Practitioner:create`, the right to invite users (a project admin who holds no access policy skips this check).\n**Scope:** The policy must belong to the caller's project (from the token), its parent project or one of its direct child projects.\n\n## Behaviour\n\n- Returns `{ policy, members }`. `policy` is the full `AccessPolicy`. `members` lists the `Practitioner` members whose membership points to it, as `{ reference, display }`.\n\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/slim/policy/c3499c27-2973-0a7f-807e-fb8676a92dcb' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/slim/policy/get-access-policy","$ref":"(api-reference)/api/(operations)/slim/policy/get-access-policy.mdx"},{"$id":"(api-reference)/api/(operations)/slim/policy/delete-access-policy.mdx","type":"page","name":"$L179","description":"$17a","icon":"$undefined","url":"/api/slim/policy/delete-access-policy","$ref":"(api-reference)/api/(operations)/slim/policy/delete-access-policy.mdx"},{"$id":"(api-reference)/api/(operations)/slim/policy/update-access-policy.mdx","type":"page","name":"$L17b","description":"$17c","icon":"$undefined","url":"/api/slim/policy/update-access-policy","$ref":"(api-reference)/api/(operations)/slim/policy/update-access-policy.mdx"}],"$id":"(api-reference)/api/(operations)/slim/policy","$ref":{"folder":"(api-reference)/api/(operations)/slim/policy","meta":"(api-reference)/api/(operations)/slim/policy/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Practitioner","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/practitioner/get-practitioner.mdx","type":"page","name":"$L17d","description":"$17e","icon":"$undefined","url":"/api/slim/practitioner/get-practitioner","$ref":"(api-reference)/api/(operations)/slim/practitioner/get-practitioner.mdx"},{"$id":"(api-reference)/api/(operations)/slim/practitioner/update-practitioner.mdx","type":"page","name":"$L17f","description":"$180","icon":"$undefined","url":"/api/slim/practitioner/update-practitioner","$ref":"(api-reference)/api/(operations)/slim/practitioner/update-practitioner.mdx"}],"$id":"(api-reference)/api/(operations)/slim/practitioner","$ref":{"folder":"(api-reference)/api/(operations)/slim/practitioner","meta":"(api-reference)/api/(operations)/slim/practitioner/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Project","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/project/list-current-project-users.mdx","type":"page","name":"$L181","description":"$182","icon":"$undefined","url":"/api/slim/project/list-current-project-users","$ref":"(api-reference)/api/(operations)/slim/project/list-current-project-users.mdx"},{"$id":"(api-reference)/api/(operations)/slim/project/list-child-project-relationships.mdx","type":"page","name":"$L183","description":"$184","icon":"$undefined","url":"/api/slim/project/list-child-project-relationships","$ref":"(api-reference)/api/(operations)/slim/project/list-child-project-relationships.mdx"},{"$id":"(api-reference)/api/(operations)/slim/project/create-a-child-project.mdx","type":"page","name":"$L185","description":"$186","icon":"$undefined","url":"/api/slim/project/create-a-child-project","$ref":"(api-reference)/api/(operations)/slim/project/create-a-child-project.mdx"},{"$id":"(api-reference)/api/(operations)/slim/project/list-child-projects-with-device-counts.mdx","type":"page","name":"$L187","description":"$188","icon":"$undefined","url":"/api/slim/project/list-child-projects-with-device-counts","$ref":"(api-reference)/api/(operations)/slim/project/list-child-projects-with-device-counts.mdx"},{"$id":"(api-reference)/api/(operations)/slim/project/delete-a-child-project.mdx","type":"page","name":"$L189","description":"$18a","icon":"$undefined","url":"/api/slim/project/delete-a-child-project","$ref":"(api-reference)/api/(operations)/slim/project/delete-a-child-project.mdx"},{"$id":"(api-reference)/api/(operations)/slim/project/list-project-users.mdx","type":"page","name":"$L18b","description":"$18c","icon":"$undefined","url":"/api/slim/project/list-project-users","$ref":"(api-reference)/api/(operations)/slim/project/list-project-users.mdx"},{"$id":"(api-reference)/api/(operations)/slim/project/get-project-device-counts.mdx","type":"page","name":"$L18d","description":"$18e","icon":"$undefined","url":"/api/slim/project/get-project-device-counts","$ref":"(api-reference)/api/(operations)/slim/project/get-project-device-counts.mdx"},{"$id":"(api-reference)/api/(operations)/slim/project/get-project-patient-counts.mdx","type":"page","name":"$L18f","description":"$190","icon":"$undefined","url":"/api/slim/project/get-project-patient-counts","$ref":"(api-reference)/api/(operations)/slim/project/get-project-patient-counts.mdx"},{"$id":"(api-reference)/api/(operations)/slim/project/get-a-project.mdx","type":"page","name":"$L191","description":"$192","icon":"$undefined","url":"/api/slim/project/get-a-project","$ref":"(api-reference)/api/(operations)/slim/project/get-a-project.mdx"},{"$id":"(api-reference)/api/(operations)/slim/project/update-a-project.mdx","type":"page","name":"$L193","description":"$194","icon":"$undefined","url":"/api/slim/project/update-a-project","$ref":"(api-reference)/api/(operations)/slim/project/update-a-project.mdx"}],"$id":"(api-reference)/api/(operations)/slim/project","$ref":{"folder":"(api-reference)/api/(operations)/slim/project","meta":"(api-reference)/api/(operations)/slim/project/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Query","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/query/list-devices-with-telemetry-compatibility.mdx","type":"page","name":"$L195","description":"$196","icon":"$undefined","url":"/api/slim/query/list-devices-with-telemetry-compatibility","$ref":"(api-reference)/api/(operations)/slim/query/list-devices-with-telemetry-compatibility.mdx"},{"$id":"(api-reference)/api/(operations)/slim/query/list-telemetry-and-alerts-compatibility.mdx","type":"page","name":"$L197","description":"$198","icon":"$undefined","url":"/api/slim/query/list-telemetry-and-alerts-compatibility","$ref":"(api-reference)/api/(operations)/slim/query/list-telemetry-and-alerts-compatibility.mdx"},{"$id":"(api-reference)/api/(operations)/slim/query/get-resident-devices-with-telemetry-compatibility.mdx","type":"page","name":"$L199","description":"Compatibility route for older resident vitals clients. Returns the devices assigned to one resident, each with its telemetry. For new integrations, use `GET /v1/slim/patient/{id}/current-vitals`.\n\n**Auth:** bearer token. The caller must be a practitioner, an admin or a System Owner, and needs `search` and `read` on `Patient`, `Device`, `Location`, `Observation` and `Organization`.\n**Scope:** the caller's project (from the token). The `project` parameter is ignored.\n\n## Behaviour\n\n- Returns up to 100 device rows for the resident, with zone, device and telemetry.\n- Results are cached for up to 60 seconds. Writes made through the Slim routes refresh the cache sooner.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/slim/query/patient/c3499c27-2973-0a7f-807e-fb8676a92dcb' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/slim/query/get-resident-devices-with-telemetry-compatibility","$ref":"(api-reference)/api/(operations)/slim/query/get-resident-devices-with-telemetry-compatibility.mdx"},{"$id":"(api-reference)/api/(operations)/slim/query/count-devices-per-zone-compatibility.mdx","type":"page","name":"$L19a","description":"$19b","icon":"$undefined","url":"/api/slim/query/count-devices-per-zone-compatibility","$ref":"(api-reference)/api/(operations)/slim/query/count-devices-per-zone-compatibility.mdx"},{"$id":"(api-reference)/api/(operations)/slim/query/list-users-compatibility.mdx","type":"page","name":"$L19c","description":"$19d","icon":"$undefined","url":"/api/slim/query/list-users-compatibility","$ref":"(api-reference)/api/(operations)/slim/query/list-users-compatibility.mdx"},{"$id":"(api-reference)/api/(operations)/slim/query/list-users-across-projects-compatibility.mdx","type":"page","name":"$L19e","description":"Compatibility route for older cross-project user list clients. Behaves exactly like `GET /v1/slim/query/user`. For new integrations, use `GET /v1/slim/project/{id}/users`.\n\n**Auth:** bearer token. The caller must be a practitioner, an admin or a System Owner, and needs `Practitioner:read`. No extra admin check is applied.\n**Scope:** the caller's project (from the token), or the project in `project=Project/` when it is your project or one of its sub-projects.\n\n## Behaviour\n\n- Same parameters, filters, sorting, paging and caching as `GET /v1/slim/query/user`.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/slim/query/admin/user?profileType=Practitioner&project=Project/c3499c27-2973-0a7f-807e-fb8676a92dcb' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/slim/query/list-users-across-projects-compatibility","$ref":"(api-reference)/api/(operations)/slim/query/list-users-across-projects-compatibility.mdx"}],"$id":"(api-reference)/api/(operations)/slim/query","$ref":{"folder":"(api-reference)/api/(operations)/slim/query","meta":"(api-reference)/api/(operations)/slim/query/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Sleep","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/sleep/get-sleep-statistics.mdx","type":"page","name":"$L19f","description":"$1a0","icon":"$undefined","url":"/api/slim/sleep/get-sleep-statistics","$ref":"(api-reference)/api/(operations)/slim/sleep/get-sleep-statistics.mdx"}],"$id":"(api-reference)/api/(operations)/slim/sleep","$ref":{"folder":"(api-reference)/api/(operations)/slim/sleep","meta":"(api-reference)/api/(operations)/slim/sleep/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Telemetry","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/telemetry/list-effective-observation-ids-by-device.mdx","type":"page","name":"$L1a1","description":"Returns the effective Observation ids for every device in your project, keyed by device identifier. These are the readings that produced each device's current heart rate, respiratory rate, sleep status and presence values.\n\n**Auth:** bearer token. The caller must be a practitioner, an admin or a System Owner, and needs `Device:read` and `Device:search`.\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- Covers the devices that have telemetry, up to the first 1000 devices of the project, including devices without a resident.\n- Each value has the same shape as `GET /v1/slim/telemetry/{deviceId}/effectiveIds`. Fields are `null` when no reading has set them.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/slim/telemetry/effectiveIds' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/slim/telemetry/list-effective-observation-ids-by-device","$ref":"(api-reference)/api/(operations)/slim/telemetry/list-effective-observation-ids-by-device.mdx"},{"$id":"(api-reference)/api/(operations)/slim/telemetry/list-last-received-observation-ids-by-device.mdx","type":"page","name":"$L1a2","description":"Returns the last-received Observation ids for every device in your project, keyed by device identifier.\n\n**Auth:** bearer token. The caller must be a practitioner, an admin or a System Owner, and needs `Device:read` and `Device:search`.\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- Covers the devices that have telemetry, up to the first 1000 devices of the project, including devices without a resident.\n- Each value has the same shape as `GET /v1/slim/telemetry/{deviceId}/lastIds`. Fields are `null` when nothing has been received for them.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/slim/telemetry/lastIds' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/slim/telemetry/list-last-received-observation-ids-by-device","$ref":"(api-reference)/api/(operations)/slim/telemetry/list-last-received-observation-ids-by-device.mdx"},{"$id":"(api-reference)/api/(operations)/slim/telemetry/get-effective-observation-ids-for-a-device.mdx","type":"page","name":"$L1a3","description":"$1a4","icon":"$undefined","url":"/api/slim/telemetry/get-effective-observation-ids-for-a-device","$ref":"(api-reference)/api/(operations)/slim/telemetry/get-effective-observation-ids-for-a-device.mdx"},{"$id":"(api-reference)/api/(operations)/slim/telemetry/get-last-received-observation-ids-for-a-device.mdx","type":"page","name":"$L1a5","description":"$1a6","icon":"$undefined","url":"/api/slim/telemetry/get-last-received-observation-ids-for-a-device","$ref":"(api-reference)/api/(operations)/slim/telemetry/get-last-received-observation-ids-for-a-device.mdx"},{"$id":"(api-reference)/api/(operations)/slim/telemetry/get-device-telemetry-and-alerts.mdx","type":"page","name":"$L1a7","description":"$1a8","icon":"$undefined","url":"/api/slim/telemetry/get-device-telemetry-and-alerts","$ref":"(api-reference)/api/(operations)/slim/telemetry/get-device-telemetry-and-alerts.mdx"}],"$id":"(api-reference)/api/(operations)/slim/telemetry","$ref":{"folder":"(api-reference)/api/(operations)/slim/telemetry","meta":"(api-reference)/api/(operations)/slim/telemetry/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Threshold","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/threshold/get-current-threshold.mdx","type":"page","name":"$L1a9","description":"$1aa","icon":"$undefined","url":"/api/slim/threshold/get-current-threshold","$ref":"(api-reference)/api/(operations)/slim/threshold/get-current-threshold.mdx"},{"$id":"(api-reference)/api/(operations)/slim/threshold/update-threshold.mdx","type":"page","name":"$L1ab","description":"$1ac","icon":"$undefined","url":"/api/slim/threshold/update-threshold","$ref":"(api-reference)/api/(operations)/slim/threshold/update-threshold.mdx"}],"$id":"(api-reference)/api/(operations)/slim/threshold","$ref":{"folder":"(api-reference)/api/(operations)/slim/threshold","meta":"(api-reference)/api/(operations)/slim/threshold/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Trends","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/trends/get-trends-graphs.mdx","type":"page","name":"$L1ad","description":"$1ae","icon":"$undefined","url":"/api/slim/trends/get-trends-graphs","$ref":"(api-reference)/api/(operations)/slim/trends/get-trends-graphs.mdx"},{"$id":"(api-reference)/api/(operations)/slim/trends/get-realtime-trends-graphs.mdx","type":"page","name":"$L1af","description":"$1b0","icon":"$undefined","url":"/api/slim/trends/get-realtime-trends-graphs","$ref":"(api-reference)/api/(operations)/slim/trends/get-realtime-trends-graphs.mdx"}],"$id":"(api-reference)/api/(operations)/slim/trends","$ref":{"folder":"(api-reference)/api/(operations)/slim/trends","meta":"(api-reference)/api/(operations)/slim/trends/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/User","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/user/get-terms-and-conditions-consent.mdx","type":"page","name":"$L1b1","description":"$1b2","icon":"$undefined","url":"/api/slim/user/get-terms-and-conditions-consent","$ref":"(api-reference)/api/(operations)/slim/user/get-terms-and-conditions-consent.mdx"},{"$id":"(api-reference)/api/(operations)/slim/user/update-terms-and-conditions-consent.mdx","type":"page","name":"$L1b3","description":"$1b4","icon":"$undefined","url":"/api/slim/user/update-terms-and-conditions-consent","$ref":"(api-reference)/api/(operations)/slim/user/update-terms-and-conditions-consent.mdx"},{"$id":"(api-reference)/api/(operations)/slim/user/get-all-user-consents.mdx","type":"page","name":"$L1b5","description":"$1b6","icon":"$undefined","url":"/api/slim/user/get-all-user-consents","$ref":"(api-reference)/api/(operations)/slim/user/get-all-user-consents.mdx"},{"$id":"(api-reference)/api/(operations)/slim/user/update-user-consents.mdx","type":"page","name":"$L1b7","description":"$1b8","icon":"$undefined","url":"/api/slim/user/update-user-consents","$ref":"(api-reference)/api/(operations)/slim/user/update-user-consents.mdx"},{"$id":"(api-reference)/api/(operations)/slim/user/send-support-message.mdx","type":"page","name":"$L1b9","description":"$1ba","icon":"$undefined","url":"/api/slim/user/send-support-message","$ref":"(api-reference)/api/(operations)/slim/user/send-support-message.mdx"},{"$id":"(api-reference)/api/(operations)/slim/user/delete-user.mdx","type":"page","name":"$L1bb","description":"$1bc","icon":"$undefined","url":"/api/slim/user/delete-user","$ref":"(api-reference)/api/(operations)/slim/user/delete-user.mdx"}],"$id":"(api-reference)/api/(operations)/slim/user","$ref":{"folder":"(api-reference)/api/(operations)/slim/user","meta":"(api-reference)/api/(operations)/slim/user/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Zones","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/slim/zones/list-zones.mdx","type":"page","name":"$L1bd","description":"$1be","icon":"$undefined","url":"/api/slim/zones/list-zones","$ref":"(api-reference)/api/(operations)/slim/zones/list-zones.mdx"},{"$id":"(api-reference)/api/(operations)/slim/zones/get-zone-device-counts.mdx","type":"page","name":"$L1bf","description":"$1c0","icon":"$undefined","url":"/api/slim/zones/get-zone-device-counts","$ref":"(api-reference)/api/(operations)/slim/zones/get-zone-device-counts.mdx"},{"$id":"(api-reference)/api/(operations)/slim/zones/get-zone-detail.mdx","type":"page","name":"$L1c1","description":"$1c2","icon":"$undefined","url":"/api/slim/zones/get-zone-detail","$ref":"(api-reference)/api/(operations)/slim/zones/get-zone-detail.mdx"},{"$id":"(api-reference)/api/(operations)/slim/zones/create-location-in-zone.mdx","type":"page","name":"$L1c3","description":"$1c4","icon":"$undefined","url":"/api/slim/zones/create-location-in-zone","$ref":"(api-reference)/api/(operations)/slim/zones/create-location-in-zone.mdx"},{"$id":"(api-reference)/api/(operations)/slim/zones/delete-location-in-zone.mdx","type":"page","name":"$L1c5","description":"$1c6","icon":"$undefined","url":"/api/slim/zones/delete-location-in-zone","$ref":"(api-reference)/api/(operations)/slim/zones/delete-location-in-zone.mdx"},{"$id":"(api-reference)/api/(operations)/slim/zones/update-location-in-zone.mdx","type":"page","name":"$L1c7","description":"$1c8","icon":"$undefined","url":"/api/slim/zones/update-location-in-zone","$ref":"(api-reference)/api/(operations)/slim/zones/update-location-in-zone.mdx"}],"$id":"(api-reference)/api/(operations)/slim/zones","$ref":{"folder":"(api-reference)/api/(operations)/slim/zones","meta":"(api-reference)/api/(operations)/slim/zones/meta.json"},"icon":"$undefined"}],"$id":"(api-reference)/api/(operations)/slim","$ref":{"folder":"(api-reference)/api/(operations)/slim","meta":"$undefined"},"icon":"$undefined"},{"type":"folder","name":"Sub Project","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/sub-project/check-child-project-access-policy-drift.mdx","type":"page","name":"$L1c9","description":"$1ca","icon":"$undefined","url":"/api/sub-project/check-child-project-access-policy-drift","$ref":"(api-reference)/api/(operations)/sub-project/check-child-project-access-policy-drift.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/check-child-project-access-policy-drift-2.mdx","type":"page","name":"$L1cb","description":"$1cc","icon":"$undefined","url":"/api/sub-project/check-child-project-access-policy-drift-2","$ref":"(api-reference)/api/(operations)/sub-project/check-child-project-access-policy-drift-2.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/check-child-project-access-policy-drift-3.mdx","type":"page","name":"$L1cd","description":"$1ce","icon":"$undefined","url":"/api/sub-project/check-child-project-access-policy-drift-3","$ref":"(api-reference)/api/(operations)/sub-project/check-child-project-access-policy-drift-3.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/check-child-project-access-policy-drift-4.mdx","type":"page","name":"$L1cf","description":"$1d0","icon":"$undefined","url":"/api/sub-project/check-child-project-access-policy-drift-4","$ref":"(api-reference)/api/(operations)/sub-project/check-child-project-access-policy-drift-4.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/repair-child-project-access-policy-drift.mdx","type":"page","name":"$L1d1","description":"$1d2","icon":"$undefined","url":"/api/sub-project/repair-child-project-access-policy-drift","$ref":"(api-reference)/api/(operations)/sub-project/repair-child-project-access-policy-drift.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/repair-child-project-access-policy-drift-2.mdx","type":"page","name":"$L1d3","description":"$1d4","icon":"$undefined","url":"/api/sub-project/repair-child-project-access-policy-drift-2","$ref":"(api-reference)/api/(operations)/sub-project/repair-child-project-access-policy-drift-2.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/repair-child-project-access-policy-drift-3.mdx","type":"page","name":"$L1d5","description":"$1d6","icon":"$undefined","url":"/api/sub-project/repair-child-project-access-policy-drift-3","$ref":"(api-reference)/api/(operations)/sub-project/repair-child-project-access-policy-drift-3.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/repair-child-project-access-policy-drift-4.mdx","type":"page","name":"$L1d7","description":"$1d8","icon":"$undefined","url":"/api/sub-project/repair-child-project-access-policy-drift-4","$ref":"(api-reference)/api/(operations)/sub-project/repair-child-project-access-policy-drift-4.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/list-project-relationships.mdx","type":"page","name":"$L1d9","description":"Returns where your current project sits in the project hierarchy: its parent and its direct children.\n\n**Auth:** bearer token of a project admin (`ProjectMembership.admin`).\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- `parentProjectId` is `null` for a project with no parent.\n- `subProjectIds` lists direct children only.\n- The result is cached for up to 5 minutes. Creating or deleting a child through Ovok clears the cache; other changes can take that long to show.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/internal/sub-project' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/sub-project/list-project-relationships","$ref":"(api-reference)/api/(operations)/sub-project/list-project-relationships.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/create-a-sub-tenant.mdx","type":"page","name":"$L1da","description":"$1db","icon":"$undefined","url":"/api/sub-project/create-a-sub-tenant","$ref":"(api-reference)/api/(operations)/sub-project/create-a-sub-tenant.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/list-project-relationships-2.mdx","type":"page","name":"$L1dc","description":"Returns where your current project sits in the project hierarchy: its parent and its direct children.\n\n**Auth:** bearer token of a project admin (`ProjectMembership.admin`).\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- `parentProjectId` is `null` for a project with no parent.\n- `subProjectIds` lists direct children only.\n- The result is cached for up to 5 minutes. Creating or deleting a child through Ovok clears the cache; other changes can take that long to show.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/internal/sub-project' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/sub-project/list-project-relationships-2","$ref":"(api-reference)/api/(operations)/sub-project/list-project-relationships-2.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/create-a-sub-tenant-2.mdx","type":"page","name":"$L1dd","description":"$1de","icon":"$undefined","url":"/api/sub-project/create-a-sub-tenant-2","$ref":"(api-reference)/api/(operations)/sub-project/create-a-sub-tenant-2.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/list-project-relationships-3.mdx","type":"page","name":"$L1df","description":"Returns where your current project sits in the project hierarchy: its parent and its direct children.\n\n**Auth:** bearer token of a project admin (`ProjectMembership.admin`).\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- `parentProjectId` is `null` for a project with no parent.\n- `subProjectIds` lists direct children only.\n- The result is cached for up to 5 minutes. Creating or deleting a child through Ovok clears the cache; other changes can take that long to show.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/internal/sub-project' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/sub-project/list-project-relationships-3","$ref":"(api-reference)/api/(operations)/sub-project/list-project-relationships-3.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/create-a-sub-tenant-3.mdx","type":"page","name":"$L1e0","description":"$1e1","icon":"$undefined","url":"/api/sub-project/create-a-sub-tenant-3","$ref":"(api-reference)/api/(operations)/sub-project/create-a-sub-tenant-3.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/list-project-relationships-4.mdx","type":"page","name":"$L1e2","description":"Returns where your current project sits in the project hierarchy: its parent and its direct children.\n\n**Auth:** bearer token of a project admin (`ProjectMembership.admin`).\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- `parentProjectId` is `null` for a project with no parent.\n- `subProjectIds` lists direct children only.\n- The result is cached for up to 5 minutes. Creating or deleting a child through Ovok clears the cache; other changes can take that long to show.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/internal/sub-project' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/sub-project/list-project-relationships-4","$ref":"(api-reference)/api/(operations)/sub-project/list-project-relationships-4.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/create-a-sub-tenant-4.mdx","type":"page","name":"$L1e3","description":"$1e4","icon":"$undefined","url":"/api/sub-project/create-a-sub-tenant-4","$ref":"(api-reference)/api/(operations)/sub-project/create-a-sub-tenant-4.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/delete-a-sub-tenant.mdx","type":"page","name":"$L1e5","description":"$1e6","icon":"$undefined","url":"/api/sub-project/delete-a-sub-tenant","$ref":"(api-reference)/api/(operations)/sub-project/delete-a-sub-tenant.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/delete-a-sub-tenant-2.mdx","type":"page","name":"$L1e7","description":"$1e8","icon":"$undefined","url":"/api/sub-project/delete-a-sub-tenant-2","$ref":"(api-reference)/api/(operations)/sub-project/delete-a-sub-tenant-2.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/delete-a-sub-tenant-3.mdx","type":"page","name":"$L1e9","description":"$1ea","icon":"$undefined","url":"/api/sub-project/delete-a-sub-tenant-3","$ref":"(api-reference)/api/(operations)/sub-project/delete-a-sub-tenant-3.mdx"},{"$id":"(api-reference)/api/(operations)/sub-project/delete-a-sub-tenant-4.mdx","type":"page","name":"$L1eb","description":"$1ec","icon":"$undefined","url":"/api/sub-project/delete-a-sub-tenant-4","$ref":"(api-reference)/api/(operations)/sub-project/delete-a-sub-tenant-4.mdx"}],"$id":"(api-reference)/api/(operations)/sub-project","$ref":{"folder":"(api-reference)/api/(operations)/sub-project","meta":"(api-reference)/api/(operations)/sub-project/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Tenant Authentication","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/tenant-authentication/start-practitioner-login.mdx","type":"page","name":"$L1ed","description":"$1ee","icon":"$undefined","url":"/api/tenant-authentication/start-practitioner-login","$ref":"(api-reference)/api/(operations)/tenant-authentication/start-practitioner-login.mdx"},{"$id":"(api-reference)/api/(operations)/tenant-authentication/exchange-practitioner-session-code-for-tokens.mdx","type":"page","name":"$L1ef","description":"$1f0","icon":"$undefined","url":"/api/tenant-authentication/exchange-practitioner-session-code-for-tokens","$ref":"(api-reference)/api/(operations)/tenant-authentication/exchange-practitioner-session-code-for-tokens.mdx"},{"$id":"(api-reference)/api/(operations)/tenant-authentication/verify-practitioner-mfa-code.mdx","type":"page","name":"$L1f1","description":"Verifies the TOTP code of a practitioner who has MFA enrolled, after `login/start` answered `nextStep: \"mfa\"`. Returns the session code for `login/token` and the list of tenants the practitioner can enter.\n\n**Auth:** none. The `loginId` from `login/start` identifies the login.\n\n## Behaviour\n\n- `mfaToken` must equal the current TOTP code generated from the user's MFA secret.\n- On success the login is marked MFA-verified and the response is `{ \"nextStep\": \"token\", \"sessionCode\": ..., \"profiles\": [...] }`. `profiles` is the same list `login/start` returns without MFA.\n- Pass `sessionCode` and one `tenantCode` from `profiles` to `POST /auth/tenant/Practitioner/login/token`.\n- Error responses are delayed to take at least one second.\n\n## Example\n\n```bash\ncurl -X POST 'https://api.sandbox.ovok.com/auth/tenant/Practitioner/login/mfa' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n    \"loginId\": \"c3499c27-2973-0a7f-807e-fb8676a92dcb\",\n    \"mfaToken\": \"123456\"\n  }'\n```\n","icon":"$undefined","url":"/api/tenant-authentication/verify-practitioner-mfa-code","$ref":"(api-reference)/api/(operations)/tenant-authentication/verify-practitioner-mfa-code.mdx"},{"$id":"(api-reference)/api/(operations)/tenant-authentication/register-a-practitioner.mdx","type":"page","name":"$L1f2","description":"$1f3","icon":"$undefined","url":"/api/tenant-authentication/register-a-practitioner","$ref":"(api-reference)/api/(operations)/tenant-authentication/register-a-practitioner.mdx"},{"$id":"(api-reference)/api/(operations)/tenant-authentication/start-patient-login.mdx","type":"page","name":"$L1f4","description":"$1f5","icon":"$undefined","url":"/api/tenant-authentication/start-patient-login","$ref":"(api-reference)/api/(operations)/tenant-authentication/start-patient-login.mdx"},{"$id":"(api-reference)/api/(operations)/tenant-authentication/exchange-patient-session-code-for-tokens.mdx","type":"page","name":"$L1f6","description":"Finishes a patient login: exchanges the session code from `login/start` (or `login/mfa`) and your PKCE `codeVerifier` for an access token and a refresh token.\n\n**Auth:** none. The session code and code verifier prove the earlier steps.\n\n## Behaviour\n\n- Ovok redeems the code with Medplum's `oauth2/token` endpoint (`grant_type=authorization_code`).\n- The signed-in profile must be a Patient. A code for any other profile type is refused.\n- If the account was scheduled for deletion (`DELETE /auth/delete`), logging in cancels the deletion.\n- The response holds `accessToken`, `refreshToken`, `expiresIn` (seconds) and references to the `project` and `profile`.\n- Error responses are delayed to take at least one second.\n\n## Example\n\n```bash\ncurl -X POST 'https://api.sandbox.ovok.com/auth/tenant/Patient/login/token' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n    \"sessionCode\": \"\",\n    \"codeVerifier\": \"\"\n  }'\n```\n","icon":"$undefined","url":"/api/tenant-authentication/exchange-patient-session-code-for-tokens","$ref":"(api-reference)/api/(operations)/tenant-authentication/exchange-patient-session-code-for-tokens.mdx"},{"$id":"(api-reference)/api/(operations)/tenant-authentication/verify-patient-mfa-code.mdx","type":"page","name":"$L1f7","description":"Verifies the TOTP code of a patient who has MFA enrolled, after `login/start` answered `nextStep: \"mfa\"`. Returns the session code for `login/token`.\n\n**Auth:** none. The `loginId` from `login/start` identifies the login.\n\n## Behaviour\n\n- `mfaToken` must equal the current TOTP code generated from the user's MFA secret.\n- On success the login is marked MFA-verified and the response is `{ \"nextStep\": \"token\", \"sessionCode\": ... }`. Pass `sessionCode` to `POST /auth/tenant/Patient/login/token`.\n- Error responses are delayed to take at least one second.\n\n## Example\n\n```bash\ncurl -X POST 'https://api.sandbox.ovok.com/auth/tenant/Patient/login/mfa' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n    \"loginId\": \"c3499c27-2973-0a7f-807e-fb8676a92dcb\",\n    \"mfaToken\": \"123456\"\n  }'\n```\n","icon":"$undefined","url":"/api/tenant-authentication/verify-patient-mfa-code","$ref":"(api-reference)/api/(operations)/tenant-authentication/verify-patient-mfa-code.mdx"},{"$id":"(api-reference)/api/(operations)/tenant-authentication/register-a-patient.mdx","type":"page","name":"$L1f8","description":"$1f9","icon":"$undefined","url":"/api/tenant-authentication/register-a-patient","$ref":"(api-reference)/api/(operations)/tenant-authentication/register-a-patient.mdx"},{"$id":"(api-reference)/api/(operations)/tenant-authentication/start-related-person-login.mdx","type":"page","name":"$L1fa","description":"$1fb","icon":"$undefined","url":"/api/tenant-authentication/start-related-person-login","$ref":"(api-reference)/api/(operations)/tenant-authentication/start-related-person-login.mdx"},{"$id":"(api-reference)/api/(operations)/tenant-authentication/exchange-related-person-session-code-for-tokens.mdx","type":"page","name":"$L1fc","description":"$1fd","icon":"$undefined","url":"/api/tenant-authentication/exchange-related-person-session-code-for-tokens","$ref":"(api-reference)/api/(operations)/tenant-authentication/exchange-related-person-session-code-for-tokens.mdx"},{"$id":"(api-reference)/api/(operations)/tenant-authentication/verify-related-person-mfa-code.mdx","type":"page","name":"$L1fe","description":"Verifies the TOTP code of a related person (carer) who has MFA enrolled, after `login/start` answered `nextStep: \"mfa\"`. Returns the session code for `login/token`.\n\n**Auth:** none. The `loginId` from `login/start` identifies the login.\n\n## Behaviour\n\n- `mfaToken` must equal the current TOTP code generated from the user's MFA secret.\n- On success the login is marked MFA-verified and the response is `{ \"nextStep\": \"token\", \"sessionCode\": ... }`. Pass `sessionCode` to `POST /auth/tenant/RelatedPerson/login/token`.\n- Error responses are delayed to take at least one second.\n\n## Example\n\n```bash\ncurl -X POST 'https://api.sandbox.ovok.com/auth/tenant/RelatedPerson/login/mfa' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n    \"loginId\": \"c3499c27-2973-0a7f-807e-fb8676a92dcb\",\n    \"mfaToken\": \"123456\"\n  }'\n```\n","icon":"$undefined","url":"/api/tenant-authentication/verify-related-person-mfa-code","$ref":"(api-reference)/api/(operations)/tenant-authentication/verify-related-person-mfa-code.mdx"}],"$id":"(api-reference)/api/(operations)/tenant-authentication","$ref":{"folder":"(api-reference)/api/(operations)/tenant-authentication","meta":"(api-reference)/api/(operations)/tenant-authentication/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Video Call","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/video-call/fetch-user-s-video-call-access-permission.mdx","type":"page","name":"$L1ff","description":"Returns the video call access permission of the signed-in user for one Appointment. Use it to check whether the user has been invited before you request a join link.\n\n**Auth:** bearer token.\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- The permission is the `CommunicationRequest` that links the Appointment to the user's profile as recipient. The route returns it without its `meta`.\n- If there is no such grant for the caller's profile, the route returns 403.\n- The lookup uses the caller's own profile reference (for example `Patient/`), so a user only ever sees their own permission.\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/video-call/livekit/access-permission/c3499c27-2973-0a7f-807e-fb8676a92dcb' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/video-call/fetch-user-s-video-call-access-permission","$ref":"(api-reference)/api/(operations)/video-call/fetch-user-s-video-call-access-permission.mdx"},{"$id":"(api-reference)/api/(operations)/video-call/create-video-call-guest-access.mdx","type":"page","name":"$L200","description":"$201","icon":"$undefined","url":"/api/video-call/create-video-call-guest-access","$ref":"(api-reference)/api/(operations)/video-call/create-video-call-guest-access.mdx"},{"$id":"(api-reference)/api/(operations)/video-call/create-video-call-ovok-user-access.mdx","type":"page","name":"$L202","description":"$203","icon":"$undefined","url":"/api/video-call/create-video-call-ovok-user-access","$ref":"(api-reference)/api/(operations)/video-call/create-video-call-ovok-user-access.mdx"},{"$id":"(api-reference)/api/(operations)/video-call/fetch-user-s-video-call-appointments.mdx","type":"page","name":"$L204","description":"$205","icon":"$undefined","url":"/api/video-call/fetch-user-s-video-call-appointments","$ref":"(api-reference)/api/(operations)/video-call/fetch-user-s-video-call-appointments.mdx"},{"$id":"(api-reference)/api/(operations)/video-call/create-video-call-appointment.mdx","type":"page","name":"$L206","description":"$207","icon":"$undefined","url":"/api/video-call/create-video-call-appointment","$ref":"(api-reference)/api/(operations)/video-call/create-video-call-appointment.mdx"},{"$id":"(api-reference)/api/(operations)/video-call/update-video-call-appointment.mdx","type":"page","name":"$L208","description":"$209","icon":"$undefined","url":"/api/video-call/update-video-call-appointment","$ref":"(api-reference)/api/(operations)/video-call/update-video-call-appointment.mdx"},{"$id":"(api-reference)/api/(operations)/video-call/send-emails-video-call-invitation.mdx","type":"page","name":"$L20a","description":"$20b","icon":"$undefined","url":"/api/video-call/send-emails-video-call-invitation","$ref":"(api-reference)/api/(operations)/video-call/send-emails-video-call-invitation.mdx"},{"$id":"(api-reference)/api/(operations)/video-call/send-emails-video-call-update.mdx","type":"page","name":"$L20c","description":"$20d","icon":"$undefined","url":"/api/video-call/send-emails-video-call-update","$ref":"(api-reference)/api/(operations)/video-call/send-emails-video-call-update.mdx"},{"$id":"(api-reference)/api/(operations)/video-call/send-emails-video-call-cancellation.mdx","type":"page","name":"$L20e","description":"$20f","icon":"$undefined","url":"/api/video-call/send-emails-video-call-cancellation","$ref":"(api-reference)/api/(operations)/video-call/send-emails-video-call-cancellation.mdx"},{"$id":"(api-reference)/api/(operations)/video-call/send-notifications-to-video-call-participants.mdx","type":"page","name":"$L210","description":"$211","icon":"$undefined","url":"/api/video-call/send-notifications-to-video-call-participants","$ref":"(api-reference)/api/(operations)/video-call/send-notifications-to-video-call-participants.mdx"}],"$id":"(api-reference)/api/(operations)/video-call","$ref":{"folder":"(api-reference)/api/(operations)/video-call","meta":"(api-reference)/api/(operations)/video-call/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Wearables","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(api-reference)/api/(operations)/wearables/list-the-project-s-wearable-providers.mdx","type":"page","name":"$L212","description":"$213","icon":"$undefined","url":"/api/wearables/list-the-project-s-wearable-providers","$ref":"(api-reference)/api/(operations)/wearables/list-the-project-s-wearable-providers.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/set-up-a-wearable-provider.mdx","type":"page","name":"$L214","description":"$215","icon":"$undefined","url":"/api/wearables/set-up-a-wearable-provider","$ref":"(api-reference)/api/(operations)/wearables/set-up-a-wearable-provider.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/get-a-wearable-provider.mdx","type":"page","name":"$L216","description":"Returns one wearable provider of your current project, set up or not, in the shape of `GET /v1/wearables/providers`. It never returns a secret.\n\n**Auth:** bearer token of a project admin.\n**Scope:** the caller's project (from the token).\n\n## Example\n\n```bash\ncurl -X GET 'https://api.sandbox.ovok.com/v1/wearables/providers/oura' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/wearables/get-a-wearable-provider","$ref":"(api-reference)/api/(operations)/wearables/get-a-wearable-provider.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/change-a-wearable-provider.mdx","type":"page","name":"$L217","description":"$218","icon":"$undefined","url":"/api/wearables/change-a-wearable-provider","$ref":"(api-reference)/api/(operations)/wearables/change-a-wearable-provider.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/remove-a-wearable-provider.mdx","type":"page","name":"$L219","description":"Removes your project's credentials for a wearable provider.\n\n**Auth:** bearer token of a project admin.\n**Scope:** the caller's project (from the token).\n\n## Behaviour\n\n- Patients can no longer connect the provider.\n- Patients already connected keep their connection until they disconnect it.\n- For Polar, ovok also deletes the client's webhook at Polar when it points at this project's `webhookUrl`; a webhook pointing anywhere else is left alone. Should that fail, the credentials are removed all the same.\n- A provider not set up answers `404 PROVIDER_NOT_CONFIGURED`.\n\n## Example\n\n```bash\ncurl -X DELETE 'https://api.sandbox.ovok.com/v1/wearables/providers/oura' \\\n  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'\n```\n","icon":"$undefined","url":"/api/wearables/remove-a-wearable-provider","$ref":"(api-reference)/api/(operations)/wearables/remove-a-wearable-provider.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/list-the-patient-s-wearable-connections.mdx","type":"page","name":"$L21a","description":"$21b","icon":"$undefined","url":"/api/wearables/list-the-patient-s-wearable-connections","$ref":"(api-reference)/api/(operations)/wearables/list-the-patient-s-wearable-connections.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/start-connecting-a-wearable-provider.mdx","type":"page","name":"$L21c","description":"$21d","icon":"$undefined","url":"/api/wearables/start-connecting-a-wearable-provider","$ref":"(api-reference)/api/(operations)/wearables/start-connecting-a-wearable-provider.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/sync-a-connected-wearable-provider-now.mdx","type":"page","name":"$L21e","description":"$21f","icon":"$undefined","url":"/api/wearables/sync-a-connected-wearable-provider-now","$ref":"(api-reference)/api/(operations)/wearables/sync-a-connected-wearable-provider-now.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/disconnect-a-wearable-provider.mdx","type":"page","name":"$L220","description":"$221","icon":"$undefined","url":"/api/wearables/disconnect-a-wearable-provider","$ref":"(api-reference)/api/(operations)/wearables/disconnect-a-wearable-provider.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/wearable-provider-oauth-callback.mdx","type":"page","name":"$L222","description":"$223","icon":"$undefined","url":"/api/wearables/wearable-provider-oauth-callback","$ref":"(api-reference)/api/(operations)/wearables/wearable-provider-oauth-callback.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/receive-a-signed-wearable-provider-notification.mdx","type":"page","name":"$L224","description":"$225","icon":"$undefined","url":"/api/wearables/receive-a-signed-wearable-provider-notification","$ref":"(api-reference)/api/(operations)/wearables/receive-a-signed-wearable-provider-notification.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/check-a-wearable-webhook-url.mdx","type":"page","name":"$L226","description":"Answers whether a webhook URL is live, for a provider that checks it before it sends notifications (Withings does). You never call it yourself.\n\n**Auth:** none. A token at the end of the URL is not checked here.\n**Scope:** the project in the path.\n\n## Answers\n\n- `200` with no body when the project has set up and switched on the provider, and ovok takes notifications from it.\n- Otherwise the same `404` and `422` answers as `POST` on the same URL.\n","icon":"$undefined","url":"/api/wearables/check-a-wearable-webhook-url","$ref":"(api-reference)/api/(operations)/wearables/check-a-wearable-webhook-url.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/receive-a-wearable-provider-notification-by-url-token.mdx","type":"page","name":"$L227","description":"$228","icon":"$undefined","url":"/api/wearables/receive-a-wearable-provider-notification-by-url-token","$ref":"(api-reference)/api/(operations)/wearables/receive-a-wearable-provider-notification-by-url-token.mdx"},{"$id":"(api-reference)/api/(operations)/wearables/check-a-wearable-webhook-url-with-a-token.mdx","type":"page","name":"$L229","description":"Answers whether a webhook URL is live, for a provider that checks it before it sends notifications (Withings does). You never call it yourself.\n\n**Auth:** none. A token at the end of the URL is not checked here.\n**Scope:** the project in the path.\n\n## Answers\n\n- `200` with no body when the project has set up and switched on the provider, and ovok takes notifications from it.\n- Otherwise the same `404` and `422` answers as `POST` on the same URL.\n","icon":"$undefined","url":"/api/wearables/check-a-wearable-webhook-url-with-a-token","$ref":"(api-reference)/api/(operations)/wearables/check-a-wearable-webhook-url-with-a-token.mdx"}],"$id":"(api-reference)/api/(operations)/wearables","$ref":{"folder":"(api-reference)/api/(operations)/wearables","meta":"(api-reference)/api/(operations)/wearables/meta.json"},"icon":"$undefined"},{"$id":"_51","type":"separator","icon":"$undefined","name":"FHIR R4"},{"$id":"(api-reference)/api/fhir/index.mdx","type":"page","name":"FHIR API","description":"Read and write your project's FHIR R4 data through Ovok, with project-scoped bearer tokens, standard FHIR interactions and Ovok's own operations.","icon":"$undefined","url":"/api/fhir","$ref":"(api-reference)/api/fhir/index.mdx"},{"$id":"(api-reference)/api/fhir/r4/index.mdx","type":"page","name":"FHIR resources","description":"Detailed FHIR R4 resource reference for structure, interactions, search, and maturity.","icon":"$undefined","url":"/api/fhir/r4","$ref":"(api-reference)/api/fhir/r4/index.mdx"},{"$id":"(api-reference)/api/fhir/r4/account.mdx","type":"page","name":"Account","description":"A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.","icon":"$undefined","url":"/api/fhir/r4/account","$ref":"(api-reference)/api/fhir/r4/account.mdx"},{"$id":"(api-reference)/api/fhir/r4/activity-definition.mdx","type":"page","name":"ActivityDefinition","description":"This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.","icon":"$undefined","url":"/api/fhir/r4/activity-definition","$ref":"(api-reference)/api/fhir/r4/activity-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/adverse-event.mdx","type":"page","name":"AdverseEvent","description":"Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that re","icon":"$undefined","url":"/api/fhir/r4/adverse-event","$ref":"(api-reference)/api/fhir/r4/adverse-event.mdx"},{"$id":"(api-reference)/api/fhir/r4/allergy-intolerance.mdx","type":"page","name":"AllergyIntolerance","description":"Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.","icon":"$undefined","url":"/api/fhir/r4/allergy-intolerance","$ref":"(api-reference)/api/fhir/r4/allergy-intolerance.mdx"},{"$id":"(api-reference)/api/fhir/r4/appointment-response.mdx","type":"page","name":"AppointmentResponse","description":"A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.","icon":"$undefined","url":"/api/fhir/r4/appointment-response","$ref":"(api-reference)/api/fhir/r4/appointment-response.mdx"},{"$id":"(api-reference)/api/fhir/r4/appointment.mdx","type":"page","name":"Appointment","description":"A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).","icon":"$undefined","url":"/api/fhir/r4/appointment","$ref":"(api-reference)/api/fhir/r4/appointment.mdx"},{"$id":"(api-reference)/api/fhir/r4/audit-event.mdx","type":"page","name":"AuditEvent","description":"A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.","icon":"$undefined","url":"/api/fhir/r4/audit-event","$ref":"(api-reference)/api/fhir/r4/audit-event.mdx"},{"$id":"(api-reference)/api/fhir/r4/basic.mdx","type":"page","name":"Basic","description":"Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.","icon":"$undefined","url":"/api/fhir/r4/basic","$ref":"(api-reference)/api/fhir/r4/basic.mdx"},{"$id":"(api-reference)/api/fhir/r4/binary.mdx","type":"page","name":"Binary","description":"A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.","icon":"$undefined","url":"/api/fhir/r4/binary","$ref":"(api-reference)/api/fhir/r4/binary.mdx"},{"$id":"(api-reference)/api/fhir/r4/biologically-derived-product.mdx","type":"page","name":"BiologicallyDerivedProduct","description":"A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.","icon":"$undefined","url":"/api/fhir/r4/biologically-derived-product","$ref":"(api-reference)/api/fhir/r4/biologically-derived-product.mdx"},{"$id":"(api-reference)/api/fhir/r4/body-structure.mdx","type":"page","name":"BodyStructure","description":"Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.","icon":"$undefined","url":"/api/fhir/r4/body-structure","$ref":"(api-reference)/api/fhir/r4/body-structure.mdx"},{"$id":"(api-reference)/api/fhir/r4/bundle.mdx","type":"page","name":"Bundle","description":"A container for a collection of resources.","icon":"$undefined","url":"/api/fhir/r4/bundle","$ref":"(api-reference)/api/fhir/r4/bundle.mdx"},{"$id":"(api-reference)/api/fhir/r4/capability-statement.mdx","type":"page","name":"CapabilityStatement","description":"A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.","icon":"$undefined","url":"/api/fhir/r4/capability-statement","$ref":"(api-reference)/api/fhir/r4/capability-statement.mdx"},{"$id":"(api-reference)/api/fhir/r4/care-plan.mdx","type":"page","name":"CarePlan","description":"Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.","icon":"$undefined","url":"/api/fhir/r4/care-plan","$ref":"(api-reference)/api/fhir/r4/care-plan.mdx"},{"$id":"(api-reference)/api/fhir/r4/care-team.mdx","type":"page","name":"CareTeam","description":"The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.","icon":"$undefined","url":"/api/fhir/r4/care-team","$ref":"(api-reference)/api/fhir/r4/care-team.mdx"},{"$id":"(api-reference)/api/fhir/r4/catalog-entry.mdx","type":"page","name":"CatalogEntry","description":"Catalog entries are wrappers that contextualize items included in a catalog.","icon":"$undefined","url":"/api/fhir/r4/catalog-entry","$ref":"(api-reference)/api/fhir/r4/catalog-entry.mdx"},{"$id":"(api-reference)/api/fhir/r4/charge-item-definition.mdx","type":"page","name":"ChargeItemDefinition","description":"The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure a","icon":"$undefined","url":"/api/fhir/r4/charge-item-definition","$ref":"(api-reference)/api/fhir/r4/charge-item-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/charge-item.mdx","type":"page","name":"ChargeItem","description":"The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organi","icon":"$undefined","url":"/api/fhir/r4/charge-item","$ref":"(api-reference)/api/fhir/r4/charge-item.mdx"},{"$id":"(api-reference)/api/fhir/r4/claim-response.mdx","type":"page","name":"ClaimResponse","description":"This resource provides the adjudication details from the processing of a Claim resource.","icon":"$undefined","url":"/api/fhir/r4/claim-response","$ref":"(api-reference)/api/fhir/r4/claim-response.mdx"},{"$id":"(api-reference)/api/fhir/r4/claim.mdx","type":"page","name":"Claim","description":"A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.","icon":"$undefined","url":"/api/fhir/r4/claim","$ref":"(api-reference)/api/fhir/r4/claim.mdx"},{"$id":"(api-reference)/api/fhir/r4/clinical-impression.mdx","type":"page","name":"ClinicalImpression","description":"A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consu","icon":"$undefined","url":"/api/fhir/r4/clinical-impression","$ref":"(api-reference)/api/fhir/r4/clinical-impression.mdx"},{"$id":"(api-reference)/api/fhir/r4/code-system.mdx","type":"page","name":"CodeSystem","description":"The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.","icon":"$undefined","url":"/api/fhir/r4/code-system","$ref":"(api-reference)/api/fhir/r4/code-system.mdx"},{"$id":"(api-reference)/api/fhir/r4/communication-request.mdx","type":"page","name":"CommunicationRequest","description":"A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.","icon":"$undefined","url":"/api/fhir/r4/communication-request","$ref":"(api-reference)/api/fhir/r4/communication-request.mdx"},{"$id":"(api-reference)/api/fhir/r4/communication.mdx","type":"page","name":"Communication","description":"An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.","icon":"$undefined","url":"/api/fhir/r4/communication","$ref":"(api-reference)/api/fhir/r4/communication.mdx"},{"$id":"(api-reference)/api/fhir/r4/compartment-definition.mdx","type":"page","name":"CompartmentDefinition","description":"A compartment definition that defines how resources are accessed on a server.","icon":"$undefined","url":"/api/fhir/r4/compartment-definition","$ref":"(api-reference)/api/fhir/r4/compartment-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/composition.mdx","type":"page","name":"Composition","description":"A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the stat","icon":"$undefined","url":"/api/fhir/r4/composition","$ref":"(api-reference)/api/fhir/r4/composition.mdx"},{"$id":"(api-reference)/api/fhir/r4/concept-map.mdx","type":"page","name":"ConceptMap","description":"A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.","icon":"$undefined","url":"/api/fhir/r4/concept-map","$ref":"(api-reference)/api/fhir/r4/concept-map.mdx"},{"$id":"(api-reference)/api/fhir/r4/condition.mdx","type":"page","name":"Condition","description":"A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.","icon":"$undefined","url":"/api/fhir/r4/condition","$ref":"(api-reference)/api/fhir/r4/condition.mdx"},{"$id":"(api-reference)/api/fhir/r4/consent.mdx","type":"page","name":"Consent","description":"A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.","icon":"$undefined","url":"/api/fhir/r4/consent","$ref":"(api-reference)/api/fhir/r4/consent.mdx"},{"$id":"(api-reference)/api/fhir/r4/contract.mdx","type":"page","name":"Contract","description":"Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.","icon":"$undefined","url":"/api/fhir/r4/contract","$ref":"(api-reference)/api/fhir/r4/contract.mdx"},{"$id":"(api-reference)/api/fhir/r4/coverage-eligibility-request.mdx","type":"page","name":"CoverageEligibilityRequest","description":"The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and opti","icon":"$undefined","url":"/api/fhir/r4/coverage-eligibility-request","$ref":"(api-reference)/api/fhir/r4/coverage-eligibility-request.mdx"},{"$id":"(api-reference)/api/fhir/r4/coverage-eligibility-response.mdx","type":"page","name":"CoverageEligibilityResponse","description":"This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.","icon":"$undefined","url":"/api/fhir/r4/coverage-eligibility-response","$ref":"(api-reference)/api/fhir/r4/coverage-eligibility-response.mdx"},{"$id":"(api-reference)/api/fhir/r4/coverage.mdx","type":"page","name":"Coverage","description":"Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.","icon":"$undefined","url":"/api/fhir/r4/coverage","$ref":"(api-reference)/api/fhir/r4/coverage.mdx"},{"$id":"(api-reference)/api/fhir/r4/detected-issue.mdx","type":"page","name":"DetectedIssue","description":"Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.","icon":"$undefined","url":"/api/fhir/r4/detected-issue","$ref":"(api-reference)/api/fhir/r4/detected-issue.mdx"},{"$id":"(api-reference)/api/fhir/r4/device-definition.mdx","type":"page","name":"DeviceDefinition","description":"The characteristics, operational status and capabilities of a medical-related component of a medical device.","icon":"$undefined","url":"/api/fhir/r4/device-definition","$ref":"(api-reference)/api/fhir/r4/device-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/device-metric.mdx","type":"page","name":"DeviceMetric","description":"Describes a measurement, calculation or setting capability of a medical device.","icon":"$undefined","url":"/api/fhir/r4/device-metric","$ref":"(api-reference)/api/fhir/r4/device-metric.mdx"},{"$id":"(api-reference)/api/fhir/r4/device-request.mdx","type":"page","name":"DeviceRequest","description":"Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.","icon":"$undefined","url":"/api/fhir/r4/device-request","$ref":"(api-reference)/api/fhir/r4/device-request.mdx"},{"$id":"(api-reference)/api/fhir/r4/device-use-statement.mdx","type":"page","name":"DeviceUseStatement","description":"A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.","icon":"$undefined","url":"/api/fhir/r4/device-use-statement","$ref":"(api-reference)/api/fhir/r4/device-use-statement.mdx"},{"$id":"(api-reference)/api/fhir/r4/device.mdx","type":"page","name":"Device","description":"A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.","icon":"$undefined","url":"/api/fhir/r4/device","$ref":"(api-reference)/api/fhir/r4/device.mdx"},{"$id":"(api-reference)/api/fhir/r4/diagnostic-report.mdx","type":"page","name":"DiagnosticReport","description":"The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix","icon":"$undefined","url":"/api/fhir/r4/diagnostic-report","$ref":"(api-reference)/api/fhir/r4/diagnostic-report.mdx"},{"$id":"(api-reference)/api/fhir/r4/document-manifest.mdx","type":"page","name":"DocumentManifest","description":"A collection of documents compiled for a purpose together with metadata that applies to the collection.","icon":"$undefined","url":"/api/fhir/r4/document-manifest","$ref":"(api-reference)/api/fhir/r4/document-manifest.mdx"},{"$id":"(api-reference)/api/fhir/r4/document-reference.mdx","type":"page","name":"DocumentReference","description":"A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric docum","icon":"$undefined","url":"/api/fhir/r4/document-reference","$ref":"(api-reference)/api/fhir/r4/document-reference.mdx"},{"$id":"(api-reference)/api/fhir/r4/effect-evidence-synthesis.mdx","type":"page","name":"EffectEvidenceSynthesis","description":"The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.","icon":"$undefined","url":"/api/fhir/r4/effect-evidence-synthesis","$ref":"(api-reference)/api/fhir/r4/effect-evidence-synthesis.mdx"},{"$id":"(api-reference)/api/fhir/r4/encounter.mdx","type":"page","name":"Encounter","description":"An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.","icon":"$undefined","url":"/api/fhir/r4/encounter","$ref":"(api-reference)/api/fhir/r4/encounter.mdx"},{"$id":"(api-reference)/api/fhir/r4/endpoint.mdx","type":"page","name":"Endpoint","description":"The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.","icon":"$undefined","url":"/api/fhir/r4/endpoint","$ref":"(api-reference)/api/fhir/r4/endpoint.mdx"},{"$id":"(api-reference)/api/fhir/r4/enrollment-request.mdx","type":"page","name":"EnrollmentRequest","description":"This resource provides the insurance enrollment details to the insurer regarding a specified coverage.","icon":"$undefined","url":"/api/fhir/r4/enrollment-request","$ref":"(api-reference)/api/fhir/r4/enrollment-request.mdx"},{"$id":"(api-reference)/api/fhir/r4/enrollment-response.mdx","type":"page","name":"EnrollmentResponse","description":"This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.","icon":"$undefined","url":"/api/fhir/r4/enrollment-response","$ref":"(api-reference)/api/fhir/r4/enrollment-response.mdx"},{"$id":"(api-reference)/api/fhir/r4/episode-of-care.mdx","type":"page","name":"EpisodeOfCare","description":"An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.","icon":"$undefined","url":"/api/fhir/r4/episode-of-care","$ref":"(api-reference)/api/fhir/r4/episode-of-care.mdx"},{"$id":"(api-reference)/api/fhir/r4/event-definition.mdx","type":"page","name":"EventDefinition","description":"The EventDefinition resource provides a reusable description of when a particular event can occur.","icon":"$undefined","url":"/api/fhir/r4/event-definition","$ref":"(api-reference)/api/fhir/r4/event-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/evidence-variable.mdx","type":"page","name":"EvidenceVariable","description":"The EvidenceVariable resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.","icon":"$undefined","url":"/api/fhir/r4/evidence-variable","$ref":"(api-reference)/api/fhir/r4/evidence-variable.mdx"},{"$id":"(api-reference)/api/fhir/r4/evidence.mdx","type":"page","name":"Evidence","description":"The Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.","icon":"$undefined","url":"/api/fhir/r4/evidence","$ref":"(api-reference)/api/fhir/r4/evidence.mdx"},{"$id":"(api-reference)/api/fhir/r4/example-scenario.mdx","type":"page","name":"ExampleScenario","description":"Example of workflow instance.","icon":"$undefined","url":"/api/fhir/r4/example-scenario","$ref":"(api-reference)/api/fhir/r4/example-scenario.mdx"},{"$id":"(api-reference)/api/fhir/r4/explanation-of-benefit.mdx","type":"page","name":"ExplanationOfBenefit","description":"This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.","icon":"$undefined","url":"/api/fhir/r4/explanation-of-benefit","$ref":"(api-reference)/api/fhir/r4/explanation-of-benefit.mdx"},{"$id":"(api-reference)/api/fhir/r4/family-member-history.mdx","type":"page","name":"FamilyMemberHistory","description":"Significant health conditions for a person related to the patient relevant in the context of care for the patient.","icon":"$undefined","url":"/api/fhir/r4/family-member-history","$ref":"(api-reference)/api/fhir/r4/family-member-history.mdx"},{"$id":"(api-reference)/api/fhir/r4/flag.mdx","type":"page","name":"Flag","description":"Prospective warnings of potential issues when providing care to the patient.","icon":"$undefined","url":"/api/fhir/r4/flag","$ref":"(api-reference)/api/fhir/r4/flag.mdx"},{"$id":"(api-reference)/api/fhir/r4/goal.mdx","type":"page","name":"Goal","description":"Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.","icon":"$undefined","url":"/api/fhir/r4/goal","$ref":"(api-reference)/api/fhir/r4/goal.mdx"},{"$id":"(api-reference)/api/fhir/r4/graph-definition.mdx","type":"page","name":"GraphDefinition","description":"A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.","icon":"$undefined","url":"/api/fhir/r4/graph-definition","$ref":"(api-reference)/api/fhir/r4/graph-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/group.mdx","type":"page","name":"Group","description":"Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.","icon":"$undefined","url":"/api/fhir/r4/group","$ref":"(api-reference)/api/fhir/r4/group.mdx"},{"$id":"(api-reference)/api/fhir/r4/guidance-response.mdx","type":"page","name":"GuidanceResponse","description":"A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.","icon":"$undefined","url":"/api/fhir/r4/guidance-response","$ref":"(api-reference)/api/fhir/r4/guidance-response.mdx"},{"$id":"(api-reference)/api/fhir/r4/healthcare-service.mdx","type":"page","name":"HealthcareService","description":"The details of a healthcare service available at a location.","icon":"$undefined","url":"/api/fhir/r4/healthcare-service","$ref":"(api-reference)/api/fhir/r4/healthcare-service.mdx"},{"$id":"(api-reference)/api/fhir/r4/imaging-study.mdx","type":"page","name":"ImagingStudy","description":"Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A serie","icon":"$undefined","url":"/api/fhir/r4/imaging-study","$ref":"(api-reference)/api/fhir/r4/imaging-study.mdx"},{"$id":"(api-reference)/api/fhir/r4/immunization-evaluation.mdx","type":"page","name":"ImmunizationEvaluation","description":"Describes a comparison of an immunization event against published recommendations to determine if the administration is \"valid\" in relation to those recommendations.","icon":"$undefined","url":"/api/fhir/r4/immunization-evaluation","$ref":"(api-reference)/api/fhir/r4/immunization-evaluation.mdx"},{"$id":"(api-reference)/api/fhir/r4/immunization-recommendation.mdx","type":"page","name":"ImmunizationRecommendation","description":"A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.","icon":"$undefined","url":"/api/fhir/r4/immunization-recommendation","$ref":"(api-reference)/api/fhir/r4/immunization-recommendation.mdx"},{"$id":"(api-reference)/api/fhir/r4/immunization.mdx","type":"page","name":"Immunization","description":"Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.","icon":"$undefined","url":"/api/fhir/r4/immunization","$ref":"(api-reference)/api/fhir/r4/immunization.mdx"},{"$id":"(api-reference)/api/fhir/r4/implementation-guide.mdx","type":"page","name":"ImplementationGuide","description":"A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computabl","icon":"$undefined","url":"/api/fhir/r4/implementation-guide","$ref":"(api-reference)/api/fhir/r4/implementation-guide.mdx"},{"$id":"(api-reference)/api/fhir/r4/insurance-plan.mdx","type":"page","name":"InsurancePlan","description":"Details of a Health Insurance product/plan provided by an organization.","icon":"$undefined","url":"/api/fhir/r4/insurance-plan","$ref":"(api-reference)/api/fhir/r4/insurance-plan.mdx"},{"$id":"(api-reference)/api/fhir/r4/invoice.mdx","type":"page","name":"Invoice","description":"Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.","icon":"$undefined","url":"/api/fhir/r4/invoice","$ref":"(api-reference)/api/fhir/r4/invoice.mdx"},{"$id":"(api-reference)/api/fhir/r4/library.mdx","type":"page","name":"Library","description":"The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of kn","icon":"$undefined","url":"/api/fhir/r4/library","$ref":"(api-reference)/api/fhir/r4/library.mdx"},{"$id":"(api-reference)/api/fhir/r4/linkage.mdx","type":"page","name":"Linkage","description":"Identifies two or more records (resource instances) that refer to the same real-world \"occurrence\".","icon":"$undefined","url":"/api/fhir/r4/linkage","$ref":"(api-reference)/api/fhir/r4/linkage.mdx"},{"$id":"(api-reference)/api/fhir/r4/list.mdx","type":"page","name":"List","description":"A list is a curated collection of resources.","icon":"$undefined","url":"/api/fhir/r4/list","$ref":"(api-reference)/api/fhir/r4/list.mdx"},{"$id":"(api-reference)/api/fhir/r4/location.mdx","type":"page","name":"Location","description":"Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.","icon":"$undefined","url":"/api/fhir/r4/location","$ref":"(api-reference)/api/fhir/r4/location.mdx"},{"$id":"(api-reference)/api/fhir/r4/measure-report.mdx","type":"page","name":"MeasureReport","description":"The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.","icon":"$undefined","url":"/api/fhir/r4/measure-report","$ref":"(api-reference)/api/fhir/r4/measure-report.mdx"},{"$id":"(api-reference)/api/fhir/r4/measure.mdx","type":"page","name":"Measure","description":"The Measure resource provides the definition of a quality measure.","icon":"$undefined","url":"/api/fhir/r4/measure","$ref":"(api-reference)/api/fhir/r4/measure.mdx"},{"$id":"(api-reference)/api/fhir/r4/media.mdx","type":"page","name":"Media","description":"A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.","icon":"$undefined","url":"/api/fhir/r4/media","$ref":"(api-reference)/api/fhir/r4/media.mdx"},{"$id":"(api-reference)/api/fhir/r4/medication-administration.mdx","type":"page","name":"MedicationAdministration","description":"Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the spec","icon":"$undefined","url":"/api/fhir/r4/medication-administration","$ref":"(api-reference)/api/fhir/r4/medication-administration.mdx"},{"$id":"(api-reference)/api/fhir/r4/medication-dispense.mdx","type":"page","name":"MedicationDispense","description":"Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is t","icon":"$undefined","url":"/api/fhir/r4/medication-dispense","$ref":"(api-reference)/api/fhir/r4/medication-dispense.mdx"},{"$id":"(api-reference)/api/fhir/r4/medication-knowledge.mdx","type":"page","name":"MedicationKnowledge","description":"Information about a medication that is used to support knowledge.","icon":"$undefined","url":"/api/fhir/r4/medication-knowledge","$ref":"(api-reference)/api/fhir/r4/medication-knowledge.mdx"},{"$id":"(api-reference)/api/fhir/r4/medication-request.mdx","type":"page","name":"MedicationRequest","description":"An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use a","icon":"$undefined","url":"/api/fhir/r4/medication-request","$ref":"(api-reference)/api/fhir/r4/medication-request.mdx"},{"$id":"(api-reference)/api/fhir/r4/medication-statement.mdx","type":"page","name":"MedicationStatement","description":"A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of t","icon":"$undefined","url":"/api/fhir/r4/medication-statement","$ref":"(api-reference)/api/fhir/r4/medication-statement.mdx"},{"$id":"(api-reference)/api/fhir/r4/medication.mdx","type":"page","name":"Medication","description":"This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.","icon":"$undefined","url":"/api/fhir/r4/medication","$ref":"(api-reference)/api/fhir/r4/medication.mdx"},{"$id":"(api-reference)/api/fhir/r4/medicinal-product-authorization.mdx","type":"page","name":"MedicinalProductAuthorization","description":"The regulatory authorization of a medicinal product.","icon":"$undefined","url":"/api/fhir/r4/medicinal-product-authorization","$ref":"(api-reference)/api/fhir/r4/medicinal-product-authorization.mdx"},{"$id":"(api-reference)/api/fhir/r4/medicinal-product-contraindication.mdx","type":"page","name":"MedicinalProductContraindication","description":"The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.","icon":"$undefined","url":"/api/fhir/r4/medicinal-product-contraindication","$ref":"(api-reference)/api/fhir/r4/medicinal-product-contraindication.mdx"},{"$id":"(api-reference)/api/fhir/r4/medicinal-product-indication.mdx","type":"page","name":"MedicinalProductIndication","description":"Indication for the Medicinal Product.","icon":"$undefined","url":"/api/fhir/r4/medicinal-product-indication","$ref":"(api-reference)/api/fhir/r4/medicinal-product-indication.mdx"},{"$id":"(api-reference)/api/fhir/r4/medicinal-product-ingredient.mdx","type":"page","name":"MedicinalProductIngredient","description":"An ingredient of a manufactured item or pharmaceutical product.","icon":"$undefined","url":"/api/fhir/r4/medicinal-product-ingredient","$ref":"(api-reference)/api/fhir/r4/medicinal-product-ingredient.mdx"},{"$id":"(api-reference)/api/fhir/r4/medicinal-product-interaction.mdx","type":"page","name":"MedicinalProductInteraction","description":"The interactions of the medicinal product with other medicinal products, or other forms of interactions.","icon":"$undefined","url":"/api/fhir/r4/medicinal-product-interaction","$ref":"(api-reference)/api/fhir/r4/medicinal-product-interaction.mdx"},{"$id":"(api-reference)/api/fhir/r4/medicinal-product-manufactured.mdx","type":"page","name":"MedicinalProductManufactured","description":"The manufactured item as contained in the packaged medicinal product.","icon":"$undefined","url":"/api/fhir/r4/medicinal-product-manufactured","$ref":"(api-reference)/api/fhir/r4/medicinal-product-manufactured.mdx"},{"$id":"(api-reference)/api/fhir/r4/medicinal-product-packaged.mdx","type":"page","name":"MedicinalProductPackaged","description":"A medicinal product in a container or package.","icon":"$undefined","url":"/api/fhir/r4/medicinal-product-packaged","$ref":"(api-reference)/api/fhir/r4/medicinal-product-packaged.mdx"},{"$id":"(api-reference)/api/fhir/r4/medicinal-product-pharmaceutical.mdx","type":"page","name":"MedicinalProductPharmaceutical","description":"A pharmaceutical product described in terms of its composition and dose form.","icon":"$undefined","url":"/api/fhir/r4/medicinal-product-pharmaceutical","$ref":"(api-reference)/api/fhir/r4/medicinal-product-pharmaceutical.mdx"},{"$id":"(api-reference)/api/fhir/r4/medicinal-product-undesirable-effect.mdx","type":"page","name":"MedicinalProductUndesirableEffect","description":"Describe the undesirable effects of the medicinal product.","icon":"$undefined","url":"/api/fhir/r4/medicinal-product-undesirable-effect","$ref":"(api-reference)/api/fhir/r4/medicinal-product-undesirable-effect.mdx"},{"$id":"(api-reference)/api/fhir/r4/medicinal-product.mdx","type":"page","name":"MedicinalProduct","description":"Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).","icon":"$undefined","url":"/api/fhir/r4/medicinal-product","$ref":"(api-reference)/api/fhir/r4/medicinal-product.mdx"},{"$id":"(api-reference)/api/fhir/r4/message-definition.mdx","type":"page","name":"MessageDefinition","description":"Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.","icon":"$undefined","url":"/api/fhir/r4/message-definition","$ref":"(api-reference)/api/fhir/r4/message-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/message-header.mdx","type":"page","name":"MessageHeader","description":"The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageH","icon":"$undefined","url":"/api/fhir/r4/message-header","$ref":"(api-reference)/api/fhir/r4/message-header.mdx"},{"$id":"(api-reference)/api/fhir/r4/molecular-sequence.mdx","type":"page","name":"MolecularSequence","description":"Raw data describing a biological sequence.","icon":"$undefined","url":"/api/fhir/r4/molecular-sequence","$ref":"(api-reference)/api/fhir/r4/molecular-sequence.mdx"},{"$id":"(api-reference)/api/fhir/r4/naming-system.mdx","type":"page","name":"NamingSystem","description":"A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.","icon":"$undefined","url":"/api/fhir/r4/naming-system","$ref":"(api-reference)/api/fhir/r4/naming-system.mdx"},{"$id":"(api-reference)/api/fhir/r4/nutrition-order.mdx","type":"page","name":"NutritionOrder","description":"A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.","icon":"$undefined","url":"/api/fhir/r4/nutrition-order","$ref":"(api-reference)/api/fhir/r4/nutrition-order.mdx"},{"$id":"(api-reference)/api/fhir/r4/observation-definition.mdx","type":"page","name":"ObservationDefinition","description":"Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.","icon":"$undefined","url":"/api/fhir/r4/observation-definition","$ref":"(api-reference)/api/fhir/r4/observation-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/observation.mdx","type":"page","name":"Observation","description":"Measurements and simple assertions made about a patient, device or other subject.","icon":"$undefined","url":"/api/fhir/r4/observation","$ref":"(api-reference)/api/fhir/r4/observation.mdx"},{"$id":"(api-reference)/api/fhir/r4/operation-definition.mdx","type":"page","name":"OperationDefinition","description":"A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).","icon":"$undefined","url":"/api/fhir/r4/operation-definition","$ref":"(api-reference)/api/fhir/r4/operation-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/operation-outcome.mdx","type":"page","name":"OperationOutcome","description":"A collection of error, warning, or information messages that result from a system action.","icon":"$undefined","url":"/api/fhir/r4/operation-outcome","$ref":"(api-reference)/api/fhir/r4/operation-outcome.mdx"},{"$id":"(api-reference)/api/fhir/r4/organization-affiliation.mdx","type":"page","name":"OrganizationAffiliation","description":"Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.","icon":"$undefined","url":"/api/fhir/r4/organization-affiliation","$ref":"(api-reference)/api/fhir/r4/organization-affiliation.mdx"},{"$id":"(api-reference)/api/fhir/r4/organization.mdx","type":"page","name":"Organization","description":"A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, pay","icon":"$undefined","url":"/api/fhir/r4/organization","$ref":"(api-reference)/api/fhir/r4/organization.mdx"},{"$id":"(api-reference)/api/fhir/r4/parameters.mdx","type":"page","name":"Parameters","description":"This resource is a non-persisted resource used to pass information into and back from an [operation](https://hl7.org/fhir/R4/operations.html). It has no other use, and there is no RESTful endpoint associated with it.","icon":"$undefined","url":"/api/fhir/r4/parameters","$ref":"(api-reference)/api/fhir/r4/parameters.mdx"},{"$id":"(api-reference)/api/fhir/r4/patient.mdx","type":"page","name":"Patient","description":"Demographics and other administrative information about an individual or animal receiving care or other health-related services.","icon":"$undefined","url":"/api/fhir/r4/patient","$ref":"(api-reference)/api/fhir/r4/patient.mdx"},{"$id":"(api-reference)/api/fhir/r4/payment-notice.mdx","type":"page","name":"PaymentNotice","description":"This resource provides the status of the payment for goods and services rendered, and the request and response resource references.","icon":"$undefined","url":"/api/fhir/r4/payment-notice","$ref":"(api-reference)/api/fhir/r4/payment-notice.mdx"},{"$id":"(api-reference)/api/fhir/r4/payment-reconciliation.mdx","type":"page","name":"PaymentReconciliation","description":"This resource provides the details including amount of a payment and allocates the payment items being paid.","icon":"$undefined","url":"/api/fhir/r4/payment-reconciliation","$ref":"(api-reference)/api/fhir/r4/payment-reconciliation.mdx"},{"$id":"(api-reference)/api/fhir/r4/person.mdx","type":"page","name":"Person","description":"Demographics and administrative information about a person independent of a specific health-related context.","icon":"$undefined","url":"/api/fhir/r4/person","$ref":"(api-reference)/api/fhir/r4/person.mdx"},{"$id":"(api-reference)/api/fhir/r4/plan-definition.mdx","type":"page","name":"PlanDefinition","description":"This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support r","icon":"$undefined","url":"/api/fhir/r4/plan-definition","$ref":"(api-reference)/api/fhir/r4/plan-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/practitioner-role.mdx","type":"page","name":"PractitionerRole","description":"A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.","icon":"$undefined","url":"/api/fhir/r4/practitioner-role","$ref":"(api-reference)/api/fhir/r4/practitioner-role.mdx"},{"$id":"(api-reference)/api/fhir/r4/practitioner.mdx","type":"page","name":"Practitioner","description":"A person who is directly or indirectly involved in the provisioning of healthcare.","icon":"$undefined","url":"/api/fhir/r4/practitioner","$ref":"(api-reference)/api/fhir/r4/practitioner.mdx"},{"$id":"(api-reference)/api/fhir/r4/procedure.mdx","type":"page","name":"Procedure","description":"An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.","icon":"$undefined","url":"/api/fhir/r4/procedure","$ref":"(api-reference)/api/fhir/r4/procedure.mdx"},{"$id":"(api-reference)/api/fhir/r4/provenance.mdx","type":"page","name":"Provenance","description":"Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing","icon":"$undefined","url":"/api/fhir/r4/provenance","$ref":"(api-reference)/api/fhir/r4/provenance.mdx"},{"$id":"(api-reference)/api/fhir/r4/questionnaire-response.mdx","type":"page","name":"QuestionnaireResponse","description":"A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.","icon":"$undefined","url":"/api/fhir/r4/questionnaire-response","$ref":"(api-reference)/api/fhir/r4/questionnaire-response.mdx"},{"$id":"(api-reference)/api/fhir/r4/questionnaire.mdx","type":"page","name":"Questionnaire","description":"A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.","icon":"$undefined","url":"/api/fhir/r4/questionnaire","$ref":"(api-reference)/api/fhir/r4/questionnaire.mdx"},{"$id":"(api-reference)/api/fhir/r4/related-person.mdx","type":"page","name":"RelatedPerson","description":"Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.","icon":"$undefined","url":"/api/fhir/r4/related-person","$ref":"(api-reference)/api/fhir/r4/related-person.mdx"},{"$id":"(api-reference)/api/fhir/r4/request-group.mdx","type":"page","name":"RequestGroup","description":"A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".","icon":"$undefined","url":"/api/fhir/r4/request-group","$ref":"(api-reference)/api/fhir/r4/request-group.mdx"},{"$id":"(api-reference)/api/fhir/r4/research-definition.mdx","type":"page","name":"ResearchDefinition","description":"The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.","icon":"$undefined","url":"/api/fhir/r4/research-definition","$ref":"(api-reference)/api/fhir/r4/research-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/research-element-definition.mdx","type":"page","name":"ResearchElementDefinition","description":"The ResearchElementDefinition resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.","icon":"$undefined","url":"/api/fhir/r4/research-element-definition","$ref":"(api-reference)/api/fhir/r4/research-element-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/research-study.mdx","type":"page","name":"ResearchStudy","description":"A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about me","icon":"$undefined","url":"/api/fhir/r4/research-study","$ref":"(api-reference)/api/fhir/r4/research-study.mdx"},{"$id":"(api-reference)/api/fhir/r4/research-subject.mdx","type":"page","name":"ResearchSubject","description":"A physical entity which is the primary unit of operational and/or administrative interest in a study.","icon":"$undefined","url":"/api/fhir/r4/research-subject","$ref":"(api-reference)/api/fhir/r4/research-subject.mdx"},{"$id":"(api-reference)/api/fhir/r4/risk-assessment.mdx","type":"page","name":"RiskAssessment","description":"An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.","icon":"$undefined","url":"/api/fhir/r4/risk-assessment","$ref":"(api-reference)/api/fhir/r4/risk-assessment.mdx"},{"$id":"(api-reference)/api/fhir/r4/risk-evidence-synthesis.mdx","type":"page","name":"RiskEvidenceSynthesis","description":"The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.","icon":"$undefined","url":"/api/fhir/r4/risk-evidence-synthesis","$ref":"(api-reference)/api/fhir/r4/risk-evidence-synthesis.mdx"},{"$id":"(api-reference)/api/fhir/r4/schedule.mdx","type":"page","name":"Schedule","description":"A container for slots of time that may be available for booking appointments.","icon":"$undefined","url":"/api/fhir/r4/schedule","$ref":"(api-reference)/api/fhir/r4/schedule.mdx"},{"$id":"(api-reference)/api/fhir/r4/search-parameter.mdx","type":"page","name":"SearchParameter","description":"A search parameter that defines a named search item that can be used to search/filter on a resource.","icon":"$undefined","url":"/api/fhir/r4/search-parameter","$ref":"(api-reference)/api/fhir/r4/search-parameter.mdx"},{"$id":"(api-reference)/api/fhir/r4/service-request.mdx","type":"page","name":"ServiceRequest","description":"A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.","icon":"$undefined","url":"/api/fhir/r4/service-request","$ref":"(api-reference)/api/fhir/r4/service-request.mdx"},{"$id":"(api-reference)/api/fhir/r4/slot.mdx","type":"page","name":"Slot","description":"A slot of time on a schedule that may be available for booking appointments.","icon":"$undefined","url":"/api/fhir/r4/slot","$ref":"(api-reference)/api/fhir/r4/slot.mdx"},{"$id":"(api-reference)/api/fhir/r4/specimen-definition.mdx","type":"page","name":"SpecimenDefinition","description":"A kind of specimen with associated set of requirements.","icon":"$undefined","url":"/api/fhir/r4/specimen-definition","$ref":"(api-reference)/api/fhir/r4/specimen-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/specimen.mdx","type":"page","name":"Specimen","description":"A sample to be used for analysis.","icon":"$undefined","url":"/api/fhir/r4/specimen","$ref":"(api-reference)/api/fhir/r4/specimen.mdx"},{"$id":"(api-reference)/api/fhir/r4/structure-definition.mdx","type":"page","name":"StructureDefinition","description":"A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.","icon":"$undefined","url":"/api/fhir/r4/structure-definition","$ref":"(api-reference)/api/fhir/r4/structure-definition.mdx"},{"$id":"(api-reference)/api/fhir/r4/structure-map.mdx","type":"page","name":"StructureMap","description":"A Map of relationships between 2 structures that can be used to transform data.","icon":"$undefined","url":"/api/fhir/r4/structure-map","$ref":"(api-reference)/api/fhir/r4/structure-map.mdx"},{"$id":"(api-reference)/api/fhir/r4/subscription.mdx","type":"page","name":"Subscription","description":"The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the giv","icon":"$undefined","url":"/api/fhir/r4/subscription","$ref":"(api-reference)/api/fhir/r4/subscription.mdx"},{"$id":"(api-reference)/api/fhir/r4/substance-nucleic-acid.mdx","type":"page","name":"SubstanceNucleicAcid","description":"Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.","icon":"$undefined","url":"/api/fhir/r4/substance-nucleic-acid","$ref":"(api-reference)/api/fhir/r4/substance-nucleic-acid.mdx"},{"$id":"(api-reference)/api/fhir/r4/substance-polymer.mdx","type":"page","name":"SubstancePolymer","description":"Todo.","icon":"$undefined","url":"/api/fhir/r4/substance-polymer","$ref":"(api-reference)/api/fhir/r4/substance-polymer.mdx"},{"$id":"(api-reference)/api/fhir/r4/substance-protein.mdx","type":"page","name":"SubstanceProtein","description":"A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purif","icon":"$undefined","url":"/api/fhir/r4/substance-protein","$ref":"(api-reference)/api/fhir/r4/substance-protein.mdx"},{"$id":"(api-reference)/api/fhir/r4/substance-reference-information.mdx","type":"page","name":"SubstanceReferenceInformation","description":"Todo.","icon":"$undefined","url":"/api/fhir/r4/substance-reference-information","$ref":"(api-reference)/api/fhir/r4/substance-reference-information.mdx"},{"$id":"(api-reference)/api/fhir/r4/substance-source-material.mdx","type":"page","name":"SubstanceSourceMaterial","description":"Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances is","icon":"$undefined","url":"/api/fhir/r4/substance-source-material","$ref":"(api-reference)/api/fhir/r4/substance-source-material.mdx"},{"$id":"(api-reference)/api/fhir/r4/substance-specification.mdx","type":"page","name":"SubstanceSpecification","description":"The detailed description of a substance, typically at a level beyond what is used for prescribing.","icon":"$undefined","url":"/api/fhir/r4/substance-specification","$ref":"(api-reference)/api/fhir/r4/substance-specification.mdx"},{"$id":"(api-reference)/api/fhir/r4/substance.mdx","type":"page","name":"Substance","description":"A homogeneous material with a definite composition.","icon":"$undefined","url":"/api/fhir/r4/substance","$ref":"(api-reference)/api/fhir/r4/substance.mdx"},{"$id":"(api-reference)/api/fhir/r4/supply-delivery.mdx","type":"page","name":"SupplyDelivery","description":"Record of delivery of what is supplied.","icon":"$undefined","url":"/api/fhir/r4/supply-delivery","$ref":"(api-reference)/api/fhir/r4/supply-delivery.mdx"},{"$id":"(api-reference)/api/fhir/r4/supply-request.mdx","type":"page","name":"SupplyRequest","description":"A record of a request for a medication, substance or device used in the healthcare setting.","icon":"$undefined","url":"/api/fhir/r4/supply-request","$ref":"(api-reference)/api/fhir/r4/supply-request.mdx"},{"$id":"(api-reference)/api/fhir/r4/task.mdx","type":"page","name":"Task","description":"A task to be performed.","icon":"$undefined","url":"/api/fhir/r4/task","$ref":"(api-reference)/api/fhir/r4/task.mdx"},{"$id":"(api-reference)/api/fhir/r4/terminology-capabilities.mdx","type":"page","name":"TerminologyCapabilities","description":"A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.","icon":"$undefined","url":"/api/fhir/r4/terminology-capabilities","$ref":"(api-reference)/api/fhir/r4/terminology-capabilities.mdx"},{"$id":"(api-reference)/api/fhir/r4/test-report.mdx","type":"page","name":"TestReport","description":"A summary of information based on the results of executing a TestScript.","icon":"$undefined","url":"/api/fhir/r4/test-report","$ref":"(api-reference)/api/fhir/r4/test-report.mdx"},{"$id":"(api-reference)/api/fhir/r4/test-script.mdx","type":"page","name":"TestScript","description":"A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.","icon":"$undefined","url":"/api/fhir/r4/test-script","$ref":"(api-reference)/api/fhir/r4/test-script.mdx"},{"$id":"(api-reference)/api/fhir/r4/value-set.mdx","type":"page","name":"ValueSet","description":"A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](https://hl7.org/fhir/R4/terminologies.html).","icon":"$undefined","url":"/api/fhir/r4/value-set","$ref":"(api-reference)/api/fhir/r4/value-set.mdx"},{"$id":"(api-reference)/api/fhir/r4/verification-result.mdx","type":"page","name":"VerificationResult","description":"Describes validation requirements, source(s), status and dates for one or more elements.","icon":"$undefined","url":"/api/fhir/r4/verification-result","$ref":"(api-reference)/api/fhir/r4/verification-result.mdx"},{"$id":"(api-reference)/api/fhir/r4/vision-prescription.mdx","type":"page","name":"VisionPrescription","description":"An authorization for the provision of glasses and/or contact lenses to a patient.","icon":"$undefined","url":"/api/fhir/r4/vision-prescription","$ref":"(api-reference)/api/fhir/r4/vision-prescription.mdx"}],"$id":"(api-reference)","$ref":{"folder":"(api-reference)","meta":"(api-reference)/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Developer resources","root":true,"defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"_52","type":"separator","icon":"$undefined","name":"Versioning"},{"type":"folder","name":"Changelog","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[],"$id":"(developer-resources)/changelog","$ref":{"folder":"(developer-resources)/changelog","meta":"(developer-resources)/changelog/meta.json"},"index":{"$id":"(developer-resources)/changelog/index.mdx","type":"page","name":"All releases","description":"What changed in the Ovok API and SDKs with each production release.","icon":"$undefined","url":"/changelog","$ref":"(developer-resources)/changelog/index.mdx"},"icon":"$undefined"},{"$id":"(developer-resources)/deprecated-routes.mdx","type":"page","name":"Deprecated routes","description":"Every deprecated Ovok API route, its replacement, and how to read the Deprecation, Sunset and Link headers before the 1 December 2026 sunset.","icon":"$undefined","url":"/deprecated-routes","$ref":"(developer-resources)/deprecated-routes.mdx"},{"$id":"_53","type":"separator","icon":"$undefined","name":"Essentials"},{"$id":"_54","type":"page","icon":"$undefined","name":"API reference","url":"/api","external":"$undefined"},{"type":"folder","name":"Errors","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"(developer-resources)/errors/account-exists.mdx","type":"page","name":"ACCOUNT EXISTS","description":"Troubleshoot account exists responses from the Ovok API.","icon":"$undefined","url":"/errors/account-exists","$ref":"(developer-resources)/errors/account-exists.mdx"},{"$id":"(developer-resources)/errors/address-has-account.mdx","type":"page","name":"ADDRESS HAS ACCOUNT","description":"Troubleshoot address has account responses from the Ovok API.","icon":"$undefined","url":"/errors/address-has-account","$ref":"(developer-resources)/errors/address-has-account.mdx"},{"$id":"(developer-resources)/errors/already-subscribed.mdx","type":"page","name":"ALREADY SUBSCRIBED","description":"Troubleshoot already subscribed responses from the Ovok API.","icon":"$undefined","url":"/errors/already-subscribed","$ref":"(developer-resources)/errors/already-subscribed.mdx"},{"$id":"(developer-resources)/errors/app-url-not-allowed.mdx","type":"page","name":"APP URL NOT ALLOWED","description":"Troubleshoot app url not allowed responses from the Ovok API.","icon":"$undefined","url":"/errors/app-url-not-allowed","$ref":"(developer-resources)/errors/app-url-not-allowed.mdx"},{"$id":"(developer-resources)/errors/app-url-not-configured.mdx","type":"page","name":"APP URL NOT CONFIGURED","description":"Troubleshoot app url not configured responses from the Ovok API.","icon":"$undefined","url":"/errors/app-url-not-configured","$ref":"(developer-resources)/errors/app-url-not-configured.mdx"},{"$id":"(developer-resources)/errors/billing-disabled.mdx","type":"page","name":"BILLING DISABLED","description":"Troubleshoot billing disabled responses from the Ovok API.","icon":"$undefined","url":"/errors/billing-disabled","$ref":"(developer-resources)/errors/billing-disabled.mdx"},{"$id":"(developer-resources)/errors/billing-hub.mdx","type":"page","name":"BILLING HUB","description":"Troubleshoot billing hub responses from the Ovok API.","icon":"$undefined","url":"/errors/billing-hub","$ref":"(developer-resources)/errors/billing-hub.mdx"},{"$id":"(developer-resources)/errors/client-error.mdx","type":"page","name":"CLIENT_ERROR","description":"Troubleshoot an unmapped Ovok client error and correct the request before retrying.","icon":"$undefined","url":"/errors/client-error","$ref":"(developer-resources)/errors/client-error.mdx"},{"$id":"(developer-resources)/errors/client-id-reserved.mdx","type":"page","name":"CLIENT ID RESERVED","description":"Troubleshoot client id reserved responses from the Ovok API.","icon":"$undefined","url":"/errors/client-id-reserved","$ref":"(developer-resources)/errors/client-id-reserved.mdx"},{"$id":"(developer-resources)/errors/cms-api-key-limit.mdx","type":"page","name":"CMS API KEY LIMIT","description":"Troubleshoot cms api key limit responses from the Ovok API.","icon":"$undefined","url":"/errors/cms-api-key-limit","$ref":"(developer-resources)/errors/cms-api-key-limit.mdx"},{"$id":"(developer-resources)/errors/cms-api-key-not-found.mdx","type":"page","name":"CMS API KEY NOT FOUND","description":"Troubleshoot cms api key not found responses from the Ovok API.","icon":"$undefined","url":"/errors/cms-api-key-not-found","$ref":"(developer-resources)/errors/cms-api-key-not-found.mdx"},{"$id":"(developer-resources)/errors/conflict.mdx","type":"page","name":"CONFLICT","description":"Resolve a resource-state conflict returned by the Ovok API.","icon":"$undefined","url":"/errors/conflict","$ref":"(developer-resources)/errors/conflict.mdx"},{"$id":"(developer-resources)/errors/connection-changed.mdx","type":"page","name":"CONNECTION CHANGED","description":"Troubleshoot connection changed responses from the Ovok API.","icon":"$undefined","url":"/errors/connection-changed","$ref":"(developer-resources)/errors/connection-changed.mdx"},{"$id":"(developer-resources)/errors/connection-not-found.mdx","type":"page","name":"CONNECTION NOT FOUND","description":"Troubleshoot connection not found responses from the Ovok API.","icon":"$undefined","url":"/errors/connection-not-found","$ref":"(developer-resources)/errors/connection-not-found.mdx"},{"$id":"(developer-resources)/errors/content-too-large.mdx","type":"page","name":"CONTENT_TOO_LARGE","description":"Reduce an Ovok request body that exceeds the endpoint's accepted size.","icon":"$undefined","url":"/errors/content-too-large","$ref":"(developer-resources)/errors/content-too-large.mdx"},{"$id":"(developer-resources)/errors/email-not-verified.mdx","type":"page","name":"EMAIL NOT VERIFIED","description":"Troubleshoot email not verified responses from the Ovok API.","icon":"$undefined","url":"/errors/email-not-verified","$ref":"(developer-resources)/errors/email-not-verified.mdx"},{"$id":"(developer-resources)/errors/encryption-unavailable.mdx","type":"page","name":"ENCRYPTION UNAVAILABLE","description":"Troubleshoot encryption unavailable responses from the Ovok API.","icon":"$undefined","url":"/errors/encryption-unavailable","$ref":"(developer-resources)/errors/encryption-unavailable.mdx"},{"$id":"(developer-resources)/errors/enterprise-contract.mdx","type":"page","name":"ENTERPRISE CONTRACT","description":"Troubleshoot enterprise contract responses from the Ovok API.","icon":"$undefined","url":"/errors/enterprise-contract","$ref":"(developer-resources)/errors/enterprise-contract.mdx"},{"$id":"(developer-resources)/errors/events-unavailable.mdx","type":"page","name":"EVENTS UNAVAILABLE","description":"Troubleshoot events unavailable responses from the Ovok API.","icon":"$undefined","url":"/errors/events-unavailable","$ref":"(developer-resources)/errors/events-unavailable.mdx"},{"$id":"(developer-resources)/errors/failed-dependency.mdx","type":"page","name":"FAILED_DEPENDENCY","description":"Find and resolve the prerequisite operation behind an Ovok failed-dependency response.","icon":"$undefined","url":"/errors/failed-dependency","$ref":"(developer-resources)/errors/failed-dependency.mdx"},{"$id":"(developer-resources)/errors/feature-not-configured.mdx","type":"page","name":"FEATURE_NOT_CONFIGURED","description":"Resolve a feature-not-configured error by checking deployment and integration setup.","icon":"$undefined","url":"/errors/feature-not-configured","$ref":"(developer-resources)/errors/feature-not-configured.mdx"},{"$id":"(developer-resources)/errors/forbidden.mdx","type":"page","name":"FORBIDDEN","description":"Troubleshoot an authenticated Ovok request that is not permitted.","icon":"$undefined","url":"/errors/forbidden","$ref":"(developer-resources)/errors/forbidden.mdx"},{"$id":"(developer-resources)/errors/from-required.mdx","type":"page","name":"FROM REQUIRED","description":"Troubleshoot from required responses from the Ovok API.","icon":"$undefined","url":"/errors/from-required","$ref":"(developer-resources)/errors/from-required.mdx"},{"$id":"(developer-resources)/errors/gone.mdx","type":"page","name":"GONE","description":"Handle an Ovok resource or action that is no longer available.","icon":"$undefined","url":"/errors/gone","$ref":"(developer-resources)/errors/gone.mdx"},{"$id":"(developer-resources)/errors/internal-error.mdx","type":"page","name":"INTERNAL_ERROR","description":"Diagnose an unexpected internal Ovok server error and retry safely.","icon":"$undefined","url":"/errors/internal-error","$ref":"(developer-resources)/errors/internal-error.mdx"},{"$id":"(developer-resources)/errors/invalid-link.mdx","type":"page","name":"INVALID LINK","description":"Troubleshoot invalid link responses from the Ovok API.","icon":"$undefined","url":"/errors/invalid-link","$ref":"(developer-resources)/errors/invalid-link.mdx"},{"$id":"(developer-resources)/errors/invalid-secret.mdx","type":"page","name":"INVALID SECRET","description":"Troubleshoot invalid secret responses from the Ovok API.","icon":"$undefined","url":"/errors/invalid-secret","$ref":"(developer-resources)/errors/invalid-secret.mdx"},{"$id":"(developer-resources)/errors/invalid-setting-value.mdx","type":"page","name":"INVALID SETTING VALUE","description":"Troubleshoot invalid setting value responses from the Ovok API.","icon":"$undefined","url":"/errors/invalid-setting-value","$ref":"(developer-resources)/errors/invalid-setting-value.mdx"},{"$id":"(developer-resources)/errors/invalid-signature.mdx","type":"page","name":"INVALID SIGNATURE","description":"Troubleshoot invalid signature responses from the Ovok API.","icon":"$undefined","url":"/errors/invalid-signature","$ref":"(developer-resources)/errors/invalid-signature.mdx"},{"$id":"(developer-resources)/errors/invalid-state.mdx","type":"page","name":"INVALID STATE","description":"Troubleshoot invalid state responses from the Ovok API.","icon":"$undefined","url":"/errors/invalid-state","$ref":"(developer-resources)/errors/invalid-state.mdx"},{"$id":"(developer-resources)/errors/invalid-switch.mdx","type":"page","name":"INVALID SWITCH","description":"Troubleshoot invalid switch responses from the Ovok API.","icon":"$undefined","url":"/errors/invalid-switch","$ref":"(developer-resources)/errors/invalid-switch.mdx"},{"$id":"(developer-resources)/errors/invalid-template-content.mdx","type":"page","name":"INVALID TEMPLATE CONTENT","description":"Troubleshoot invalid template content responses from the Ovok API.","icon":"$undefined","url":"/errors/invalid-template-content","$ref":"(developer-resources)/errors/invalid-template-content.mdx"},{"$id":"(developer-resources)/errors/invalid-template-id.mdx","type":"page","name":"INVALID TEMPLATE ID","description":"Troubleshoot invalid template id responses from the Ovok API.","icon":"$undefined","url":"/errors/invalid-template-id","$ref":"(developer-resources)/errors/invalid-template-id.mdx"},{"$id":"(developer-resources)/errors/invitation-not-configured.mdx","type":"page","name":"INVITATION NOT CONFIGURED","description":"Troubleshoot invitation not configured responses from the Ovok API.","icon":"$undefined","url":"/errors/invitation-not-configured","$ref":"(developer-resources)/errors/invitation-not-configured.mdx"},{"$id":"(developer-resources)/errors/live-reads-over-capacity.mdx","type":"page","name":"LIVE READS OVER CAPACITY","description":"Troubleshoot live reads over capacity responses from the Ovok API.","icon":"$undefined","url":"/errors/live-reads-over-capacity","$ref":"(developer-resources)/errors/live-reads-over-capacity.mdx"},{"$id":"(developer-resources)/errors/locked.mdx","type":"page","name":"LOCKED","description":"Troubleshoot an Ovok resource that is temporarily locked for changes.","icon":"$undefined","url":"/errors/locked","$ref":"(developer-resources)/errors/locked.mdx"},{"$id":"(developer-resources)/errors/machine-codes.mdx","type":"page","name":"Machine codes","description":"Complete registry of Ovok HTTP Problem Details types emitted by the current core release.","icon":"$undefined","url":"/errors/machine-codes","$ref":"(developer-resources)/errors/machine-codes.mdx"},{"$id":"(developer-resources)/errors/malformed-notification.mdx","type":"page","name":"MALFORMED NOTIFICATION","description":"Troubleshoot malformed notification responses from the Ovok API.","icon":"$undefined","url":"/errors/malformed-notification","$ref":"(developer-resources)/errors/malformed-notification.mdx"},{"$id":"(developer-resources)/errors/malformed-request.mdx","type":"page","name":"MALFORMED_REQUEST","description":"Find and correct the malformed parts of an Ovok API request.","icon":"$undefined","url":"/errors/malformed-request","$ref":"(developer-resources)/errors/malformed-request.mdx"},{"$id":"(developer-resources)/errors/method-not-allowed.mdx","type":"page","name":"METHOD_NOT_ALLOWED","description":"Choose an HTTP method supported by the requested Ovok route.","icon":"$undefined","url":"/errors/method-not-allowed","$ref":"(developer-resources)/errors/method-not-allowed.mdx"},{"$id":"(developer-resources)/errors/monthly-request-cap.mdx","type":"page","name":"MONTHLY REQUEST CAP","description":"Troubleshoot monthly request cap responses from the Ovok API.","icon":"$undefined","url":"/errors/monthly-request-cap","$ref":"(developer-resources)/errors/monthly-request-cap.mdx"},{"$id":"(developer-resources)/errors/no-subscription.mdx","type":"page","name":"NO SUBSCRIPTION","description":"Troubleshoot no subscription responses from the Ovok API.","icon":"$undefined","url":"/errors/no-subscription","$ref":"(developer-resources)/errors/no-subscription.mdx"},{"$id":"(developer-resources)/errors/not-acceptable.mdx","type":"page","name":"NOT_ACCEPTABLE","description":"Correct the response format requested by an Ovok API client.","icon":"$undefined","url":"/errors/not-acceptable","$ref":"(developer-resources)/errors/not-acceptable.mdx"},{"$id":"(developer-resources)/errors/not-found.mdx","type":"page","name":"NOT_FOUND","description":"Find the correct Ovok route or resource after a not-found response.","icon":"$undefined","url":"/errors/not-found","$ref":"(developer-resources)/errors/not-found.mdx"},{"$id":"(developer-resources)/errors/not-implemented.mdx","type":"page","name":"NOT_IMPLEMENTED","description":"Check whether the requested Ovok operation is implemented in this API and deployment.","icon":"$undefined","url":"/errors/not-implemented","$ref":"(developer-resources)/errors/not-implemented.mdx"},{"$id":"(developer-resources)/errors/not-parent-project.mdx","type":"page","name":"NOT PARENT PROJECT","description":"Troubleshoot not parent project responses from the Ovok API.","icon":"$undefined","url":"/errors/not-parent-project","$ref":"(developer-resources)/errors/not-parent-project.mdx"},{"$id":"(developer-resources)/errors/not-your-email.mdx","type":"page","name":"NOT YOUR EMAIL","description":"Troubleshoot not your email responses from the Ovok API.","icon":"$undefined","url":"/errors/not-your-email","$ref":"(developer-resources)/errors/not-your-email.mdx"},{"$id":"(developer-resources)/errors/not-your-switch.mdx","type":"page","name":"NOT YOUR SWITCH","description":"Troubleshoot not your switch responses from the Ovok API.","icon":"$undefined","url":"/errors/not-your-switch","$ref":"(developer-resources)/errors/not-your-switch.mdx"},{"$id":"(developer-resources)/errors/parent-project-has-no-access-policy.mdx","type":"page","name":"PARENT PROJECT HAS NO ACCESS POLICY","description":"Troubleshoot parent project has no access policy responses from the Ovok API.","icon":"$undefined","url":"/errors/parent-project-has-no-access-policy","$ref":"(developer-resources)/errors/parent-project-has-no-access-policy.mdx"},{"$id":"(developer-resources)/errors/password-required.mdx","type":"page","name":"PASSWORD REQUIRED","description":"Troubleshoot password required responses from the Ovok API.","icon":"$undefined","url":"/errors/password-required","$ref":"(developer-resources)/errors/password-required.mdx"},{"$id":"(developer-resources)/errors/patient-profile-required.mdx","type":"page","name":"PATIENT PROFILE REQUIRED","description":"Troubleshoot patient profile required responses from the Ovok API.","icon":"$undefined","url":"/errors/patient-profile-required","$ref":"(developer-resources)/errors/patient-profile-required.mdx"},{"$id":"(developer-resources)/errors/plan-limit-reached.mdx","type":"page","name":"PLAN LIMIT REACHED","description":"Troubleshoot plan limit reached responses from the Ovok API.","icon":"$undefined","url":"/errors/plan-limit-reached","$ref":"(developer-resources)/errors/plan-limit-reached.mdx"},{"$id":"(developer-resources)/errors/practitioner-registration-not-configured.mdx","type":"page","name":"PRACTITIONER REGISTRATION NOT CONFIGURED","description":"Troubleshoot practitioner registration not configured responses from the Ovok API.","icon":"$undefined","url":"/errors/practitioner-registration-not-configured","$ref":"(developer-resources)/errors/practitioner-registration-not-configured.mdx"},{"$id":"(developer-resources)/errors/practitioner-without-access-policy.mdx","type":"page","name":"PRACTITIONER WITHOUT ACCESS POLICY","description":"Troubleshoot practitioner without access policy responses from the Ovok API.","icon":"$undefined","url":"/errors/practitioner-without-access-policy","$ref":"(developer-resources)/errors/practitioner-without-access-policy.mdx"},{"$id":"(developer-resources)/errors/precondition-failed.mdx","type":"page","name":"PRECONDITION_FAILED","description":"Refresh a resource and reconcile a failed Ovok request precondition.","icon":"$undefined","url":"/errors/precondition-failed","$ref":"(developer-resources)/errors/precondition-failed.mdx"},{"$id":"(developer-resources)/errors/precondition-required.mdx","type":"page","name":"PRECONDITION_REQUIRED","description":"Add the documented request precondition required by an Ovok endpoint.","icon":"$undefined","url":"/errors/precondition-required","$ref":"(developer-resources)/errors/precondition-required.mdx"},{"$id":"(developer-resources)/errors/project-context-required.mdx","type":"page","name":"PROJECT CONTEXT REQUIRED","description":"Troubleshoot project context required responses from the Ovok API.","icon":"$undefined","url":"/errors/project-context-required","$ref":"(developer-resources)/errors/project-context-required.mdx"},{"$id":"(developer-resources)/errors/project-not-empty.mdx","type":"page","name":"PROJECT NOT EMPTY","description":"Troubleshoot project not empty responses from the Ovok API.","icon":"$undefined","url":"/errors/project-not-empty","$ref":"(developer-resources)/errors/project-not-empty.mdx"},{"$id":"(developer-resources)/errors/project-not-found.mdx","type":"page","name":"PROJECT NOT FOUND","description":"Troubleshoot project not found responses from the Ovok API.","icon":"$undefined","url":"/errors/project-not-found","$ref":"(developer-resources)/errors/project-not-found.mdx"},{"$id":"(developer-resources)/errors/provider-configured.mdx","type":"page","name":"PROVIDER CONFIGURED","description":"Troubleshoot provider configured responses from the Ovok API.","icon":"$undefined","url":"/errors/provider-configured","$ref":"(developer-resources)/errors/provider-configured.mdx"},{"$id":"(developer-resources)/errors/provider-mismatch.mdx","type":"page","name":"PROVIDER MISMATCH","description":"Troubleshoot provider mismatch responses from the Ovok API.","icon":"$undefined","url":"/errors/provider-mismatch","$ref":"(developer-resources)/errors/provider-mismatch.mdx"},{"$id":"(developer-resources)/errors/provider-not-available.mdx","type":"page","name":"PROVIDER NOT AVAILABLE","description":"Troubleshoot provider not available responses from the Ovok API.","icon":"$undefined","url":"/errors/provider-not-available","$ref":"(developer-resources)/errors/provider-not-available.mdx"},{"$id":"(developer-resources)/errors/provider-not-configured.mdx","type":"page","name":"PROVIDER NOT CONFIGURED","description":"Troubleshoot provider not configured responses from the Ovok API.","icon":"$undefined","url":"/errors/provider-not-configured","$ref":"(developer-resources)/errors/provider-not-configured.mdx"},{"$id":"(developer-resources)/errors/provider-rate-limited.mdx","type":"page","name":"PROVIDER RATE LIMITED","description":"Troubleshoot provider rate limited responses from the Ovok API.","icon":"$undefined","url":"/errors/provider-rate-limited","$ref":"(developer-resources)/errors/provider-rate-limited.mdx"},{"$id":"(developer-resources)/errors/provider-unavailable.mdx","type":"page","name":"PROVIDER UNAVAILABLE","description":"Troubleshoot provider unavailable responses from the Ovok API.","icon":"$undefined","url":"/errors/provider-unavailable","$ref":"(developer-resources)/errors/provider-unavailable.mdx"},{"$id":"(developer-resources)/errors/reconnect-required.mdx","type":"page","name":"RECONNECT REQUIRED","description":"Troubleshoot reconnect required responses from the Ovok API.","icon":"$undefined","url":"/errors/reconnect-required","$ref":"(developer-resources)/errors/reconnect-required.mdx"},{"$id":"(developer-resources)/errors/related-person-without-access-policy.mdx","type":"page","name":"RELATED PERSON WITHOUT ACCESS POLICY","description":"Troubleshoot related person without access policy responses from the Ovok API.","icon":"$undefined","url":"/errors/related-person-without-access-policy","$ref":"(developer-resources)/errors/related-person-without-access-policy.mdx"},{"$id":"(developer-resources)/errors/request-timeout.mdx","type":"page","name":"REQUEST_TIMEOUT","description":"Recover safely when an Ovok request times out before completion.","icon":"$undefined","url":"/errors/request-timeout","$ref":"(developer-resources)/errors/request-timeout.mdx"},{"$id":"(developer-resources)/errors/server-error.mdx","type":"page","name":"SERVER_ERROR","description":"Handle an unmapped Ovok server error and gather details for diagnosis.","icon":"$undefined","url":"/errors/server-error","$ref":"(developer-resources)/errors/server-error.mdx"},{"$id":"(developer-resources)/errors/service-unavailable.mdx","type":"page","name":"SERVICE_UNAVAILABLE","description":"Recover from a temporary Ovok or dependency service outage.","icon":"$undefined","url":"/errors/service-unavailable","$ref":"(developer-resources)/errors/service-unavailable.mdx"},{"$id":"(developer-resources)/errors/sharing-not-configured.mdx","type":"page","name":"SHARING NOT CONFIGURED","description":"Troubleshoot sharing not configured responses from the Ovok API.","icon":"$undefined","url":"/errors/sharing-not-configured","$ref":"(developer-resources)/errors/sharing-not-configured.mdx"},{"$id":"(developer-resources)/errors/signals-audit-failed.mdx","type":"page","name":"SIGNALS AUDIT FAILED","description":"Troubleshoot signals audit failed responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-audit-failed","$ref":"(developer-resources)/errors/signals-audit-failed.mdx"},{"$id":"(developer-resources)/errors/signals-bad-request.mdx","type":"page","name":"SIGNALS BAD REQUEST","description":"Troubleshoot signals bad request responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-bad-request","$ref":"(developer-resources)/errors/signals-bad-request.mdx"},{"$id":"(developer-resources)/errors/signals-code-invalid.mdx","type":"page","name":"SIGNALS CODE INVALID","description":"Troubleshoot signals code invalid responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-code-invalid","$ref":"(developer-resources)/errors/signals-code-invalid.mdx"},{"$id":"(developer-resources)/errors/signals-episodes-disabled.mdx","type":"page","name":"SIGNALS EPISODES DISABLED","description":"Troubleshoot signals episodes disabled responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-episodes-disabled","$ref":"(developer-resources)/errors/signals-episodes-disabled.mdx"},{"$id":"(developer-resources)/errors/signals-mint-failed.mdx","type":"page","name":"SIGNALS MINT FAILED","description":"Troubleshoot signals mint failed responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-mint-failed","$ref":"(developer-resources)/errors/signals-mint-failed.mdx"},{"$id":"(developer-resources)/errors/signals-patient-not-enrolled.mdx","type":"page","name":"SIGNALS PATIENT NOT ENROLLED","description":"Troubleshoot signals patient not enrolled responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-patient-not-enrolled","$ref":"(developer-resources)/errors/signals-patient-not-enrolled.mdx"},{"$id":"(developer-resources)/errors/signals-project-migrating.mdx","type":"page","name":"SIGNALS PROJECT MIGRATING","description":"Troubleshoot signals project migrating responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-project-migrating","$ref":"(developer-resources)/errors/signals-project-migrating.mdx"},{"$id":"(developer-resources)/errors/signals-shared-tenant.mdx","type":"page","name":"SIGNALS SHARED TENANT","description":"Troubleshoot signals shared tenant responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-shared-tenant","$ref":"(developer-resources)/errors/signals-shared-tenant.mdx"},{"$id":"(developer-resources)/errors/signals-tenant-revoke-failed.mdx","type":"page","name":"SIGNALS TENANT REVOKE FAILED","description":"Troubleshoot signals tenant revoke failed responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-tenant-revoke-failed","$ref":"(developer-resources)/errors/signals-tenant-revoke-failed.mdx"},{"$id":"(developer-resources)/errors/signals-tenant-unavailable.mdx","type":"page","name":"SIGNALS TENANT UNAVAILABLE","description":"Troubleshoot signals tenant unavailable responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-tenant-unavailable","$ref":"(developer-resources)/errors/signals-tenant-unavailable.mdx"},{"$id":"(developer-resources)/errors/signals-threshold-not-editable.mdx","type":"page","name":"SIGNALS THRESHOLD NOT EDITABLE","description":"Troubleshoot signals threshold not editable responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-threshold-not-editable","$ref":"(developer-resources)/errors/signals-threshold-not-editable.mdx"},{"$id":"(developer-resources)/errors/signals-unavailable.mdx","type":"page","name":"SIGNALS UNAVAILABLE","description":"Troubleshoot signals unavailable responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-unavailable","$ref":"(developer-resources)/errors/signals-unavailable.mdx"},{"$id":"(developer-resources)/errors/signals-undo-failed.mdx","type":"page","name":"SIGNALS UNDO FAILED","description":"Troubleshoot signals undo failed responses from the Ovok API.","icon":"$undefined","url":"/errors/signals-undo-failed","$ref":"(developer-resources)/errors/signals-undo-failed.mdx"},{"$id":"(developer-resources)/errors/signup-closed.mdx","type":"page","name":"SIGNUP CLOSED","description":"Troubleshoot signup closed responses from the Ovok API.","icon":"$undefined","url":"/errors/signup-closed","$ref":"(developer-resources)/errors/signup-closed.mdx"},{"$id":"(developer-resources)/errors/state-store-unavailable.mdx","type":"page","name":"STATE STORE UNAVAILABLE","description":"Troubleshoot state store unavailable responses from the Ovok API.","icon":"$undefined","url":"/errors/state-store-unavailable","$ref":"(developer-resources)/errors/state-store-unavailable.mdx"},{"$id":"(developer-resources)/errors/subscription-key-not-used.mdx","type":"page","name":"SUBSCRIPTION KEY NOT USED","description":"Troubleshoot subscription key not used responses from the Ovok API.","icon":"$undefined","url":"/errors/subscription-key-not-used","$ref":"(developer-resources)/errors/subscription-key-not-used.mdx"},{"$id":"(developer-resources)/errors/subscription-key-required.mdx","type":"page","name":"SUBSCRIPTION KEY REQUIRED","description":"Troubleshoot subscription key required responses from the Ovok API.","icon":"$undefined","url":"/errors/subscription-key-required","$ref":"(developer-resources)/errors/subscription-key-required.mdx"},{"$id":"(developer-resources)/errors/sync-failed.mdx","type":"page","name":"SYNC FAILED","description":"Troubleshoot sync failed responses from the Ovok API.","icon":"$undefined","url":"/errors/sync-failed","$ref":"(developer-resources)/errors/sync-failed.mdx"},{"$id":"(developer-resources)/errors/sync-in-progress.mdx","type":"page","name":"SYNC IN PROGRESS","description":"Troubleshoot sync in progress responses from the Ovok API.","icon":"$undefined","url":"/errors/sync-in-progress","$ref":"(developer-resources)/errors/sync-in-progress.mdx"},{"$id":"(developer-resources)/errors/sync-not-supported.mdx","type":"page","name":"SYNC NOT SUPPORTED","description":"Troubleshoot sync not supported responses from the Ovok API.","icon":"$undefined","url":"/errors/sync-not-supported","$ref":"(developer-resources)/errors/sync-not-supported.mdx"},{"$id":"(developer-resources)/errors/sync-queue-unavailable.mdx","type":"page","name":"SYNC QUEUE UNAVAILABLE","description":"Troubleshoot sync queue unavailable responses from the Ovok API.","icon":"$undefined","url":"/errors/sync-queue-unavailable","$ref":"(developer-resources)/errors/sync-queue-unavailable.mdx"},{"$id":"(developer-resources)/errors/sync-too-soon.mdx","type":"page","name":"SYNC TOO SOON","description":"Troubleshoot sync too soon responses from the Ovok API.","icon":"$undefined","url":"/errors/sync-too-soon","$ref":"(developer-resources)/errors/sync-too-soon.mdx"},{"$id":"(developer-resources)/errors/too-many-requests.mdx","type":"page","name":"TOO_MANY_REQUESTS","description":"Reduce request rate and retry after an Ovok rate-limit response.","icon":"$undefined","url":"/errors/too-many-requests","$ref":"(developer-resources)/errors/too-many-requests.mdx"},{"$id":"(developer-resources)/errors/trace-not-found.mdx","type":"page","name":"TRACE NOT FOUND","description":"Troubleshoot trace not found responses from the Ovok API.","icon":"$undefined","url":"/errors/trace-not-found","$ref":"(developer-resources)/errors/trace-not-found.mdx"},{"$id":"(developer-resources)/errors/transaction-too-large.mdx","type":"page","name":"TRANSACTION TOO LARGE","description":"Troubleshoot transaction too large responses from the Ovok API.","icon":"$undefined","url":"/errors/transaction-too-large","$ref":"(developer-resources)/errors/transaction-too-large.mdx"},{"$id":"(developer-resources)/errors/unauthenticated.mdx","type":"page","name":"UNAUTHENTICATED","description":"Restore valid authentication for an Ovok API request.","icon":"$undefined","url":"/errors/unauthenticated","$ref":"(developer-resources)/errors/unauthenticated.mdx"},{"$id":"(developer-resources)/errors/unknown-setting.mdx","type":"page","name":"UNKNOWN SETTING","description":"Troubleshoot unknown setting responses from the Ovok API.","icon":"$undefined","url":"/errors/unknown-setting","$ref":"(developer-resources)/errors/unknown-setting.mdx"},{"$id":"(developer-resources)/errors/unknown-template.mdx","type":"page","name":"UNKNOWN TEMPLATE","description":"Troubleshoot unknown template responses from the Ovok API.","icon":"$undefined","url":"/errors/unknown-template","$ref":"(developer-resources)/errors/unknown-template.mdx"},{"$id":"(developer-resources)/errors/unsupported-media-type.mdx","type":"page","name":"UNSUPPORTED_MEDIA_TYPE","description":"Send an Ovok request body using the media type supported by its endpoint.","icon":"$undefined","url":"/errors/unsupported-media-type","$ref":"(developer-resources)/errors/unsupported-media-type.mdx"},{"$id":"(developer-resources)/errors/upstream-error.mdx","type":"page","name":"UPSTREAM_ERROR","description":"Troubleshoot an unusable or unreachable upstream response through Ovok.","icon":"$undefined","url":"/errors/upstream-error","$ref":"(developer-resources)/errors/upstream-error.mdx"},{"$id":"(developer-resources)/errors/upstream-timeout.mdx","type":"page","name":"UPSTREAM_TIMEOUT","description":"Recover from an upstream service that did not answer before Ovok's deadline.","icon":"$undefined","url":"/errors/upstream-timeout","$ref":"(developer-resources)/errors/upstream-timeout.mdx"},{"$id":"(developer-resources)/errors/validation-failed.mdx","type":"page","name":"VALIDATION_FAILED","description":"Correct field-level validation errors returned by the Ovok API.","icon":"$undefined","url":"/errors/validation-failed","$ref":"(developer-resources)/errors/validation-failed.mdx"},{"$id":"(developer-resources)/errors/vat-id-required.mdx","type":"page","name":"VAT ID REQUIRED","description":"Troubleshoot vat id required responses from the Ovok API.","icon":"$undefined","url":"/errors/vat-id-required","$ref":"(developer-resources)/errors/vat-id-required.mdx"},{"$id":"(developer-resources)/errors/webhook-not-supported.mdx","type":"page","name":"WEBHOOK NOT SUPPORTED","description":"Troubleshoot webhook not supported responses from the Ovok API.","icon":"$undefined","url":"/errors/webhook-not-supported","$ref":"(developer-resources)/errors/webhook-not-supported.mdx"},{"$id":"(developer-resources)/errors/webhook-secret-not-used.mdx","type":"page","name":"WEBHOOK SECRET NOT USED","description":"Troubleshoot webhook secret not used responses from the Ovok API.","icon":"$undefined","url":"/errors/webhook-secret-not-used","$ref":"(developer-resources)/errors/webhook-secret-not-used.mdx"}],"$id":"(developer-resources)/errors","$ref":{"folder":"(developer-resources)/errors","meta":"(developer-resources)/errors/meta.json"},"index":{"$id":"(developer-resources)/errors/index.mdx","type":"page","name":"Errors","description":"Read Ovok HTTP errors, correlate failures with trace IDs, and handle field-level validation details.","icon":"$undefined","url":"/errors","$ref":"(developer-resources)/errors/index.mdx"},"icon":"$undefined"},{"$id":"_55","type":"separator","icon":"$undefined","name":"Tools"},{"$id":"(developer-resources)/working-with-ai-agents/index.mdx","type":"page","name":"Working With AI Agents","description":"Use coding agents to design, build, set up and review applications on Ovok, with the Ovok skill, the Ovok MCP server and AI-readable docs.","icon":"$undefined","url":"/working-with-ai-agents","$ref":"(developer-resources)/working-with-ai-agents/index.mdx"},{"$id":"(developer-resources)/working-with-ai-agents/ovok-skill.mdx","type":"page","name":"Ovok skill","description":"Install the Ovok skill so a coding agent inspects your app, checks the Ovok docs and reports the setup an admin must do.","icon":"$undefined","url":"/working-with-ai-agents/ovok-skill","$ref":"(developer-resources)/working-with-ai-agents/ovok-skill.mdx"},{"$id":"(developer-resources)/working-with-ai-agents/mcp-server.mdx","type":"page","name":"Connect the MCP server","description":"Connect Claude, ChatGPT, VS Code or any MCP client to an Ovok project with OAuth, and the limits that apply.","icon":"$undefined","url":"/working-with-ai-agents/mcp-server","$ref":"(developer-resources)/working-with-ai-agents/mcp-server.mdx"},{"$id":"(developer-resources)/working-with-ai-agents/mcp-tools.mdx","type":"page","name":"MCP tools","description":"Every tool the Ovok MCP server offers, with its inputs, for project setup, members, apps, Signals, request logs, usage, FHIR data, CMS content, translations and CMS API keys.","icon":"$undefined","url":"/working-with-ai-agents/mcp-tools","$ref":"(developer-resources)/working-with-ai-agents/mcp-tools.mdx"},{"$id":"(developer-resources)/working-with-ai-agents/docs-for-agents.mdx","type":"page","name":"Docs for AI agents","description":"Give an agent the current Ovok docs as Markdown, through the llms.txt router, topic bundles, page Markdown and the page manifest.","icon":"$undefined","url":"/working-with-ai-agents/docs-for-agents","$ref":"(developer-resources)/working-with-ai-agents/docs-for-agents.mdx"},{"$id":"(developer-resources)/working-with-ai-agents/prompting-and-review.mdx","type":"page","name":"Prompting and review","description":"Give a coding agent enough context, work through an Ovok feature step by step, and review what it produces.","icon":"$undefined","url":"/working-with-ai-agents/prompting-and-review","$ref":"(developer-resources)/working-with-ai-agents/prompting-and-review.mdx"},{"$id":"_56","type":"separator","icon":"$undefined","name":"Compliance"},{"$id":"_57","type":"page","icon":"$undefined","name":"Security and data hosting","url":"https://actimi.com/pricing","external":"$undefined"}],"$id":"(developer-resources)","$ref":{"folder":"(developer-resources)","meta":"(developer-resources)/meta.json"},"icon":"$undefined"}],"fallback":{"type":"root","$ref":{"folder":"","meta":"$undefined"},"$id":"fallback:root","name":"Docs","description":"$undefined","children":[{"type":"folder","name":"Api reference","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Api","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Operations","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Slim","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Threshold","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Slim/Threshold/Patient","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"fallback:(api-reference)/api/(operations)/slim/threshold/patient/get-patient-effective-threshold.mdx","type":"page","name":"$L22a","description":"$22b","icon":"$undefined","url":"/api/slim/threshold/patient/get-patient-effective-threshold","$ref":"(api-reference)/api/(operations)/slim/threshold/patient/get-patient-effective-threshold.mdx"},{"$id":"fallback:(api-reference)/api/(operations)/slim/threshold/patient/update-patient-threshold.mdx","type":"page","name":"$L22c","description":"$22d","icon":"$undefined","url":"/api/slim/threshold/patient/update-patient-threshold","$ref":"(api-reference)/api/(operations)/slim/threshold/patient/update-patient-threshold.mdx"},{"$id":"fallback:(api-reference)/api/(operations)/slim/threshold/patient/get-patient-vital-thresholds.mdx","type":"page","name":"$L22e","description":"$22f","icon":"$undefined","url":"/api/slim/threshold/patient/get-patient-vital-thresholds","$ref":"(api-reference)/api/(operations)/slim/threshold/patient/get-patient-vital-thresholds.mdx"},{"$id":"fallback:(api-reference)/api/(operations)/slim/threshold/patient/remove-a-patient-vital-threshold.mdx","type":"page","name":"$L230","description":"$231","icon":"$undefined","url":"/api/slim/threshold/patient/remove-a-patient-vital-threshold","$ref":"(api-reference)/api/(operations)/slim/threshold/patient/remove-a-patient-vital-threshold.mdx"},{"$id":"fallback:(api-reference)/api/(operations)/slim/threshold/patient/set-a-patient-vital-threshold.mdx","type":"page","name":"$L232","description":"$233","icon":"$undefined","url":"/api/slim/threshold/patient/set-a-patient-vital-threshold","$ref":"(api-reference)/api/(operations)/slim/threshold/patient/set-a-patient-vital-threshold.mdx"}],"$id":"fallback:(api-reference)/api/(operations)/slim/threshold/patient","$ref":{"folder":"(api-reference)/api/(operations)/slim/threshold/patient","meta":"(api-reference)/api/(operations)/slim/threshold/patient/meta.json"},"icon":"$undefined"},{"type":"folder","name":"Slim/Threshold/v2","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"fallback:(api-reference)/api/(operations)/slim/threshold/v2/get-current-org-threshold-v2.mdx","type":"page","name":"$L234","description":"$235","icon":"$undefined","url":"/api/slim/threshold/v2/get-current-org-threshold-v2","$ref":"(api-reference)/api/(operations)/slim/threshold/v2/get-current-org-threshold-v2.mdx"},{"$id":"fallback:(api-reference)/api/(operations)/slim/threshold/v2/update-org-threshold-v2.mdx","type":"page","name":"$L236","description":"$237","icon":"$undefined","url":"/api/slim/threshold/v2/update-org-threshold-v2","$ref":"(api-reference)/api/(operations)/slim/threshold/v2/update-org-threshold-v2.mdx"}],"$id":"fallback:(api-reference)/api/(operations)/slim/threshold/v2","$ref":{"folder":"(api-reference)/api/(operations)/slim/threshold/v2","meta":"(api-reference)/api/(operations)/slim/threshold/v2/meta.json"},"icon":"$undefined"}],"$id":"fallback:(api-reference)/api/(operations)/slim/threshold","$ref":{"folder":"(api-reference)/api/(operations)/slim/threshold","meta":"$undefined"},"icon":"$undefined"}],"$id":"fallback:(api-reference)/api/(operations)/slim","$ref":{"folder":"(api-reference)/api/(operations)/slim","meta":"$undefined"},"icon":"$undefined"}],"$id":"fallback:(api-reference)/api/(operations)","$ref":{"folder":"(api-reference)/api/(operations)","meta":"$undefined"},"icon":"$undefined"}],"$id":"fallback:(api-reference)/api","$ref":{"folder":"(api-reference)/api","meta":"$undefined"},"icon":"$undefined"}],"$id":"fallback:(api-reference)","$ref":{"folder":"(api-reference)","meta":"$undefined"},"icon":"$undefined"},{"type":"folder","name":"Sdks","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Web sdk","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"type":"folder","name":"Core","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"fallback:(sdks)/web-sdk/core/authentication.mdx","type":"page","name":"Authentication","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/authentication","$ref":"(sdks)/web-sdk/core/authentication.mdx"},{"$id":"fallback:(sdks)/web-sdk/core/measurements-and-health-data.mdx","type":"page","name":"Measurements and health data","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/measurements-and-health-data","$ref":"(sdks)/web-sdk/core/measurements-and-health-data.mdx"},{"$id":"fallback:(sdks)/web-sdk/core/offline-measurement-saves.mdx","type":"page","name":"Offline measurement saves","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/offline-measurement-saves","$ref":"(sdks)/web-sdk/core/offline-measurement-saves.mdx"},{"$id":"fallback:(sdks)/web-sdk/core/offline-measurements.mdx","type":"page","name":"Offline measurements","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/offline-measurements","$ref":"(sdks)/web-sdk/core/offline-measurements.mdx"},{"type":"folder","name":"Hooks","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"fallback:(sdks)/web-sdk/core/hooks/use-client.mdx","type":"page","name":"useClient","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/hooks/use-client","$ref":"(sdks)/web-sdk/core/hooks/use-client.mdx"},{"$id":"fallback:(sdks)/web-sdk/core/hooks/use-observations.mdx","type":"page","name":"useObservations","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/hooks/use-observations","$ref":"(sdks)/web-sdk/core/hooks/use-observations.mdx"},{"$id":"fallback:(sdks)/web-sdk/core/hooks/use-patient-questionnaire-responses.mdx","type":"page","name":"usePatientQuestionnaireResponses","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/hooks/use-patient-questionnaire-responses","$ref":"(sdks)/web-sdk/core/hooks/use-patient-questionnaire-responses.mdx"},{"$id":"fallback:(sdks)/web-sdk/core/hooks/use-save-measurement.mdx","type":"page","name":"useSaveMeasurement","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/hooks/use-save-measurement","$ref":"(sdks)/web-sdk/core/hooks/use-save-measurement.mdx"}],"$id":"fallback:(sdks)/web-sdk/core/hooks","$ref":{"folder":"(sdks)/web-sdk/core/hooks","meta":"$undefined"},"icon":"$undefined"},{"type":"folder","name":"Measurements","root":"$undefined","defaultOpen":"$undefined","description":"$undefined","collapsible":"$undefined","children":[{"$id":"fallback:(sdks)/web-sdk/core/measurements/blood-glucose.mdx","type":"page","name":"Blood glucose","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/measurements/blood-glucose","$ref":"(sdks)/web-sdk/core/measurements/blood-glucose.mdx"},{"$id":"fallback:(sdks)/web-sdk/core/measurements/blood-pressure.mdx","type":"page","name":"Blood pressure","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/measurements/blood-pressure","$ref":"(sdks)/web-sdk/core/measurements/blood-pressure.mdx"},{"$id":"fallback:(sdks)/web-sdk/core/measurements/body-weight.mdx","type":"page","name":"Body weight","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/measurements/body-weight","$ref":"(sdks)/web-sdk/core/measurements/body-weight.mdx"},{"$id":"fallback:(sdks)/web-sdk/core/measurements/ecg.mdx","type":"page","name":"ECG","description":"This page has moved.","icon":"$undefined","url":"/web-sdk/core/measurements/ecg","$ref":"(sdks)/web-sdk/core/measurements/ecg.mdx"}],"$id":"fallback:(sdks)/web-sdk/core/measurements","$ref":{"folder":"(sdks)/web-sdk/core/measurements","meta":"$undefined"},"icon":"$undefined"}],"$id":"fallback:(sdks)/web-sdk/core","$ref":{"folder":"(sdks)/web-sdk/core","meta":"$undefined"},"icon":"$undefined"}],"$id":"fallback:(sdks)/web-sdk","$ref":{"folder":"(sdks)/web-sdk","meta":"$undefined"},"icon":"$undefined"}],"$id":"fallback:(sdks)","$ref":{"folder":"(sdks)","meta":"$undefined"},"icon":"$undefined"}]}},"children":"$L238"}]]}],"p":false,"v":null},"c":"$Q239"}]]

URL

QueryParamsCopy Anchor Link

On this page

QueryParams