Withdraw a claim
- Sandbox: available
- On your own host? Choose https://{host} in the playground.
Withdraws a claim the insurer has not adjudicated or paid, for example one built from the wrong charges or rejected by the insurer. It is cancelled, its charges turn billable again, and the patient's statement about a rejection is cancelled too, in the same commit.
Scope: the caller's project, with PATIENT_BILLING_ENABLED on.
Behaviour
- Your access policy must grant
patient_billing_claimsupdateand let you read the patient, else 403PATIENT_BILLING_NOT_ALLOWEDor 404CLAIM_NOT_FOUND. - A claim with an answer of outcome
completeorpartial, or with a payment, answers 409CLAIM_ANSWERED. A rejected claim (outcomeerror) may be withdrawn. - A claim already withdrawn answers 204 again. Another change to the patient's charges running at the same time answers 409; send yours again.
Example
curl -X DELETE 'https://api.sandbox.ovok.com/v1/patient-billing/claims/<claimId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'bearerAuthorizationBearer <JWT>claimId*stringThe claim id.
^[A-Za-z0-9\-.]{1,64}$Withdrawn: the claim is cancelled and its charges are billable again.
curl -X DELETE 'https://api.sandbox.ovok.com/v1/patient-billing/claims/string'Get a claim GET
Reads one claim, with the insurer's answer and the payments made on it. **Scope:** the caller's project, with `PATIENT_BILLING_ENABLED` on. ## Behaviour - Your access policy must grant `patient_billing_claims` `read`, else **403** `PATIENT_BILLING_NOT_ALLOWED`. A claim whose patient you cannot read answers **404** `CLAIM_NOT_FOUND`. - `submission` says when and through which channel it was last submitted; `response` is the insurer's answer, null until recorded; `payments` are the insurers' payments allocated to it. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/patient-billing/claims/<claimId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```
Submit a claim POST
Submits a claim through the project's claim channel, and answers what the channel made of it. Today the only channel is `export`: the claim as a FHIR `Bundle` (type `collection`) with the patient's identity (identifiers, name, gender, birth date, address), the coverages, the clinic and the insurers, every reference from one to another pointed at its entry, for the clinic's billing software to send to the insurer. Nothing leaves Ovok. **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** `CLAIM_NOT_FOUND`. - A withdrawn claim answers **409** `CLAIM_CANCELLED`. - The claim records when and through which channel it was submitted. Submitting again exports it again. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/patient-billing/claims/<claimId>/submission' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```