Halaxy MCP by usefulapi is an MCP server published by io.usefulapi, hosted at halaxy.usefulapi.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 35 tools, including halaxy_list_patients, halaxy_list_practitioners, halaxy_list_practitioner_roles, halaxy_list_organizations, halaxy_list_appointments.
Read Halaxy patients, appointments, slots and invoices; create patients, appointments and notes.
4,007 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
List or search patient records (demographics and contact details; HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Patient.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| name | string | Search the family, given or preferred name (matches the start of the name). |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| sort | string | Sort order: _lastUpdated, name, created, -_lastUpdated, -name, -created ("-" = descending). |
| count | integer | Results per page, 1-100 (default 30). |
| string | An email address. | |
| given | string | Start of the given name. |
| phone | string | A phone number, local or E.164 (+61412345678). |
| family | string | Start of the family name. |
| status | string | Patient status, e.g. active. |
| created | string | Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| include | array | Also return related resources in "included": any of Patient:general-practitioner. |
| birthdate | string | Date of birth (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| general_practitioner | string | A Practitioner/PractitionerRole the patient has records with. |
{
"name": "halaxy_list_patients",
"title": "List or search patients",
"description": "List or search patient records (demographics and contact details; HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Patient.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Search the family, given or preferred name (matches the start of the name)."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"sort": {
"enum": [
"_lastUpdated",
"name",
"created",
"-_lastUpdated",
"-name",
"-created"
],
"type": "string",
"description": "Sort order: _lastUpdated, name, created, -_lastUpdated, -name, -created (\"-\" = descending)."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"email": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "An email address."
},
"given": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Start of the given name."
},
"phone": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "A phone number, local or E.164 (+61412345678)."
},
"family": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Start of the family name."
},
"status": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Patient status, e.g. active."
},
"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)."
},
"include": {
"type": "array",
"items": {
"enum": [
"Patient:general-practitioner"
],
"type": "string"
},
"maxItems": 1,
"description": "Also return related resources in \"included\": any of Patient:general-practitioner."
},
"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)."
},
"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)."
},
"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."
}
}
},
"annotations": {
"title": "List or search patients",
"readOnlyHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| name | string | Family, given or preferred name. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| sort | string | Sort order: name, -name ("-" = descending). |
| count | integer | Results per page, 1-100 (default 30). |
| string | An email address. | |
| given | string | Given name. |
| active | boolean | Only active (true) or inactive (false) practitioners. |
| family | string | Family name. |
| profile | string | hx-practitioner = staff, hx-external-practitioner = professional contacts. |
| last_updated | string |
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.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| count | integer | Results per page, 1-100 (default 30). |
| include | array | Also return related resources in "included": any of PractitionerRole:practitioner, PractitionerRole:organization. |
| profile | string | Staff roles or external professional-contact roles. |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| organization | string | Organization (clinic) id. |
| practitioner | string | Practitioner id, e.g. PR-123. |
| provider_number | string | Provider number. |
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.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| name | string | Organization name. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| count | integer | Results per page, 1-100 (default 30). |
| profile | string | Only one kind of organization. |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
{
"name": "halaxy_list_organizations",
"title": "List organizations and clinics",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Organization name."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"profile": {
"enum": [
"StructureDefinition/hx-organization-practice-group",
"StructureDefinition/hx-organization-clinic",
"StructureDefinition/hx-organization-funder",
"StructureDefinition/hx-organization-organisation",
"StructureDefinition/hx-organization-external-clinic"
],
"type": "string",
"description": "Only one kind of organization."
},
"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)."
}
}
},
"annotations": {
"title": "List organizations and clinics",
"readOnlyHint": true
}
}List or search appointments (HEALTH DATA: names the patient). Filters combine with AND. Paged: pass next_page as page. GET /main/Appointment.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| date | string | Appointment date/time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| sort | string | Sort order: date, -date ("-" = descending). |
| count | integer | Results per page, 1-100 (default 30). |
| created | string | Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| include | array | Also return related resources in "included": any of Appointment:patient, Appointment:practitioner-role. |
| patient | string | Patient id. |
| part_status | string | The patient's participation status, e.g. booked, arrived, cancelled. |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
List or search schedules: containers of bookable time slots per practitioner. Filters combine with AND. Paged: pass next_page as page. GET /main/Schedule.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| actor | string | The practitioner/role the schedule belongs to. |
| count | integer | Results per page, 1-100 (default 30). |
| active | boolean | Only active (true) or inactive schedules. |
| include | array | Also return related resources in "included": any of Schedule:actor. |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
{
"name": "halaxy_list_schedules",
"title": "List practitioner schedules",
"description": "List or search schedules: containers of bookable time slots per practitioner. Filters combine with AND. Paged: pass next_page as page. GET /main/Schedule.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"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."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"active": {
"type": "boolean",
"description": "Only active (true) or inactive schedules."
},
"include": {
"type": "array",
"items": {
"enum": [
"Schedule:actor"
],
"type": "string"
},
"maxItems": 1,
"description": "Also return related resources in \"included\": any of Schedule:actor."
},
"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)."
}
}
},
"annotations": {
"title": "List practitioner schedules",
"readOnlyHint": true
}
}List or search time slots of practitioner schedules (free or busy). Filters combine with AND. Paged: pass next_page as page. GET /main/Slot.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| end | string | Slot end (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| count | integer | Results per page, 1-100 (default 30). |
| start | string | Slot start (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| status | string | free or busy. |
| include | array | Also return related resources in "included": any of Slot:practitioner, Slot:organization, Slot:practitioner-role. |
| duration | string | Slot duration in minutes. |
| schedule | string | Schedule id. |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
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.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| name | string | Appointment type name. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| count | integer | Results per page, 1-100 (default 30). |
| active | boolean | Only active (true) or inactive appointment types. |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
{
"name": "halaxy_list_healthcare_services",
"title": "List appointment types",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Appointment type name."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"active": {
"type": "boolean",
"description": "Only active (true) or inactive appointment types."
},
"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)."
}
}
},
"annotations": {
"title": "List appointment types",
"readOnlyHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| code | string | Fee item number. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| count | integer | Results per page, 1-100 (default 30). |
| title | string | Fee name. |
| created | string | Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| publisher | string | Funder name. |
| context_type | string | Fee type: 0 = appointment, 1 = item, 2 = pro-rata. |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| property_group_status | string | Fee pricing status: 1 = current, 2 = archived. |
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.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| sort | string | Sort order: _lastUpdated, created, -_lastUpdated, -created ("-" = descending). |
| count | integer | Results per page, 1-100 (default 30). |
| payor | string | The funder. |
| created | string | Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| include | array | Also return related resources in "included": any of Coverage:beneficiary, Coverage:subscriber, Coverage:payor. |
| subscriber | string | The subscriber to the policy. |
| beneficiary | string | The primary beneficiary (a Patient id). |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
List or search invoices of the practice group. Filters combine with AND. Paged: pass next_page as page. GET /main/Invoice.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| count | integer | Results per page, 1-100 (default 30). |
| status | string | Invoice status. |
| created | string | Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| include | array | Also return related resources in "included": any of Invoice:recipient, Invoice:practitioner. |
| recipient | string | The invoice recipient (a Patient or Organization id). |
| total_paid | string | Total paid amount, optionally with a prefix such as gt0. |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| organization | string | The clinic the invoice was created at. |
List or search invoice lines: single fees on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/InvoiceLine.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| count | integer | Results per page, 1-100 (default 30). |
| amount | string | The line amount, optionally with a prefix such as gt100. |
| funder | string | The funder. |
| created | string | Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| include | array | Also return related resources in "included": any of InvoiceLine:subject, InvoiceLine:performer, InvoiceLine:invoice. |
| invoice | string | The invoice the line belongs to. |
| subject | string | The patient the line is for. |
| coverage | string | The coverage (claim details). |
| referral |
List or search payment transactions recorded on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/PaymentTransaction.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| count | integer | Results per page, 1-100 (default 30). |
| created | string | Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
{
"name": "halaxy_list_payment_transactions",
"title": "List payment transactions",
"description": "List or search payment transactions recorded on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/PaymentTransaction.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"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)."
},
"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)."
}
}
},
"annotations": {
"title": "List payment transactions",
"readOnlyHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| sort | string | Sort order: _lastUpdated, created, -_lastUpdated, -created ("-" = descending). |
| count | integer | Results per page, 1-100 (default 30). |
| created | string | Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| include | array | Also return related resources in "included": any of Referral:subject, Referral:coverage. |
| subject | string | The patient the referral is for. |
| coverage | string | The coverage (claim details) of the referral. |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
List or search referral templates with preset properties. Filters combine with AND. Paged: pass next_page as page. GET /main/ReferralDefinition.
| Parameter | Type | Description |
|---|---|---|
| id | string | One id or several separated by commas, for example 1,2,3. |
| page | integer | Page number, 1-based (default 1). Use next_page from the previous reply. |
| count | integer | Results per page, 1-100 (default 30). |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
| funding_organization | string | The funder. |
{
"name": "halaxy_list_referral_definitions",
"title": "List referral templates",
"description": "List or search referral templates with preset properties. Filters combine with AND. Paged: pass next_page as page. GET /main/ReferralDefinition.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"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)."
},
"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."
}
}
},
"annotations": {
"title": "List referral templates",
"readOnlyHint": true
}
}Fetch a patient record (HEALTH DATA) by id. GET /main/Patient/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The Patient id (from the matching list tool). |
{
"name": "halaxy_get_patient",
"title": "Get a patient",
"description": "Fetch a patient record (HEALTH DATA) by id. GET /main/Patient/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Patient id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get a patient",
"readOnlyHint": true
}
}Fetch a practitioner or administrator by id. GET /main/Practitioner/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The Practitioner id (from the matching list tool). |
{
"name": "halaxy_get_practitioner",
"title": "Get a practitioner",
"description": "Fetch a practitioner or administrator by id. GET /main/Practitioner/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Practitioner id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get a practitioner",
"readOnlyHint": true
}
}Fetch a practitioner role at a clinic location by id. GET /main/PractitionerRole/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The PractitionerRole id (from the matching list tool). |
{
"name": "halaxy_get_practitioner_role",
"title": "Get a practitioner role",
"description": "Fetch a practitioner role at a clinic location by id. GET /main/PractitionerRole/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The PractitionerRole id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get a practitioner role",
"readOnlyHint": true
}
}Fetch a practice group, clinic, funder or external practice by id. GET /main/Organization/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The Organization id (from the matching list tool). |
{
"name": "halaxy_get_organization",
"title": "Get an organization",
"description": "Fetch a practice group, clinic, funder or external practice by id. GET /main/Organization/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Organization id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get an organization",
"readOnlyHint": true
}
}Fetch an appointment with its participants and statuses (HEALTH DATA) by id. GET /main/Appointment/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The Appointment id (from the matching list tool). |
{
"name": "halaxy_get_appointment",
"title": "Get an appointment",
"description": "Fetch an appointment with its participants and statuses (HEALTH DATA) by id. GET /main/Appointment/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Appointment id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get an appointment",
"readOnlyHint": true
}
}Fetch a practitioner schedule by id. GET /main/Schedule/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The Schedule id (from the matching list tool). |
{
"name": "halaxy_get_schedule",
"title": "Get a schedule",
"description": "Fetch a practitioner schedule by id. GET /main/Schedule/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Schedule id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get a schedule",
"readOnlyHint": true
}
}Fetch a time slot by id. GET /main/Slot/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The Slot id (from the matching list tool). |
{
"name": "halaxy_get_slot",
"title": "Get a time slot",
"description": "Fetch a time slot by id. GET /main/Slot/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Slot id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get a time slot",
"readOnlyHint": true
}
}Fetch an appointment type by id. GET /main/HealthcareService/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The HealthcareService id (from the matching list tool). |
{
"name": "halaxy_get_healthcare_service",
"title": "Get an appointment type",
"description": "Fetch an appointment type by id. GET /main/HealthcareService/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The HealthcareService id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get an appointment type",
"readOnlyHint": true
}
}Fetch a fee (ChargeItemDefinition) by id. GET /main/ChargeItemDefinition/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The ChargeItemDefinition id (from the matching list tool). |
{
"name": "halaxy_get_fee",
"title": "Get a fee",
"description": "Fetch a fee (ChargeItemDefinition) by id. GET /main/ChargeItemDefinition/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The ChargeItemDefinition id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get a fee",
"readOnlyHint": true
}
}Fetch a patient's coverage (claim details) record by id. GET /main/Coverage/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The Coverage id (from the matching list tool). |
{
"name": "halaxy_get_coverage",
"title": "Get patient coverage",
"description": "Fetch a patient's coverage (claim details) record by id. GET /main/Coverage/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Coverage id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get patient coverage",
"readOnlyHint": true
}
}Fetch an invoice by id. GET /main/Invoice/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The Invoice id (from the matching list tool). |
{
"name": "halaxy_get_invoice",
"title": "Get an invoice",
"description": "Fetch an invoice by id. GET /main/Invoice/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Invoice id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get an invoice",
"readOnlyHint": true
}
}Fetch an invoice line by id. GET /main/InvoiceLine/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The InvoiceLine id (from the matching list tool). |
{
"name": "halaxy_get_invoice_line",
"title": "Get an invoice line",
"description": "Fetch an invoice line by id. GET /main/InvoiceLine/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The InvoiceLine id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get an invoice line",
"readOnlyHint": true
}
}Fetch a payment transaction by id. GET /main/PaymentTransaction/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The PaymentTransaction id (from the matching list tool). |
{
"name": "halaxy_get_payment_transaction",
"title": "Get a payment transaction",
"description": "Fetch a payment transaction by id. GET /main/PaymentTransaction/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The PaymentTransaction id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get a payment transaction",
"readOnlyHint": true
}
}Fetch a referral (HEALTH DATA) by id. GET /main/Referral/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The Referral id (from the matching list tool). |
{
"name": "halaxy_get_referral",
"title": "Get a referral",
"description": "Fetch a referral (HEALTH DATA) by id. GET /main/Referral/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The Referral id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get a referral",
"readOnlyHint": true
}
}Fetch a referral template by id. GET /main/ReferralDefinition/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The ReferralDefinition id (from the matching list tool). |
{
"name": "halaxy_get_referral_definition",
"title": "Get a referral template",
"description": "Fetch a referral template by id. GET /main/ReferralDefinition/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The ReferralDefinition id (from the matching list tool)."
}
}
},
"annotations": {
"title": "Get a referral template",
"readOnlyHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| end * | string | End of the search window, e.g. 2027-01-12T23:59:59. |
| show | string | first-available = only the first available time. |
| sort | string | start or -start. |
| start * | string | Start of the search window, e.g. 2027-01-12T00:00:00. |
| duration * | integer | Appointment length in minutes. |
| emergency | boolean | true ignores lead time, to show all times for emergency appointments. |
| organization | string | Organization (clinic) id. |
| practitioner | string | Practitioner id. |
| apply_buffer_time | boolean | true applies buffer time to show all available times. |
| practitioner_role |
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.
| Parameter | Type | Description |
|---|---|---|
| string | Email address. | |
| given * | string | Legal given name. |
| family * | string | Legal family name (surname). |
| gender | string | Gender as registered in government records. |
| mobile | string | Mobile number as +{country code}{number}, no spaces. |
| address | object | Mailing address. |
| birth_date | string | Date of birth, YYYY-MM-DD. |
| preferred_name | string | Preferred (usual) given name. |
| managing_organization | string | The practice group id, e.g. PG-12345. |
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.
| Parameter | Type | Description |
|---|---|---|
| end * | string | End with the time zone offset, e.g. 2027-06-15T16:00:00+10:00. |
| start * | string | Start with the time zone offset, e.g. 2027-06-15T15:00:00+10:00. |
| status | string | Initial status (default booked). |
| patient_id * | string | The patient id. |
| practitioner_role_id * | string | The PractitionerRole id (practitioner at a clinic), e.g. PR-1234567. |
| healthcare_service_id | string | The appointment type id (halaxy_list_healthcare_services). |
| fail_on_double_booking | boolean | Refuse if the practitioner already has an appointment then (default true). |
| charge_item_definition_id | string | The fee id (halaxy_list_fees) booked for the appointment. |
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}.
| Parameter | Type | Description |
|---|---|---|
| status * | string | The new status. |
| patient_id | string | The patient whose status changes (needed only when the appointment has several patients). |
| appointment_id * | string | The appointment id. |
{
"name": "halaxy_update_appointment_status",
"title": "Update an appointment status",
"description": "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}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"appointment_id",
"status"
],
"properties": {
"status": {
"enum": [
"booked",
"pending",
"confirmed",
"arrived",
"attended",
"did not attend",
"check response",
"declined",
"rejected",
"rescheduled",
"waiting list",
"cancelled",
"cancelled (no charge)"
],
"type": "string",
"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)."
},
"appointment_id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The appointment id."
}
}
},
"annotations": {
"title": "Update an appointment status",
"idempotentHint": true,
"destructiveHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| html * | string | The note body as HTML. |
| title * | string | The note title. |
| patient_id * | string | The patient the note is for. |
| practitioner_role_id * | string | The PractitionerRole id of the author, e.g. PR-1234567. |
{
"name": "halaxy_create_clinical_note",
"title": "Create a draft clinical note",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"patient_id",
"practitioner_role_id",
"title",
"html"
],
"properties": {
"html": {
"type": "string",
"maxLength": 100000,
"minLength": 1,
"description": "The note body as HTML."
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The note title."
},
"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."
}
}
},
"annotations": {
"title": "Create a draft clinical note",
"readOnlyHint": false,
"destructiveHint": false
}
}Tools for Halaxy, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which appointments does Dr Smith have tomorrow, and who are the patients?"; "Find free 30-minute appointment times next week at the main clinic."; "List unpaid invoices from the last month with the amount owing.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Halaxy data. Free plan: 50 tool calls per month. Run halaxy_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run halaxy_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run halaxy_upgrade without a plan: it returns both plans, each with a payment link for the user to open. halaxy_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
{
"name": "halaxy_list_practitioners",
"title": "List practitioners",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Family, given or preferred name."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"sort": {
"enum": [
"name",
"-name"
],
"type": "string",
"description": "Sort order: name, -name (\"-\" = descending)."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"email": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "An email address."
},
"given": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Given name."
},
"active": {
"type": "boolean",
"description": "Only active (true) or inactive (false) practitioners."
},
"family": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Family name."
},
"profile": {
"enum": [
"StructureDefinition/hx-practitioner",
"StructureDefinition/hx-external-practitioner"
],
"type": "string",
"description": "hx-practitioner = staff, hx-external-practitioner = professional contacts."
},
"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)."
}
}
},
"annotations": {
"title": "List practitioners",
"readOnlyHint": true
}
}{
"name": "halaxy_list_practitioner_roles",
"title": "List practitioner roles (clinic locations)",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"include": {
"type": "array",
"items": {
"enum": [
"PractitionerRole:practitioner",
"PractitionerRole:organization"
],
"type": "string"
},
"maxItems": 2,
"description": "Also return related resources in \"included\": any of PractitionerRole:practitioner, PractitionerRole:organization."
},
"profile": {
"enum": [
"StructureDefinition/hx-practitioner-role",
"StructureDefinition/hx-external-practitioner-role"
],
"type": "string",
"description": "Staff roles or external professional-contact roles."
},
"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)."
},
"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": {
"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."
},
"provider_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Provider number."
}
}
},
"annotations": {
"title": "List practitioner roles (clinic locations)",
"readOnlyHint": true
}
}| organization | string | The clinic (Organization) id including its prefix. |
| practitioner | string | Practitioner id, e.g. PR-123. |
| include_iterate | array | Also return resources related to an included one (needs the matching include): any of PractitionerRole:practitioner, PractitionerRole:organization. |
| practitioner_role | string | PractitionerRole id. |
{
"name": "halaxy_list_appointments",
"title": "List appointments",
"description": "List or search appointments (HEALTH DATA: names the patient). Filters combine with AND. Paged: pass next_page as page. GET /main/Appointment.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"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)."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"sort": {
"enum": [
"date",
"-date"
],
"type": "string",
"description": "Sort order: date, -date (\"-\" = descending)."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"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)."
},
"include": {
"type": "array",
"items": {
"enum": [
"Appointment:patient",
"Appointment:practitioner-role"
],
"type": "string"
},
"maxItems": 2,
"description": "Also return related resources in \"included\": any of Appointment:patient, Appointment:practitioner-role."
},
"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."
},
"part_status": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The patient's participation status, e.g. booked, arrived, cancelled."
},
"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)."
},
"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."
},
"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."
},
"include_iterate": {
"type": "array",
"items": {
"enum": [
"PractitionerRole:practitioner",
"PractitionerRole:organization"
],
"type": "string"
},
"maxItems": 2,
"description": "Also return resources related to an included one (needs the matching include): any of PractitionerRole:practitioner, PractitionerRole:organization."
},
"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."
}
}
},
"annotations": {
"title": "List appointments",
"readOnlyHint": true
}
}| organization |
| string |
| Organization (clinic) id. |
| practitioner | string | Practitioner id. |
| practitioner_role | string | PractitionerRole id. |
{
"name": "halaxy_list_slots",
"title": "List time slots",
"description": "List or search time slots of practitioner schedules (free or busy). Filters combine with AND. Paged: pass next_page as page. GET /main/Slot.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"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)."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"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)."
},
"status": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "free or busy."
},
"include": {
"type": "array",
"items": {
"enum": [
"Slot:practitioner",
"Slot:organization",
"Slot:practitioner-role"
],
"type": "string"
},
"maxItems": 3,
"description": "Also return related resources in \"included\": any of Slot:practitioner, Slot:organization, Slot:practitioner-role."
},
"duration": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Slot duration in minutes."
},
"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."
},
"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)."
},
"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": {
"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."
}
}
},
"annotations": {
"title": "List time slots",
"readOnlyHint": true
}
}{
"name": "halaxy_list_fees",
"title": "List fees",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"code": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Fee item number."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Fee name."
},
"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)."
},
"publisher": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Funder name."
},
"context_type": {
"enum": [
"0",
"1",
"2"
],
"type": "string",
"description": "Fee type: 0 = appointment, 1 = item, 2 = pro-rata."
},
"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)."
},
"property_group_status": {
"enum": [
"1",
"2"
],
"type": "string",
"description": "Fee pricing status: 1 = current, 2 = archived."
}
}
},
"annotations": {
"title": "List fees",
"readOnlyHint": true
}
}| subscriber_id | string | Subscriber (membership) number. |
| coverage_organization | string | The coverage organization. |
{
"name": "halaxy_list_coverage",
"title": "List patient coverage (claim details)",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"sort": {
"enum": [
"_lastUpdated",
"created",
"-_lastUpdated",
"-created"
],
"type": "string",
"description": "Sort order: _lastUpdated, created, -_lastUpdated, -created (\"-\" = descending)."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"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."
},
"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)."
},
"include": {
"type": "array",
"items": {
"enum": [
"Coverage:beneficiary",
"Coverage:subscriber",
"Coverage:payor"
],
"type": "string"
},
"maxItems": 3,
"description": "Also return related resources in \"included\": any of Coverage:beneficiary, Coverage:subscriber, Coverage:payor."
},
"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."
},
"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)."
},
"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)."
},
"subscriber_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Subscriber (membership) number."
},
"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."
}
}
},
"annotations": {
"title": "List patient coverage (claim details)",
"readOnlyHint": true
}
}| practitioner | string | Practitioner id. |
| total_balance | string | Balance owing, optionally with a prefix such as gt0 (finds unpaid invoices). |
| include_iterate | array | Also return resources related to an included one (needs the matching include): any of PractitionerRole:practitioner, PractitionerRole:organization. |
| practitioner_role | string | PractitionerRole id. |
{
"name": "halaxy_list_invoices",
"title": "List invoices",
"description": "List or search invoices of the practice group. Filters combine with AND. Paged: pass next_page as page. GET /main/Invoice.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"status": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Invoice status."
},
"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)."
},
"include": {
"type": "array",
"items": {
"enum": [
"Invoice:recipient",
"Invoice:practitioner"
],
"type": "string"
},
"maxItems": 2,
"description": "Also return related resources in \"included\": any of Invoice:recipient, Invoice:practitioner."
},
"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)."
},
"total_paid": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Total paid amount, optionally with a prefix such as gt0."
},
"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)."
},
"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."
},
"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."
},
"total_balance": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Balance owing, optionally with a prefix such as gt0 (finds unpaid invoices)."
},
"include_iterate": {
"type": "array",
"items": {
"enum": [
"PractitionerRole:practitioner",
"PractitionerRole:organization"
],
"type": "string"
},
"maxItems": 2,
"description": "Also return resources related to an included one (needs the matching include): any of PractitionerRole:practitioner, PractitionerRole:organization."
},
"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."
}
}
},
"annotations": {
"title": "List invoices",
"readOnlyHint": true
}
}| string |
| The referral. |
| performer | string | The performer of the service. |
| last_updated | string | Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le). |
{
"name": "halaxy_list_invoice_lines",
"title": "List invoice lines",
"description": "List or search invoice lines: single fees on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/InvoiceLine.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"amount": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The line amount, optionally with a prefix such as gt100."
},
"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."
},
"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)."
},
"include": {
"type": "array",
"items": {
"enum": [
"InvoiceLine:subject",
"InvoiceLine:performer",
"InvoiceLine:invoice"
],
"type": "string"
},
"maxItems": 3,
"description": "Also return related resources in \"included\": any of InvoiceLine:subject, InvoiceLine:performer, InvoiceLine:invoice."
},
"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."
},
"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."
},
"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)."
},
"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."
},
"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."
},
"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)."
}
}
},
"annotations": {
"title": "List invoice lines",
"readOnlyHint": true
}
}{
"name": "halaxy_list_referrals",
"title": "List referrals",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"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}$",
"description": "One id or several separated by commas, for example 1,2,3."
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1). Use next_page from the previous reply."
},
"sort": {
"enum": [
"_lastUpdated",
"created",
"-_lastUpdated",
"-created"
],
"type": "string",
"description": "Sort order: _lastUpdated, created, -_lastUpdated, -created (\"-\" = descending)."
},
"count": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 30)."
},
"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)."
},
"include": {
"type": "array",
"items": {
"enum": [
"Referral:subject",
"Referral:coverage"
],
"type": "string"
},
"maxItems": 2,
"description": "Also return related resources in \"included\": any of Referral:subject, Referral:coverage."
},
"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."
},
"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)."
}
}
},
"annotations": {
"title": "List referrals",
"readOnlyHint": true
}
}| string |
| PractitionerRole id. |
{
"name": "halaxy_find_available_appointments",
"title": "Find available appointment times",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start",
"end",
"duration"
],
"properties": {
"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."
},
"show": {
"enum": [
"first-available"
],
"type": "string",
"description": "first-available = only the first available time."
},
"sort": {
"enum": [
"start",
"-start"
],
"type": "string",
"description": "start or -start."
},
"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."
},
"duration": {
"type": "integer",
"maximum": 1440,
"minimum": 1,
"description": "Appointment length in minutes."
},
"emergency": {
"type": "boolean",
"description": "true ignores lead time, to show all times for emergency appointments."
},
"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": {
"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."
},
"apply_buffer_time": {
"type": "boolean",
"description": "true applies buffer time to show all available times."
},
"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."
}
}
},
"annotations": {
"title": "Find available appointment times",
"readOnlyHint": true
}
}{
"name": "halaxy_create_patient",
"title": "Create a patient",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"family",
"given"
],
"properties": {
"email": {
"type": "string",
"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,}$",
"maxLength": 254,
"description": "Email address."
},
"given": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Legal given name."
},
"family": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Legal family name (surname)."
},
"gender": {
"enum": [
"male",
"female",
"other"
],
"type": "string",
"description": "Gender as registered in government records."
},
"mobile": {
"type": "string",
"pattern": "^\\+\\d{6,15}$",
"description": "Mobile number as +{country code}{number}, no spaces."
},
"address": {
"type": "object",
"required": [
"line",
"country"
],
"properties": {
"city": {
"type": "string",
"maxLength": 100
},
"line": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "House/street line."
},
"state": {
"type": "string",
"maxLength": 50
},
"country": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "ISO 3166 two-letter country code."
},
"postal_code": {
"type": "string",
"maxLength": 20
}
},
"description": "Mailing address."
},
"birth_date": {
"type": "string",
"description": "Date of birth, YYYY-MM-DD."
},
"preferred_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Preferred (usual) given name."
},
"managing_organization": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
"description": "The practice group id, e.g. PG-12345."
}
}
},
"annotations": {
"title": "Create a patient",
"readOnlyHint": false,
"destructiveHint": false
}
}{
"name": "halaxy_create_appointment",
"title": "Book an appointment",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"patient_id",
"practitioner_role_id",
"start",
"end"
],
"properties": {
"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."
},
"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."
},
"status": {
"enum": [
"booked",
"pending",
"confirmed"
],
"type": "string",
"description": "Initial status (default booked)."
},
"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."
},
"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)."
},
"fail_on_double_booking": {
"type": "boolean",
"description": "Refuse if the practitioner already has an appointment then (default true)."
},
"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."
}
}
},
"annotations": {
"title": "Book an appointment",
"readOnlyHint": false,
"destructiveHint": false
}
}