Patient billing

List prices

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

Lists the project's price list, a page at a time: one price per code, each a FHIR ChargeItemDefinition with its unit price and the period it applies in.

Scope: any member of the caller's project, with PATIENT_BILLING_ENABLED on.

Behaviour

  • Only prices on the list are listed; a removed price is retired and left out.
  • code=<system>|<code> answers only that code's price.
  • 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

curl 'https://api.sandbox.ovok.com/v1/patient-billing/prices?code=http://fhir.de/CodeSystem/kbv/ebm|03040' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Authorization

bearer
headerAuthorizationBearer <JWT>

Query Parameters

cursor?string

nextCursor from the previous page.

Length1 <= length <= 4000
limit?integer
Range1 <= value <= 100
Default30
code?string

Only the price of this code, as <system>|<code>.

Match^[^|\s]+\|[^|\s]+$

Response Body

The project's price list, one price per code.

application/json
  1. response
items*array<>
nextCursor*string
Example Request
curl -X GET 'https://api.sandbox.ovok.com/v1/patient-billing/prices'
Example Response
{  "items": [    {      "id": "string",      "version": "string",      "status": "string",      "code": {        "system": "string",        "code": "string",        "display": "string"      },      "amount": {        "value": 0,        "currency": "string"      },      "period": {        "start": "string",        "end": "string"      }    }  ],  "nextCursor": "string"}

Get an invoice GET

Gets one invoice. **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 invoice's patient. An invoice you cannot see answers **404** `INVOICE_NOT_FOUND`. - An invoice issued from charges names its `clinicId`, and each line its `chargeId` and `amount`. A recorded payment has neither. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/patient-billing/invoices/<invoiceId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```

Set a price POST

Sets the price of one code: an app plan coding, or a care service code such as GOÄ or EBM. A code has one price in the project. **Scope:** a project admin or an admin ClientApplication, in a project with `PATIENT_BILLING_ENABLED` on. Anyone else: **403** `PATIENT_BILLING_NOT_ALLOWED`. ## Behaviour - A code without a price gets one: **201** with `Location: /v1/patient-billing/prices/<id>`. - A code with a price has it replaced: **200**. A removed price is back on the list. - `amount` is the price of one unit. `period` says from and until which day it applies; left out, it always applies. - A charge keeps the unit price it was entered at, so changing a price changes no charge already entered. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/patient-billing/prices' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "code": { "system": "http://fhir.de/CodeSystem/kbv/ebm", "code": "03040", "display": "Zusatzpauschale Hausarzt" }, "amount": { "value": 15.81, "currency": "EUR" }, "period": { "start": "2026-01-01", "end": null } }' ```