halaxy_list_patients
List or search patients
List or search patient records (demographics and contact details; HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Patient.
Parametersidnamepagesortcountemailgivenphonefamilystatuscreatedinclude+3 more
halaxy_list_practitioners
List practitioners
List or search practitioners and administrators of the practice group (ids look like PR-12345). Filters combine with AND. Paged: pass next_page as page. GET /main/Practitioner.
Parametersidnamepagesortcountemailgivenactivefamilyprofilelast_updated
halaxy_list_practitioner_roles
List practitioner roles (clinic locations)
List or search practitioner roles: a practitioner's association with one clinic location (the id used when booking and for clinical notes). Filters combine with AND. Paged: pass next_page as page. GET /main/PractitionerRole.
Parametersidpagecountincludeprofilelast_updatedorganizationpractitionerprovider_number
halaxy_list_organizations
List organizations and clinics
List or search the practice group, its clinic locations, funders and external practices (practice group ids look like PG-12345). Filters combine with AND. Paged: pass next_page as page. GET /main/Organization.
Parametersidnamepagecountprofilelast_updated
halaxy_list_appointments
List appointments
List or search appointments (HEALTH DATA: names the patient). Filters combine with AND. Paged: pass next_page as page. GET /main/Appointment.
Parametersiddatepagesortcountcreatedincludepatientpart_statuslast_updatedorganizationpractitioner+2 more
halaxy_list_schedules
List practitioner schedules
List or search schedules: containers of bookable time slots per practitioner. Filters combine with AND. Paged: pass next_page as page. GET /main/Schedule.
Parametersidpageactorcountactiveincludelast_updated
halaxy_list_slots
List time slots
List or search time slots of practitioner schedules (free or busy). Filters combine with AND. Paged: pass next_page as page. GET /main/Slot.
Parametersidendpagecountstartstatusincludedurationschedulelast_updatedorganizationpractitioner+1 more
halaxy_list_healthcare_services
List appointment types
List or search appointment types used by the practice group, clinics and practitioners. Filters combine with AND. Paged: pass next_page as page. GET /main/HealthcareService.
Parametersidnamepagecountactivelast_updated
halaxy_list_fees
List fees
List or search fees (ChargeItemDefinition): the services and products a practice charges for. Filters combine with AND. Paged: pass next_page as page. GET /main/ChargeItemDefinition.
Parametersidcodepagecounttitlecreatedpublishercontext_typelast_updatedproperty_group_status
halaxy_list_coverage
List patient coverage (claim details)
List or search patients' health fund membership and claim details (HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Coverage.
Parametersidpagesortcountpayorcreatedincludesubscriberbeneficiarylast_updatedsubscriber_idcoverage_organization
halaxy_list_invoices
List invoices
List or search invoices of the practice group. Filters combine with AND. Paged: pass next_page as page. GET /main/Invoice.
Parametersidpagecountstatuscreatedincluderecipienttotal_paidlast_updatedorganizationpractitionertotal_balance+2 more
halaxy_list_invoice_lines
List invoice lines
List or search invoice lines: single fees on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/InvoiceLine.
Parametersidpagecountamountfundercreatedincludeinvoicesubjectcoveragereferralperformer+1 more
halaxy_list_payment_transactions
List payment transactions
List or search payment transactions recorded on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/PaymentTransaction.
Parametersidpagecountcreatedlast_updated
halaxy_list_referrals
List referrals
List or search referrals from one healthcare provider to another (HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Referral.
Parametersidpagesortcountcreatedincludesubjectcoveragelast_updated
halaxy_list_referral_definitions
List referral templates
List or search referral templates with preset properties. Filters combine with AND. Paged: pass next_page as page. GET /main/ReferralDefinition.
Parametersidpagecountlast_updatedfunding_organization
halaxy_get_patient
Get a patient
Fetch a patient record (HEALTH DATA) by id. GET /main/Patient/{id}.
Parametersidrequired
halaxy_get_practitioner
Get a practitioner
Fetch a practitioner or administrator by id. GET /main/Practitioner/{id}.
Parametersidrequired
halaxy_get_practitioner_role
Get a practitioner role
Fetch a practitioner role at a clinic location by id. GET /main/PractitionerRole/{id}.
Parametersidrequired
halaxy_get_organization
Get an organization
Fetch a practice group, clinic, funder or external practice by id. GET /main/Organization/{id}.
Parametersidrequired
halaxy_get_appointment
Get an appointment
Fetch an appointment with its participants and statuses (HEALTH DATA) by id. GET /main/Appointment/{id}.
Parametersidrequired
halaxy_get_schedule
Get a schedule
Fetch a practitioner schedule by id. GET /main/Schedule/{id}.
Parametersidrequired
halaxy_get_slot
Get a time slot
Fetch a time slot by id. GET /main/Slot/{id}.
Parametersidrequired
halaxy_get_healthcare_service
Get an appointment type
Fetch an appointment type by id. GET /main/HealthcareService/{id}.
Parametersidrequired
Fetch a fee (ChargeItemDefinition) by id. GET /main/ChargeItemDefinition/{id}.
Parametersidrequired
halaxy_get_coverage
Get patient coverage
Fetch a patient's coverage (claim details) record by id. GET /main/Coverage/{id}.
Parametersidrequired
halaxy_get_invoice
Get an invoice
Fetch an invoice by id. GET /main/Invoice/{id}.
Parametersidrequired
halaxy_get_invoice_line
Get an invoice line
Fetch an invoice line by id. GET /main/InvoiceLine/{id}.
Parametersidrequired
halaxy_get_payment_transaction
Get a payment transaction
Fetch a payment transaction by id. GET /main/PaymentTransaction/{id}.
Parametersidrequired
halaxy_get_referral
Get a referral
Fetch a referral (HEALTH DATA) by id. GET /main/Referral/{id}.
Parametersidrequired
halaxy_get_referral_definition
Get a referral template
Fetch a referral template by id. GET /main/ReferralDefinition/{id}.
Parametersidrequired
halaxy_find_available_appointments
Find available appointment times
Find free appointment times between start and end for a given duration, respecting each practitioner's online booking preferences (buffer time, lead time, advance booking limit). Narrow it with practitioner, practitioner_role or organization. GET /main/Appointment/$find.
Parametersendrequiredshowsortstartrequireddurationrequiredemergencyorganizationpractitionerapply_buffer_timepractitioner_role
halaxy_create_patient
Create a patient
Writes to the live Halaxy account. Creates a new patient record (always a new one: search with halaxy_list_patients first to avoid a duplicate). Pass managing_organization (the practice group id, e.g. PG-12345, from halaxy_list_organizations) if Halaxy asks for it. POST /main/Patient.
Parametersemailgivenrequiredfamilyrequiredgendermobileaddressbirth_datepreferred_namemanaging_organization
halaxy_create_appointment
Book an appointment
Writes to the live Halaxy account. Books an appointment for a patient with a practitioner at a clinic (the practitioner role). Halaxy also creates the invoice, clinical note and reminder. Use halaxy_find_available_appointments for free times. By default a double booking is refused (HTTP 409, nothing created). POST /main/Appointment/$book.
Parametersendrequiredstartrequiredstatuspatient_idrequiredpractitioner_role_idrequiredhealthcare_service_idfail_on_double_bookingcharge_item_definition_id
halaxy_update_appointment_status
Update an appointment status
Writes to the live Halaxy account. Sets the patient's status on an appointment (shown in the Halaxy calendar), for example arrived, attended, confirmed or cancelled. "cancelled (no charge)" also sets the invoice to $0. For a group appointment pass patient_id to say whose status changes. PATCH /main/Appointment/{id}.
Parametersstatusrequiredpatient_idappointment_idrequired
halaxy_create_clinical_note
Create a draft clinical note
Writes to the live Halaxy account. Adds a clinical note to a patient's record as a DRAFT (preliminary); the practitioner reviews and publishes it in Halaxy. The author is a PractitionerRole (practitioner at a clinic). Only HTML text is supported. POST /main/DocumentReference.
Parametershtmlrequiredtitlerequiredpatient_idrequiredpractitioner_role_idrequired