Glossary of Terms

A reference guide for terminology that may differ between Halaxy API and the Halaxy platform

Halaxy API (FHIR)HalaxyDescription
AppointmentappointmentA scheduled meeting between a patient and a practitioner at a specific date and time.
beneficiaryclaimantThe claimant applies as beneficiary if the field is populated. Otherwise, beneficiary defaults to the patient.
ChargeItemDefinitionfeeThe fee is the service or product provided by the practice to patient.
coverageclaim detailsThis refers to the patient's high-level identifiers of their health fund membership (e.g. Medicare card details)
external practitionerprofessional contactA practitioner added to your practice group's Professional Contact list, outside of your Halaxy practice
DocumentReferenceclinical noteThis refers to an individual note in the Clinical Notes tab of a patient profile
HealthcareServiceappointment typeAppointment placeholders you can make available in online bookings, allowing practitioners to receive bookings without a fee selected - learn more
qualificationprofessionThe practitioner's field in the healthcare sector. In Halaxy, you can find the practitioner's profession in Personal > Profile.
recipientinvoice payerThe individual or organization billed on an invoice
Schedulepractice hoursIn Halaxy, a schedule entry is equivalent to the practice hours of a practitioner for a specific clinic. If a practitioner practices at multiple clinics, they will have separate schedule entries for each location. In Halaxy, practice hours can be found in Personal > Locations.
Slotavailable appointment timeThe available time in the day. If there are no appointments, there will only be 1 slot covering the entire day, but as more appointments are booked, the slots will be recalculated so they show where the remaining available times are.
telecomcontact detailsA phone number or email address