{info} WARNING You are browsing the documentation for an old version of ProviderAPI.
Consider upgrading your integration to version 1.1.1
All invoices refer to a specific treatment type by its treatment_type_number
property.
Endpoints in this group can be used to interact with all treatment types that lies within the system.
{info} Requires authentication
List all treatment types for a specific treatment group, an optional coverage group and within a date period.
Treatment group is also known as "Hovedgruppe" in Danish terms.
Coverage group is also known as "Dækningsgruppe" in Danish terms.
If the treatment type has a fixed price it is returned as a integer in DKK otherwise it will be null.
Patient share percentage is returned as a integer between 0-100 or null if this is not defined.
Method | URI | Headers |
---|---|---|
GET | /api/treatment-types |
Accept: application/json Authorization: Bearer your_token |
"treatment_group": "integer|required",
"coverage_group": "integer|optional",
"valid_from": "date(YYYY-mm-dd)|optional",
"valid_to": "date(YYYY-mm-dd)|optional"
If valid_from
is not present we default to the start of the year(YYYY-01-01).
If valid_to
is not present we default to the end of the year(YYYY-12-31).
{success} Example Success Response
Code 200
Content
{
"data": [
{
"id": 8153388,
"treatment_type_number": 510110,
"name": "1. konsultation",
"treatment_group": 51,
"valid_from": "2020-01-01",
"valid_to": "2020-01-31",
"coverage_group": 2,
"fixed_price": 133,
"patient_share_percentage": null
},
{
"id": 8153390,
"treatment_type_number": 510113,
"name": "Opfølgende træningsterapi",
"treatment_group": 51,
"valid_from": "2020-01-01",
"valid_to": "2020-01-31",
"coverage_group": 2,
"fixed_price": null,
"patient_share_percentage": 50
}
]
}
Note ID is an internal ID and could change at any time.
{danger} Error Response
Code 401|422
Content
{
"message": "The given data was invalid.",
"errors": {
"treatment_group": [
"The treatment group field is required."
]
},
"status_code": 422
}