Record an eligibility check
- Sandbox: available
- On your own host? Choose https://{host} in the playground.
Records a check that the coverage is in force, as the clinic ran it, such as the health card's online check in its practice software: a FHIR CoverageEligibilityRequest and the insurer's CoverageEligibilityResponse. Ovok does not reach the insurer itself.
Scope: the caller's project, with PATIENT_BILLING_ENABLED on.
Behaviour
- Your access policy must grant
patient_billing_claimscreateand let you read the patient, else 403PATIENT_BILLING_NOT_ALLOWED. A coverage you cannot see answers 404COVERAGE_NOT_FOUND. - A self-pay coverage has no insurer: 422
COVERAGE_NOT_INSURED.clinicIdmust be a clinic the patient is enrolled with, else 422BILLING_CLINIC_INVALID. inForceis what the insurer answered;outcome: errorrecords a check that failed. Answers 201 withLocation: /v1/patient-billing/eligibility-checks/<id>.identifieris optional. With it, the same identifier for the same patient again answers the check already recorded, with 200.
Example
curl -X POST 'https://api.sandbox.ovok.com/v1/patient-billing/coverages/<coverageId>/eligibility-checks' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "clinicId": "<clinicId>", "servicedOn": "2026-11-18", "outcome": "complete", "inForce": true }'bearerAuthorizationBearer <JWT>coverageId*stringThe coverage id.
^[A-Za-z0-9\-.]{1,64}$application/json- body
identifier?Your id for the check: the same identifier again is the same check.
nullclinicId*stringThe clinic (Organization) that checked; one the patient is enrolled with.
^[A-Za-z0-9\-.]{1,64}$checkedAt?stringWhen the check ran; now when left out.
date-timenullservicedOn?stringThe day of service the check was for.
nulloutcome?stringcomplete when the insurer answered, error when the check failed.
"complete""complete""error"inForce*booleanWhether the insurer confirmed the coverage is in force.
disposition?stringThe insurer's message, if any.
1 <= length <= 200nullA check with this identifier was recorded before; this is it.
application/json- response
id*stringversion*stringSend it as If-Match: W/"<version>" to change only this version.
responseId*stringpatientId*stringcoverageId*stringclinicId*stringinsurer*checkedAt*stringservicedOn*stringoutcome*stringinForce*booleandisposition*stringcurl -X POST 'https://api.sandbox.ovok.com/v1/patient-billing/coverages/string/eligibility-checks' \ -H 'Content-Type: application/json' \ -d '{ "clinicId": "string", "inForce": true}'{ "id": "string", "version": "string", "responseId": "string", "patientId": "string", "coverageId": "string", "clinicId": "string", "insurer": { "id": "string", "ik": "string", "name": "string" }, "checkedAt": "string", "servicedOn": "string", "outcome": "string", "inForce": true, "disposition": "string"}List a patient's benefit statements GET
Lists what the patient's insurers decided on their claims, latest first: FHIR `ExplanationOfBenefit` statements, each with the services claimed, what was paid per category and the payment. **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, the same as the patient's invoices, so patients read their own statements. Else **403** `PATIENT_BILLING_NOT_ALLOWED` or **404** `PATIENT_BILLING_PATIENT_NOT_FOUND`. - A statement exists once the insurer's answer to a claim is recorded, and follows it when it changes. - `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>/benefit-statements' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```
Get an eligibility check GET
Reads one eligibility check and its answer. **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 check whose patient you cannot read answers **404** `ELIGIBILITY_CHECK_NOT_FOUND`. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/patient-billing/eligibility-checks/<checkId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```