Servers Playground How we check Add a server Log in

Halaxy MCP by usefulapi

Working · 1.8 s

io.usefulapi/halaxyv1.0.0 Domain verified

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

Health & Science

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://halaxy.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

halaxy_create_appointment

Writes to the live Halaxy account. Books an appointment for a patient with a practitioner at a clinic (the practitioner role). Halaxy also creates the invoice, clinical note and reminder. Use halaxy_find_available_appointments for free times. By default a double booking is refused (HTTP 409, nothing created). POST /main/Appointment/$book.

endstring, required

End with the time zone offset, e.g. 2027-06-15T16:00:00+10:00.

startstring, required

Start with the time zone offset, e.g. 2027-06-15T15:00:00+10:00.

patient_idstring, required

The patient id.

practitioner_role_idstring, required

The PractitionerRole id (practitioner at a clinic), e.g. PR-1234567.

statusstring

Initial status (default booked).

healthcare_service_idstring

The appointment type id (halaxy_list_healthcare_services).

fail_on_double_bookingboolean

Refuse if the practitioner already has an appointment then (default true).

charge_item_definition_idstring

The fee id (halaxy_list_fees) booked for the appointment.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Halaxy MCP by usefulapi MCP server | mcptry

Halaxy MCP by usefulapi

Working · 1.8 s

io.usefulapi/halaxyv1.0.0 Domain verified

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

Health & Science

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://halaxy.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

halaxy_create_appointment

endstring, required

End with the time zone offset, e.g. 2027-06-15T16:00:00+10:00.

startstring, required

Start with the time zone offset, e.g. 2027-06-15T15:00:00+10:00.

patient_idstring, required

The patient id.

practitioner_role_idstring, required

The PractitionerRole id (practitioner at a clinic), e.g. PR-1234567.

statusstring

Initial status (default booked).

healthcare_service_idstring

The appointment type id (halaxy_list_healthcare_services).

fail_on_double_bookingboolean

Refuse if the practitioner already has an appointment then (default true).

charge_item_definition_idstring

The fee id (halaxy_list_fees) booked for the appointment.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Tools (35)

halaxy_create_appointment

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

Input schema (JSON)

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

halaxy_create_clinical_note

Writes to the live Halaxy account. Adds a clinical note to a patient's record as a DRAFT (preliminary); the practitioner reviews and publishes it in Halaxy. The author is a PractitionerRole (practitioner at a clinic). Only HTML text is supported. POST /main/DocumentReference.

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

Input schema (JSON)

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

halaxy_create_patient

Writes to the live Halaxy account. Creates a new patient record (always a new one: search with halaxy_list_patients first to avoid a duplicate). Pass managing_organization (the practice group id, e.g. PG-12345, from halaxy_list_organizations) if Halaxy asks for it. POST /main/Patient.

Argument	Type	Description
email	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.

Input schema (JSON)

halaxy_find_available_appointments

Find free appointment times between start and end for a given duration, respecting each practitioner's online booking preferences (buffer time, lead time, advance booking limit). Narrow it with practitioner, practitioner_role or organization. GET /main/Appointment/$find.

read-only

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

halaxy_get_appointment

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

read-only

Argument	Type	Description
id*	string	The Appointment id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_coverage

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

read-only

Argument	Type	Description
id*	string	The Coverage id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_fee

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

read-only

Argument	Type	Description
id*	string	The ChargeItemDefinition id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_healthcare_service

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

read-only

Argument	Type	Description
id*	string	The HealthcareService id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_invoice

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

read-only

Argument	Type	Description
id*	string	The Invoice id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_invoice_line

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

read-only

Argument	Type	Description
id*	string	The InvoiceLine id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_organization

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

read-only

Argument	Type	Description
id*	string	The Organization id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_patient

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

read-only

Argument	Type	Description
id*	string	The Patient id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_payment_transaction

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

read-only

Argument	Type	Description
id*	string	The PaymentTransaction id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_practitioner

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

read-only

Argument	Type	Description
id*	string	The Practitioner id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_practitioner_role

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

read-only

Argument	Type	Description
id*	string	The PractitionerRole id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_referral

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

read-only

Argument	Type	Description
id*	string	The Referral id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_referral_definition

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

read-only

Argument	Type	Description
id*	string	The ReferralDefinition id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_schedule

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

read-only

Argument	Type	Description
id*	string	The Schedule id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_get_slot

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

read-only

Argument	Type	Description
id*	string	The Slot id (from the matching list tool).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_list_appointments

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

read-only

Argument	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

halaxy_list_coverage

List or search patients' health fund membership and claim details (HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Coverage.

read-only

Argument	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

halaxy_list_fees

List or search fees (ChargeItemDefinition): the services and products a practice charges for. Filters combine with AND. Paged: pass next_page as page. GET /main/ChargeItemDefinition.

read-only

Argument	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).

halaxy_list_healthcare_services

List or search appointment types used by the practice group, clinics and practitioners. Filters combine with AND. Paged: pass next_page as page. GET /main/HealthcareService.

read-only

Argument	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).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_list_invoice_lines

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

read-only

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

halaxy_list_invoices

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

read-only

Argument	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

halaxy_list_organizations

List or search the practice group, its clinic locations, funders and external practices (practice group ids look like PG-12345). Filters combine with AND. Paged: pass next_page as page. GET /main/Organization.

read-only

Argument	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).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_list_patients

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

read-only

Argument	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).
email	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.

halaxy_list_payment_transactions

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

read-only

Argument	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).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_list_practitioner_roles

List or search practitioner roles: a practitioner's association with one clinic location (the id used when booking and for clinical notes). Filters combine with AND. Paged: pass next_page as page. GET /main/PractitionerRole.

read-only

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

halaxy_list_practitioners

List or search practitioners and administrators of the practice group (ids look like PR-12345). Filters combine with AND. Paged: pass next_page as page. GET /main/Practitioner.

read-only

Argument	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).
email	string	An email address.
given	string	Given name.
active	boolean	Only active (true) or inactive (false) practitioners.
family	string	Family name.
profile

halaxy_list_referral_definitions

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

read-only

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

Input schema (JSON)

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

halaxy_list_referrals

List or search referrals from one healthcare provider to another (HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Referral.

read-only

Argument	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

halaxy_list_schedules

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

read-only

Argument	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).

Input schema (JSON)

{
  "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)."
    }
  }
}

halaxy_list_slots

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

read-only

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

halaxy_update_appointment_status

Writes to the live Halaxy account. Sets the patient's status on an appointment (shown in the Halaxy calendar), for example arrived, attended, confirmed or cancelled. "cancelled (no charge)" also sets the invoice to $0. For a group appointment pass patient_id to say whose status changes. PATCH /main/Appointment/{id}.

destructive

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

Input schema (JSON)

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

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

Input schema (JSON)

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

Input schema (JSON)

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

Input schema (JSON)

{
  "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)."
    }
  }
}

Input schema (JSON)

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

Input schema (JSON)

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

Input schema (JSON)

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

Input schema (JSON)

{
  "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)."
    }
  }
}

Input schema (JSON)

{
  "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)."
    }
  }
}

Input schema (JSON)

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