Skip to content
MCP server

Halaxy MCP by usefulapi

Read Halaxy patients, appointments, slots and invoices; create patients, appointments…

Install
Runs
Remotely
Version
1.16.0
Listing updated
4 days ago

About Halaxy MCP by usefulapi

Halaxy MCP by usefulapi is an MCP server. It runs as a hosted remote server, so there is nothing to install locally.

Read Halaxy patients, appointments, slots and invoices; create patients, appointments and notes.

Install

Run in a terminal

claude mcp add --transport http halaxy https://halaxy.usefulapi.io/mcp

Add to Settings → Connectors → Add custom connector

https://halaxy.usefulapi.io/mcp
Install in CursorOpens Cursor, which asks you to confirm. Or add it by hand:

Add to ~/.cursor/mcp.json

{
  "mcpServers": {
    "halaxy": {
      "url": "https://halaxy.usefulapi.io/mcp"
    }
  }
}
Install in VS CodeOpens VS Code, which asks you to confirm. Or add it by hand:

Add to .vscode/mcp.json

{
  "servers": {
    "halaxy": {
      "type": "http",
      "url": "https://halaxy.usefulapi.io/mcp"
    }
  }
}

Add to ~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "halaxy": {
      "serverUrl": "https://halaxy.usefulapi.io/mcp"
    }
  }
}

Add to your client's MCP settings (most use this shape)

{
  "mcpServers": {
    "halaxy": {
      "type": "http",
      "url": "https://halaxy.usefulapi.io/mcp"
    }
  }
}

Tools this server provides (35)

Read directly from the server.

halaxy_list_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.
halaxy_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.
halaxy_list_practitioner_roles
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.
halaxy_list_organizations
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.
halaxy_list_appointments
List or search appointments (HEALTH DATA: names the patient). Filters combine with AND. Paged: pass next_page as page. GET /main/Appointment.
halaxy_list_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.
halaxy_list_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.
halaxy_list_healthcare_services
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.
halaxy_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.
halaxy_list_coverage
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.
halaxy_list_invoices
List or search invoices of the practice group. Filters combine with AND. Paged: pass next_page as page. GET /main/Invoice.
halaxy_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.
halaxy_list_payment_transactions
List or search payment transactions recorded on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/PaymentTransaction.
halaxy_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.
halaxy_list_referral_definitions
List or search referral templates with preset properties. Filters combine with AND. Paged: pass next_page as page. GET /main/ReferralDefinition.
halaxy_get_patient
Fetch a patient record (HEALTH DATA) by id. GET /main/Patient/{id}.
halaxy_get_practitioner
Fetch a practitioner or administrator by id. GET /main/Practitioner/{id}.
halaxy_get_practitioner_role
Fetch a practitioner role at a clinic location by id. GET /main/PractitionerRole/{id}.
halaxy_get_organization
Fetch a practice group, clinic, funder or external practice by id. GET /main/Organization/{id}.
halaxy_get_appointment
Fetch an appointment with its participants and statuses (HEALTH DATA) by id. GET /main/Appointment/{id}.
halaxy_get_schedule
Fetch a practitioner schedule by id. GET /main/Schedule/{id}.
halaxy_get_slot
Fetch a time slot by id. GET /main/Slot/{id}.
halaxy_get_healthcare_service
Fetch an appointment type by id. GET /main/HealthcareService/{id}.
halaxy_get_fee
Fetch a fee (ChargeItemDefinition) by id. GET /main/ChargeItemDefinition/{id}.
halaxy_get_coverage
Fetch a patient's coverage (claim details) record by id. GET /main/Coverage/{id}.
halaxy_get_invoice
Fetch an invoice by id. GET /main/Invoice/{id}.
halaxy_get_invoice_line
Fetch an invoice line by id. GET /main/InvoiceLine/{id}.
halaxy_get_payment_transaction
Fetch a payment transaction by id. GET /main/PaymentTransaction/{id}.
halaxy_get_referral
Fetch a referral (HEALTH DATA) by id. GET /main/Referral/{id}.
halaxy_get_referral_definition
Fetch a referral template by id. GET /main/ReferralDefinition/{id}.
halaxy_find_available_appointments
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.
halaxy_create_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.
halaxy_create_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.
halaxy_update_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}.
halaxy_create_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.

Halaxy MCP by usefulapi FAQ

How do I add Halaxy MCP by usefulapi to Claude Code?

Run this command in your terminal: claude mcp add --transport http halaxy https://halaxy.usefulapi.io/mcp