ℹ️In Halaxy, HealthcareService is referred to as the appointment type, not the fee added to the appointment. Appointment types are appointment placeholders that can be used for bookings without necessarily adding a fee, but can also be linked to a fee.
For more information, see article: Guide to appointment types
| Endpoint | Operation | Description |
|---|
GET /main/HealthcareService | List HealthcareService | Retrieves a list or collection of appointment types in a practice group |
GET /main/HealthcareService/{id} | Get HealthcareService | Retrieves an individual appointment type |
Property | Description |
|---|
id | string
The appointment type identifier
|
active | boolean
Whether the appointment type is active (iffalse, the appointment type is archived)
|
providedBy | Reference(Organization)
The practice group
"reference": "https://au-api.halaxy.com/main/Organization/OG-30263631",
"type": "Organization"
|
name | string
The name of the appointment type
|
comment | string
Description of the appointment type as added to the Notes field
|
valueQuantity | HALAXY API EXTENSION
The duration of the appointment type in minutes
value": 60,
"unit": "minute",
"system": "http://unitsofmeasure.org"
|
healthcare-service-allow-online-booking | HALAXY API EXTENSION
The setting that determines if this appointment type can be booked online in the online bookings page
"No"
This appointment type is not available in online bookings
"Yes - any bookable appointment time"
This appointment type is available to book online at any available timeslot
"Yes - only appointments matching the type"
This appointment type is available to book online only for timeslots specifically blocked in the calendar for this appointment type.
|
healthcare-service-max-patients | HALAXY API EXTENSION
The number of patients that can book into a single appointment using this appointment type (recommended for group bookings)
If the appointment is only for single patients, this should be set to 1. |
