Enable Signals for a Patient
Enroll an existing Patient in Signals so Ovok can forward the Patient's vital-sign data for alert evaluation. Your application calls Ovok; it does not need Signals credentials.
| Method | Path |
|---|---|
POST | /fhir/R4/Patient/:id/$enable-signals |
The unversioned and R5 aliases are /fhir/Patient/:id/$enable-signals and /fhir/R5/Patient/:id/$enable-signals.
Access requirements
Send a valid bearer token. The caller needs the custom signals_config:update capability and Patient update access for the Patient in the caller's project. See Signals route policies for the custom AccessPolicy rows.
| Input | Description |
|---|---|
:id | The Ovok Patient id. The Patient must belong to the caller's project and be accessible under its AccessPolicy. |
| Request body | None. |
Request
curl --request POST \
--url 'https://api.sandbox.ovok.com/fhir/R4/Patient/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21/$enable-signals' \
--header "Authorization: Bearer ${OVOK_TOKEN}"
Successful response
The operation returns 200 after the Patient's Signals enrollment and required delivery setup are complete.
| Response field | Type | Description |
|---|---|---|
patientId | string | Ovok Patient id supplied in the route. |
signalsPatientId | string | Patient id assigned by Signals. |
enabled | boolean | true when enrollment is enabled. |
Retry and failure behavior
The operation is idempotent. If the Patient is already enrolled, Ovok returns the same Signals Patient id and completes any missing enrollment setup. If provisioning fails, Ovok returns 503 signals_mint_failed and does not leave a partial enrollment; retrying the request is safe.
| Status | Meaning |
|---|---|
401 | The access token is missing, invalid, or expired. |
403 | The caller lacks signals_config:update or Patient update access. |
404 | The Patient does not exist in the caller's project or is not accessible to the caller. |
200 | Enrollment is complete; the response contains patientId, signalsPatientId, and enabled: true. |
503 | Signals provisioning did not complete (signals_mint_failed). No partial enrollment is left behind. |
For this operation in the Signals API sidebar, see Enable Signals for a Patient. For the broader enrollment, alert, and threshold workflow, see Working with Signals as a connected part of Ovok.