Patient billing

Get a billing account

  • Sandbox: available
  • On your own host? Choose https://{host} in the playground.
GET
/v1/patient-billing/accounts/{accountId}

Gets one billing account.

Scope: the caller's project, with PATIENT_BILLING_ENABLED on.

Behaviour

  • Your access policy must grant patient_billing_invoices read and let you read the account's patient. An account you cannot see answers 404 ACCOUNT_NOT_FOUND.

Example

curl 'https://api.sandbox.ovok.com/v1/patient-billing/accounts/<accountId>' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Authorization

bearer
headerAuthorizationBearer <JWT>

Path Parameters

accountId*string

The account id.

Match^[A-Za-z0-9\-.]{1,64}$

Response Body

The billing account.

application/json
  1. response
id*string
version*string

Send it as If-Match: W/"<version>" to change only this version.

patientId*string
status*string
clinicId*string

The clinic whose charges go on it; null for the patient's own account.

coverageIds*array<string>

The coverages the account bills against, first first.

Example Request
curl -X GET 'https://api.sandbox.ovok.com/v1/patient-billing/accounts/string'
Example Response
{  "id": "string",  "version": "string",  "patientId": "string",  "status": "string",  "clinicId": "string",  "coverageIds": [    "string"  ]}

List a patient's billing accounts GET

Lists the patient's billing accounts: FHIR `Account` resources of type `PBILLACCT` whose subject is the patient. Ovok makes one per patient, with the first plan or invoice, and it names the plan coverage. Each clinic that enters a charge for the patient gets its own account too: `clinicId` names the clinic, and `coverageIds` the patient's coverages in order. **Scope:** the caller's project, with `PATIENT_BILLING_ENABLED` on. ## Behaviour - Your access policy must grant `patient_billing_invoices` `read` and let you read the patient, else **403** `PATIENT_BILLING_NOT_ALLOWED` or **404** `PATIENT_BILLING_PATIENT_NOT_FOUND`. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/patient-billing/patients/<patientId>/accounts' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```

List a patient's invoices GET

Lists the patient's invoices, latest first, a page at a time. **Scope:** the caller's project, with `PATIENT_BILLING_ENABLED` on. ## Behaviour - Your access policy must grant `patient_billing_invoices` `read` and let you read the patient, else **403** `PATIENT_BILLING_NOT_ALLOWED` or **404** `PATIENT_BILLING_PATIENT_NOT_FOUND`. - `limit` is 1 to 100 (30 when left out). Send `nextCursor` back as `cursor` for the next page; a cursor no page gave answers **400** `PATIENT_BILLING_CURSOR_INVALID`. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/patient-billing/patients/<patientId>/invoices?limit=30' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```