Patient billing

Set a price

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

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

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 } }'

Authorization

bearer
headerAuthorizationBearer <JWT>

Request Body

application/json
  1. body
code*

What is priced: an app plan coding, or a service code such as GOÄ or EBM.

amount*

The price of one unit.

period?

When the price applies; open-ended when left out.

Defaultnull

Response Body

The code had a price; it is replaced.

application/json
  1. response
id*string
version*string

Send it as If-Match: W/"<version>" to change only this version.

status*string

active on the price list, retired once removed.

code*
amount*

The price of one unit.

period*
Example Request
curl -X POST 'https://api.sandbox.ovok.com/v1/patient-billing/prices' \  -H 'Content-Type: application/json' \  -d '{  "code": {    "system": "http://example.com",    "code": "string"  },  "amount": {    "value": 0,    "currency": "string"  }}'
Example Response
{  "id": "string",  "version": "string",  "status": "string",  "code": {    "system": "string",    "code": "string",    "display": "string"  },  "amount": {    "value": 0,    "currency": "string"  },  "period": {    "start": "string",    "end": "string"  }}