Settings

PATIENT_BILLING_ENABLED

Turns on patient billing and insurance, so a project can store patients' insurance, plans, billing accounts and invoices through /v1/patient-billing.

Turns on patient billing and insurance for the project. Its routes under /v1/patient-billing then store patients' insurance, app plan, billing account and invoices as FHIR Coverage, Account and Invoice.

TypeBoolean setting
Change withPUT /v1/project/settings/PATIENT_BILLING_ENABLED
Read withGET /v1/project/settings
Who can change itProject admin
When unsetOff
ScopeEach project has its own value.
When offEvery /v1/patient-billing route answers 403 PATIENT_BILLING_DISABLED.
curl --request PUT \
  --url 'https://api.sandbox.ovok.com/v1/project/settings/PATIENT_BILLING_ENABLED' \
  --header "Authorization: Bearer ${OVOK_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{"enabled": true}'

What turning it on does

The routes start to answer. The setting writes no resource and creates no policy.

Turning it off stops the routes again. It deletes nothing: the coverages, accounts and invoices stay in FHIR.

Gotchas

  • It grants nobody access. Callers still need the patient_billing_* rows in their access policy, and writing plans and invoices needs a project admin or an admin ClientApplication. See Patient billing access.
  • Check the project. The setting is per project, so PATIENT_BILLING_DISABLED can mean the token belongs to a project where it is still off.

Last updated on

On this page