Halaxy MCP by usefulapi

List or search patient records (demographics and contact details; HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Patient.

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.

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.

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.

List or search appointments (HEALTH DATA: names the patient). Filters combine with AND. Paged: pass next_page as page. GET /main/Appointment.

List or search schedules: containers of bookable time slots per practitioner. Filters combine with AND. Paged: pass next_page as page. GET /main/Schedule.

List or search time slots of practitioner schedules (free or busy). Filters combine with AND. Paged: pass next_page as page. GET /main/Slot.

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.

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.

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.

List or search invoices of the practice group. Filters combine with AND. Paged: pass next_page as page. GET /main/Invoice.

List or search invoice lines: single fees on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/InvoiceLine.

List or search payment transactions recorded on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/PaymentTransaction.

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.

List or search referral templates with preset properties. Filters combine with AND. Paged: pass next_page as page. GET /main/ReferralDefinition.

Fetch a patient record (HEALTH DATA) by id. GET /main/Patient/{id}.

Fetch a practitioner or administrator by id. GET /main/Practitioner/{id}.

Fetch a practitioner role at a clinic location by id. GET /main/PractitionerRole/{id}.

Fetch a practice group, clinic, funder or external practice by id. GET /main/Organization/{id}.

Fetch an appointment with its participants and statuses (HEALTH DATA) by id. GET /main/Appointment/{id}.

Fetch a practitioner schedule by id. GET /main/Schedule/{id}.

Fetch a time slot by id. GET /main/Slot/{id}.

Fetch an appointment type by id. GET /main/HealthcareService/{id}.

Fetch a fee (ChargeItemDefinition) by id. GET /main/ChargeItemDefinition/{id}.

Fetch a patient's coverage (claim details) record by id. GET /main/Coverage/{id}.

Fetch an invoice by id. GET /main/Invoice/{id}.

Fetch an invoice line by id. GET /main/InvoiceLine/{id}.

Fetch a payment transaction by id. GET /main/PaymentTransaction/{id}.

Fetch a referral (HEALTH DATA) by id. GET /main/Referral/{id}.

Fetch a referral template by id. GET /main/ReferralDefinition/{id}.

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.

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.

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.

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}.

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.