Set a price
- Sandbox: available
- On your own host? Choose https://{host} in the playground.
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.
amountis the price of one unit.periodsays 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 } }'bearerAuthorizationBearer <JWT>application/json- 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.
nullThe code had a price; it is replaced.
application/json- response
id*stringversion*stringSend it as If-Match: W/"<version>" to change only this version.
status*stringactive on the price list, retired once removed.
code*amount*The price of one unit.
period*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" }}'{ "id": "string", "version": "string", "status": "string", "code": { "system": "string", "code": "string", "display": "string" }, "amount": { "value": 0, "currency": "string" }, "period": { "start": "string", "end": "string" }}List prices GET
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 ```bash 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' ```
Get a price GET
Reads one price, on the list or removed. **Scope:** any member of the caller's project, with `PATIENT_BILLING_ENABLED` on. ## Behaviour - `status` is `active` while the price is on the list and `retired` once removed. - A price your project does not hold answers **404** `PRICE_NOT_FOUND`. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/patient-billing/prices/<priceId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```