List a patient's claims
- Sandbox: available
- On your own host? Choose https://{host} in the playground.
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_claimsreadand let you read the patient, else 403PATIENT_BILLING_NOT_ALLOWEDor 404PATIENT_BILLING_PATIENT_NOT_FOUND. - Items leave out the insurer's answer and payments; read a claim for them.
limitis 1 to 100 (30 when left out). SendnextCursorback ascursorfor the next page; a cursor no page gave answers 400PATIENT_BILLING_CURSOR_INVALID.
Example
curl 'https://api.sandbox.ovok.com/v1/patient-billing/patients/<patientId>/claims' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'bearerAuthorizationBearer <JWT>patientId*stringThe patient id.
^[A-Za-z0-9\-.]{1,64}$cursor?stringnextCursor from the previous page.
1 <= length <= 4000limit?integer1 <= value <= 10030The patient's claims, latest first.
application/json- response
items*array<>nextCursor*stringcurl -X GET 'https://api.sandbox.ovok.com/v1/patient-billing/patients/string/claims'{ "items": [ { "id": "string", "version": "string", "patientId": "string", "clinicId": "string", "identifier": { "system": "string", "value": "string" }, "status": "string", "type": "string", "createdAt": "string", "insurer": { "id": "string", "ik": "string", "name": "string" }, "coverageIds": [ "string" ], "items": [ { "sequence": 0, "chargeId": "string", "code": { "system": "string", "code": "string", "display": "string" }, "servicedOn": "string", "quantity": 0, "unitPrice": { "value": 0, "currency": "string" }, "net": { "value": 0, "currency": "string" } } ], "total": { "value": 0, "currency": "string" }, "submission": { "channel": "string", "submittedAt": "string" } } ], "nextCursor": "string"}Change a charge PATCH
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_charges` `update` and let you read the charge's patient, else **403** `PATIENT_BILLING_NOT_ALLOWED`. A charge you cannot see answers **404** `CHARGE_NOT_FOUND`. - `status` is `billable`, `not-billable` (not to be billed) or `entered-in-error`. A billed charge no longer changes: **409** `CHARGE_BILLED`. - `priceOverride` sets the unit price and needs an `overrideReason`; `priceOverride: null` returns the charge to the price list, as it applies on the day of the service, else **422** `CHARGE_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 **412** `CHARGE_VERSION_MISMATCH`. ## Example ```bash 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" }' ```
Build a claim from charges POST
Builds a claim to an insurer from the patient's billable charges at one clinic, as a FHIR `Claim`. Its insurer is that of the patient's first insurance coverage in force for the services; `insurance` lists every such coverage in order, the first as focal. The charges turn `billed` in the same commit. **Scope:** the caller's project, with `PATIENT_BILLING_ENABLED` on. ## Behaviour - Your access policy must grant `patient_billing_claims` `create` and let you read the patient, else **403** `PATIENT_BILLING_NOT_ALLOWED` or **404** `PATIENT_BILLING_PATIENT_NOT_FOUND`. - `clinicId` must be a clinic the patient is enrolled with, else **422** `BILLING_CLINIC_INVALID`. The clinic is the claim's provider. - Only statutory and private coverages count, and only those whose `period` covers a day of the services. Without one, **422** `COVERAGE_NOT_INSURED`. - `chargeIds` and the charge rules are those of issuing an invoice: 49 at most, one currency, **409** `CHARGE_NOT_BILLABLE` or `NO_BILLABLE_CHARGES`. - Building a claim sends nothing. Submit it (`POST /v1/patient-billing/claims/<claimId>/submission`) to get it to the insurer. - `identifier` is optional. With it, the same identifier for the same patient again answers the claim already built, with **200**. A new claim answers **201** with `Location: /v1/patient-billing/claims/<id>`. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/patient-billing/patients/<patientId>/claims' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "clinicId": "<clinicId>", "chargeIds": null, "type": "professional" }' ```