Halaxy MCP by usefulapi
Read Halaxy patients, appointments, slots and invoices; create patients, appointments and notes.
Should I use this
Quality & Safety
A
Findings (5)
- LOWTool 'halaxy_list_healthcare_services' name length outside 3-30 rangein halaxy_list_healthcare_services
- LOWTool 'halaxy_list_payment_transactions' name length outside 3-30 rangein halaxy_list_payment_transactions
- LOWTool 'halaxy_list_referral_definitions' name length outside 3-30 rangein halaxy_list_referral_definitions
- LOWTool 'halaxy_find_available_appointments' name length outside 3-30 rangein halaxy_find_available_appointments
- LOWTool 'halaxy_update_appointment_status' name length outside 3-30 rangein halaxy_update_appointment_status
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
~14,022Tokens (tool definitions)
~3.0 KBTypical response size
Significant attention impact (10.95% of 128k context)
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"halaxy": {
"url": "https://halaxy.usefulapi.io/mcp"
}
}
}Remote endpoints
https://halaxy.usefulapi.io/mcpstreamable-httpWhat it can do
Tool inventory
Tools (35)
🟢 Read-only🟡 Write🔴 Delete⚪ Unknown
🟢halaxy_list_patients(name, family, given, email, phone, ...)
List or search patient records (demographics and contact details; HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Patient.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Search the family, given or preferred name (matches the start of the name)."
},
"family": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Start of the family name."
},
"given": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Start of the given name."
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "An email address."
},
"phone": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "A phone number, local or E.164 (+61412345678)."
},
"status": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Patient status, e.g. active."
},
"birthdate": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Date of birth (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"created": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"general_practitioner": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "A Practitioner/PractitionerRole the patient has records with."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"sort": {
"description": "Sort order: _lastUpdated, name, created, -_lastUpdated, -name, -created (\"-\" = descending).",
"type": "string",
"enum": [
"_lastUpdated",
"name",
"created",
"-_lastUpdated",
"-name",
"-created"
]
},
"include": {
"description": "Also return related resources in \"included\": any of Patient:general-practitioner.",
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"Patient:general-practitioner"
]
}
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_practitioners(name, family, given, email, active, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Family, given or preferred name."
},
"family": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Family name."
},
"given": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Given name."
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "An email address."
},
"active": {
"type": "boolean",
"description": "Only active (true) or inactive (false) practitioners."
},
"profile": {
"type": "string",
"enum": [
"StructureDefinition/hx-practitioner",
"StructureDefinition/hx-external-practitioner"
],
"description": "hx-practitioner = staff, hx-external-practitioner = professional contacts."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"sort": {
"description": "Sort order: name, -name (\"-\" = descending).",
"type": "string",
"enum": [
"name",
"-name"
]
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_practitioner_roles(practitioner, organization, provider_number, profile, id, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"practitioner": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Practitioner id, e.g. PR-123."
},
"organization": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Organization (clinic) id."
},
"provider_number": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Provider number."
},
"profile": {
"type": "string",
"enum": [
"StructureDefinition/hx-practitioner-role",
"StructureDefinition/hx-external-practitioner-role"
],
"description": "Staff roles or external professional-contact roles."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"include": {
"description": "Also return related resources in \"included\": any of PractitionerRole:practitioner, PractitionerRole:organization.",
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"PractitionerRole:practitioner",
"PractitionerRole:organization"
]
}
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_organizations(name, profile, id, last_updated, page, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Organization name."
},
"profile": {
"type": "string",
"enum": [
"StructureDefinition/hx-organization-practice-group",
"StructureDefinition/hx-organization-clinic",
"StructureDefinition/hx-organization-funder",
"StructureDefinition/hx-organization-organisation",
"StructureDefinition/hx-organization-external-clinic"
],
"description": "Only one kind of organization."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_appointments(date, created, part_status, patient, practitioner, ...)
List or search appointments (HEALTH DATA: names the patient). Filters combine with AND. Paged: pass next_page as page. GET /main/Appointment.
Input Schema
{
"type": "object",
"properties": {
"date": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Appointment date/time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"created": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"part_status": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "The patient's participation status, e.g. booked, arrived, cancelled."
},
"patient": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Patient id."
},
"practitioner": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Practitioner id, e.g. PR-123."
},
"practitioner_role": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "PractitionerRole id."
},
"organization": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The clinic (Organization) id including its prefix."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"sort": {
"description": "Sort order: date, -date (\"-\" = descending).",
"type": "string",
"enum": [
"date",
"-date"
]
},
"include": {
"description": "Also return related resources in \"included\": any of Appointment:patient, Appointment:practitioner-role.",
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"Appointment:patient",
"Appointment:practitioner-role"
]
}
},
"include_iterate": {
"description": "Also return resources related to an included one (needs the matching include): any of PractitionerRole:practitioner, PractitionerRole:organization.",
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"PractitionerRole:practitioner",
"PractitionerRole:organization"
]
}
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_schedules(active, actor, id, last_updated, include, ...)
List or search schedules: containers of bookable time slots per practitioner. Filters combine with AND. Paged: pass next_page as page. GET /main/Schedule.
Input Schema
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Only active (true) or inactive schedules."
},
"actor": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The practitioner/role the schedule belongs to."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"include": {
"description": "Also return related resources in \"included\": any of Schedule:actor.",
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"Schedule:actor"
]
}
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_slots(duration, status, practitioner, organization, practitioner_role, ...)
List or search time slots of practitioner schedules (free or busy). Filters combine with AND. Paged: pass next_page as page. GET /main/Slot.
Input Schema
{
"type": "object",
"properties": {
"duration": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Slot duration in minutes."
},
"status": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "free or busy."
},
"practitioner": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Practitioner id."
},
"organization": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Organization (clinic) id."
},
"practitioner_role": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "PractitionerRole id."
},
"start": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Slot start (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"end": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Slot end (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"schedule": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Schedule id."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"include": {
"description": "Also return related resources in \"included\": any of Slot:practitioner, Slot:organization, Slot:practitioner-role.",
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"Slot:practitioner",
"Slot:organization",
"Slot:practitioner-role"
]
}
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_healthcare_services(active, name, id, last_updated, page, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Only active (true) or inactive appointment types."
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Appointment type name."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_fees(context_type, property_group_status, created, title, publisher, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"context_type": {
"type": "string",
"enum": [
"0",
"1",
"2"
],
"description": "Fee type: 0 = appointment, 1 = item, 2 = pro-rata."
},
"property_group_status": {
"type": "string",
"enum": [
"1",
"2"
],
"description": "Fee pricing status: 1 = current, 2 = archived."
},
"created": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Fee name."
},
"publisher": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Funder name."
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Fee item number."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_coverage(beneficiary, subscriber, payor, coverage_organization, subscriber_id, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"beneficiary": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The primary beneficiary (a Patient id)."
},
"subscriber": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The subscriber to the policy."
},
"payor": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The funder."
},
"coverage_organization": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The coverage organization."
},
"subscriber_id": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Subscriber (membership) number."
},
"created": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"sort": {
"description": "Sort order: _lastUpdated, created, -_lastUpdated, -created (\"-\" = descending).",
"type": "string",
"enum": [
"_lastUpdated",
"created",
"-_lastUpdated",
"-created"
]
},
"include": {
"description": "Also return related resources in \"included\": any of Coverage:beneficiary, Coverage:subscriber, Coverage:payor.",
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"Coverage:beneficiary",
"Coverage:subscriber",
"Coverage:payor"
]
}
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_invoices(created, recipient, practitioner, practitioner_role, organization, ...)
List or search invoices of the practice group. Filters combine with AND. Paged: pass next_page as page. GET /main/Invoice.
Input Schema
{
"type": "object",
"properties": {
"created": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"recipient": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The invoice recipient (a Patient or Organization id)."
},
"practitioner": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Practitioner id."
},
"practitioner_role": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "PractitionerRole id."
},
"organization": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The clinic the invoice was created at."
},
"status": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Invoice status."
},
"total_paid": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Total paid amount, optionally with a prefix such as gt0."
},
"total_balance": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Balance owing, optionally with a prefix such as gt0 (finds unpaid invoices)."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"include": {
"description": "Also return related resources in \"included\": any of Invoice:recipient, Invoice:practitioner.",
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"Invoice:recipient",
"Invoice:practitioner"
]
}
},
"include_iterate": {
"description": "Also return resources related to an included one (needs the matching include): any of PractitionerRole:practitioner, PractitionerRole:organization.",
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"PractitionerRole:practitioner",
"PractitionerRole:organization"
]
}
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_invoice_lines(created, subject, performer, invoice, funder, ...)
List or search invoice lines: single fees on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/InvoiceLine.
Input Schema
{
"type": "object",
"properties": {
"created": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"subject": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The patient the line is for."
},
"performer": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The performer of the service."
},
"invoice": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The invoice the line belongs to."
},
"funder": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The funder."
},
"referral": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The referral."
},
"coverage": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The coverage (claim details)."
},
"amount": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "The line amount, optionally with a prefix such as gt100."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"include": {
"description": "Also return related resources in \"included\": any of InvoiceLine:subject, InvoiceLine:performer, InvoiceLine:invoice.",
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"InvoiceLine:subject",
"InvoiceLine:performer",
"InvoiceLine:invoice"
]
}
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_payment_transactions(created, id, last_updated, page, count)
List or search payment transactions recorded on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/PaymentTransaction.
Input Schema
{
"type": "object",
"properties": {
"created": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_referrals(subject, coverage, created, id, last_updated, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"subject": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The patient the referral is for."
},
"coverage": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The coverage (claim details) of the referral."
},
"created": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"sort": {
"description": "Sort order: _lastUpdated, created, -_lastUpdated, -created (\"-\" = descending).",
"type": "string",
"enum": [
"_lastUpdated",
"created",
"-_lastUpdated",
"-created"
]
},
"include": {
"description": "Also return related resources in \"included\": any of Referral:subject, Referral:coverage.",
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"Referral:subject",
"Referral:coverage"
]
}
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_list_referral_definitions(funding_organization, id, last_updated, page, count)
List or search referral templates with preset properties. Filters combine with AND. Paged: pass next_page as page. GET /main/ReferralDefinition.
Input Schema
{
"type": "object",
"properties": {
"funding_organization": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The funder."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_patient(id)
Fetch a patient record (HEALTH DATA) by id. GET /main/Patient/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Patient id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_practitioner(id)
Fetch a practitioner or administrator by id. GET /main/Practitioner/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Practitioner id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_practitioner_role(id)
Fetch a practitioner role at a clinic location by id. GET /main/PractitionerRole/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The PractitionerRole id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_organization(id)
Fetch a practice group, clinic, funder or external practice by id. GET /main/Organization/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Organization id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_appointment(id)
Fetch an appointment with its participants and statuses (HEALTH DATA) by id. GET /main/Appointment/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Appointment id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_schedule(id)
Fetch a practitioner schedule by id. GET /main/Schedule/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Schedule id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_slot(id)
Fetch a time slot by id. GET /main/Slot/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Slot id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_healthcare_service(id)
Fetch an appointment type by id. GET /main/HealthcareService/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The HealthcareService id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_fee(id)
Fetch a fee (ChargeItemDefinition) by id. GET /main/ChargeItemDefinition/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The ChargeItemDefinition id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_coverage(id)
Fetch a patient's coverage (claim details) record by id. GET /main/Coverage/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Coverage id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_invoice(id)
Fetch an invoice by id. GET /main/Invoice/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Invoice id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_invoice_line(id)
Fetch an invoice line by id. GET /main/InvoiceLine/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The InvoiceLine id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_payment_transaction(id)
Fetch a payment transaction by id. GET /main/PaymentTransaction/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The PaymentTransaction id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_referral(id)
Fetch a referral (HEALTH DATA) by id. GET /main/Referral/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Referral id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_get_referral_definition(id)
Fetch a referral template by id. GET /main/ReferralDefinition/{id}.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The ReferralDefinition id (from the matching list tool)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢halaxy_find_available_appointments(start, end, duration, practitioner, practitioner_role, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})?$",
"description": "Start of the search window, e.g. 2027-01-12T00:00:00."
},
"end": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})?$",
"description": "End of the search window, e.g. 2027-01-12T23:59:59."
},
"duration": {
"type": "integer",
"minimum": 1,
"maximum": 1440,
"description": "Appointment length in minutes."
},
"practitioner": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Practitioner id."
},
"practitioner_role": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "PractitionerRole id."
},
"organization": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Organization (clinic) id."
},
"show": {
"type": "string",
"enum": [
"first-available"
],
"description": "first-available = only the first available time."
},
"emergency": {
"type": "boolean",
"description": "true ignores lead time, to show all times for emergency appointments."
},
"apply_buffer_time": {
"type": "boolean",
"description": "true applies buffer time to show all available times."
},
"sort": {
"type": "string",
"enum": [
"start",
"-start"
],
"description": "start or -start."
}
},
"required": [
"start",
"end",
"duration"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡halaxy_create_patient(family, given, preferred_name, email, mobile, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"family": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Legal family name (surname)."
},
"given": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Legal given name."
},
"preferred_name": {
"description": "Preferred (usual) given name.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"email": {
"description": "Email address.",
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"mobile": {
"description": "Mobile number as +{country code}{number}, no spaces.",
"type": "string",
"pattern": "^\\+\\d{6,15}$"
},
"gender": {
"description": "Gender as registered in government records.",
"type": "string",
"enum": [
"male",
"female",
"other"
]
},
"birth_date": {
"description": "Date of birth, YYYY-MM-DD.",
"type": "string"
},
"address": {
"description": "Mailing address.",
"type": "object",
"properties": {
"line": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "House/street line."
},
"city": {
"type": "string",
"maxLength": 100
},
"state": {
"type": "string",
"maxLength": 50
},
"postal_code": {
"type": "string",
"maxLength": 20
},
"country": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "ISO 3166 two-letter country code."
}
},
"required": [
"line",
"country"
]
},
"managing_organization": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The practice group id, e.g. PG-12345."
}
},
"required": [
"family",
"given"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡halaxy_create_appointment(patient_id, practitioner_role_id, start, end, healthcare_service_id, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"patient_id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The patient id."
},
"practitioner_role_id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The PractitionerRole id (practitioner at a clinic), e.g. PR-1234567."
},
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})?$",
"description": "Start with the time zone offset, e.g. 2027-06-15T15:00:00+10:00."
},
"end": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})?$",
"description": "End with the time zone offset, e.g. 2027-06-15T16:00:00+10:00."
},
"healthcare_service_id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The appointment type id (halaxy_list_healthcare_services)."
},
"charge_item_definition_id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The fee id (halaxy_list_fees) booked for the appointment."
},
"status": {
"description": "Initial status (default booked).",
"type": "string",
"enum": [
"booked",
"pending",
"confirmed"
]
},
"fail_on_double_booking": {
"description": "Refuse if the practitioner already has an appointment then (default true).",
"type": "boolean"
}
},
"required": [
"patient_id",
"practitioner_role_id",
"start",
"end"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴halaxy_update_appointment_status(appointment_id, status, patient_id)
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}.
Input Schema
{
"type": "object",
"properties": {
"appointment_id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The appointment id."
},
"status": {
"type": "string",
"enum": [
"booked",
"pending",
"confirmed",
"arrived",
"attended",
"did not attend",
"check response",
"declined",
"rejected",
"rescheduled",
"waiting list",
"cancelled",
"cancelled (no charge)"
],
"description": "The new status."
},
"patient_id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The patient whose status changes (needed only when the appointment has several patients)."
}
},
"required": [
"appointment_id",
"status"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡halaxy_create_clinical_note(patient_id, practitioner_role_id, title, html)
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.
Input Schema
{
"type": "object",
"properties": {
"patient_id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The patient the note is for."
},
"practitioner_role_id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The PractitionerRole id of the author, e.g. PR-1234567."
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "The note title."
},
"html": {
"type": "string",
"minLength": 1,
"maxLength": 100000,
"description": "The note body as HTML."
}
},
"required": [
"patient_id",
"practitioner_role_id",
"title",
"html"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Evidence
Recent observations
verifiedversion not recorded35 tools