Change a charge
- Sandbox: available
- On your own host? Choose https://{host} in the playground.
Changes a charge that is not billed yet: its status, its quantity or its price. Fields left out stay as they are.
Scope: the caller's project, with PATIENT_BILLING_ENABLED on.
Behaviour
- Your access policy must grant
patient_billing_chargesupdateand let you read the charge's patient, else 403PATIENT_BILLING_NOT_ALLOWED. A charge you cannot see answers 404CHARGE_NOT_FOUND. statusisbillable,not-billable(not to be billed) orentered-in-error. A billed charge no longer changes: 409CHARGE_BILLED.priceOverridesets the unit price and needs anoverrideReason;priceOverride: nullreturns the charge to the price list, as it applies on the day of the service, else 422CHARGE_PRICE_MISSING.- Changes to one patient's charges run one at a time: another still running answers 409; send yours again.
If-Match: W/"<version>"is optional. With it, the change lands only on that version, else 412CHARGE_VERSION_MISMATCH.
Example
curl -X PATCH 'https://api.sandbox.ovok.com/v1/patient-billing/charges/<chargeId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'If-Match: W/"1"' \ -H 'Content-Type: application/json' \ -d '{ "status": "not-billable" }'bearerAuthorizationBearer <JWT>chargeId*stringThe charge id.
^[A-Za-z0-9\-.]{1,64}$application/json- body
status?string"billable""not-billable""entered-in-error"quantity?integer1 <= value <= 9999priceOverride?null returns the charge to the price list.
overrideReason?stringWhy the price list does not apply. Required with priceOverride.
1 <= length <= 200nullThe charge as changed.
application/json- response
id*stringversion*stringSend it as If-Match: W/"<version>" to change only this version.
patientId*stringclinicId*stringaccountId*stringidentifier*status*stringbillable until billed; billed, not-billable or entered-in-error.
code*occurredAt*stringquantity*numberunitPrice*total*Unit price times quantity.
overrideReason*stringWhy the price list did not apply; null when it did.
enteredAt*stringcurl -X PATCH 'https://api.sandbox.ovok.com/v1/patient-billing/charges/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string", "version": "string", "patientId": "string", "clinicId": "string", "accountId": "string", "identifier": { "system": "string", "value": "string" }, "status": "string", "code": { "system": "string", "code": "string", "display": "string" }, "occurredAt": "string", "quantity": 0, "unitPrice": { "value": 0, "currency": "string" }, "total": { "value": 0, "currency": "string" }, "overrideReason": "string", "enteredAt": "string"}Get a charge GET
Reads one charge. **Scope:** the caller's project, with `PATIENT_BILLING_ENABLED` on. ## Behaviour - Your access policy must grant `patient_billing_charges` `read`, else **403** `PATIENT_BILLING_NOT_ALLOWED`. - A charge whose patient you cannot read answers **404** `CHARGE_NOT_FOUND`. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/patient-billing/charges/<chargeId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```
List a patient's claims GET
Lists the patient's claims, 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_claims` `read` and let you read the patient, else **403** `PATIENT_BILLING_NOT_ALLOWED` or **404** `PATIENT_BILLING_PATIENT_NOT_FOUND`. - Items leave out the insurer's answer and payments; read a claim for them. - `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>/claims' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```