Patient billing

List health insurers

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

Lists the health insurers a coverage may name: German statutory funds (gesetzliche Krankenkassen) with their IK, and private insurers, with their IK where they have one. Use it to build an insurer picker.

Scope: any signed-in caller, in a project with PATIENT_BILLING_ENABLED on.

Behaviour

  • country is DE, the only one supported; any other answers 422 COUNTRY_UNSUPPORTED.
  • kind keeps only statutory or only private insurers.
  • query matches part of the name, in any case, or the start of the IK.
  • The list is Ovok's insurer directory, refreshed in ovok-core releases.

Example

curl 'https://api.sandbox.ovok.com/v1/patient-billing/insurers?country=DE&kind=statutory&query=tk' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Authorization

bearer
headerAuthorizationBearer <JWT>

Query Parameters

country?string

The country whose insurance rules apply. Only DE today.

Match^[A-Z]{2}$
Default"DE"
kind?string

Only statutory funds or only private insurers.

Value in"statutory""private"
query?string

Part of the name, or the start of the IK.

Lengthlength <= 200

Response Body

The insurers that match, by kind and name.

application/json
  1. response
items*array<>
Example Request
curl -X GET 'https://api.sandbox.ovok.com/v1/patient-billing/insurers'
Example Response
{  "items": [    {      "country": "DE",      "ik": "string",      "name": "string",      "kind": "statutory"    }  ]}

Get organization code GET

Returns the tenant code of the caller's project. Users type the code on sign-in screens to choose their organization. **Auth:** bearer token. **Scope:** the caller's project (from the token). ## Behaviour - The response holds `code` and `projectId`. - If the project has no tenant code, the request fails with 400 (`Tenant code not found`). - If more than one code row exists for a project, the most recently updated one is returned. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/organizations/code' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```

List a patient's coverages GET

Lists a patient's health insurance: their active coverages, in the order they apply, first first. Each is a FHIR `Coverage` in the patient's compartment. The app plan from `/plan` is never among them. **Scope:** the caller's project, with `PATIENT_BILLING_ENABLED` on. ## Behaviour - Your access policy must grant `patient_billing_coverages` `read` and let you read the patient as stored now, so a clinic sees the insurance of the patients enrolled with it. Without the row: **403** `PATIENT_BILLING_NOT_ALLOWED`. A patient you cannot read: **404** `PATIENT_BILLING_PATIENT_NOT_FOUND`. - Project admins and admin ClientApplications may read every patient's. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/patient-billing/patients/<patientId>/coverages' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```