Skip to main content

Enable Signals for a Patient

MethodPath
POST/fhir/R4/Patient/:id/$enable-signals

Shared authentication, project scope, and response conventions.

Use this for a Patient that already exists in the project and was created without Signals. The unversioned and R5 aliases are also available: /fhir/Patient/:id/$enable-signals and /fhir/R5/Patient/:id/$enable-signals.

RequirementDetails
Access policysignals_config:update and Patient update
RequestNo body; :id is the Ovok/Medplum Patient id
Success200; returns patientId, signalsPatientId, and enabled: true
Retry behaviorIdempotent. If the Patient is already enrolled, Ovok returns the same Signals id and completes any missing enrollment setup.
Failure403 for missing permission; 404 when the Patient cannot be found in the caller's project; 503 signals_mint_failed if provisioning does not complete. A failed operation leaves no partial enrollment, so retrying is safe.
curl --request POST \
--url 'https://api.sandbox.ovok.com/fhir/R4/Patient/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21/$enable-signals' \
--header "Authorization: Bearer ${OVOK_TOKEN}"

This operation is also listed in the Ovok primitives reference.