Servers Playground How we check Add a server Log in

splose MCP by usefulapi

Working · 661 ms

io.usefulapi/splosev1.0.0 Domain verified

Read splose patients, appointments, invoices, cases; book and cancel appointments, record payments.

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://splose.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.

splose_cancel_appointment Destructive

WRITE: cancels ONE appointment with a cancellation reason (ids from splose_list_cancellation_reasons) and an optional note. The reason's billable rate may create a cancellation charge, and the patient may be notified per the practice's settings. For a group appointment pass patient_id to cancel only that patient's place; without it the whole appointment is cancelled. Cannot be undone through this server: confirm with the user first and pass confirm: true. POST /appointments/{id}/cancellation or /appointments/{id}/patients/{patientId}/cancellation.

confirmboolean, required

Must be true: the user has confirmed this cancellation (it may charge a fee and notify the patient).

reasonIdinteger, required

Cancellation reason id.

appointment_idinteger, required

Appointment id.

notestring

Optional cancellation note.

patient_idinteger

Group appointments only: cancel just this patient's participation.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

splose MCP by usefulapi MCP server | mcptry

splose MCP by usefulapi

Working · 661 ms

io.usefulapi/splosev1.0.0 Domain verified

Read splose patients, appointments, invoices, cases; book and cancel appointments, record payments.

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://splose.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.

splose_cancel_appointment Destructive

confirmboolean, required

Must be true: the user has confirmed this cancellation (it may charge a fee and notify the patient).

reasonIdinteger, required

Cancellation reason id.

appointment_idinteger, required

Appointment id.

notestring

Optional cancellation note.

patient_idinteger

Group appointments only: cancel just this patient's participation.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Tools (36)

splose_cancel_appointment

destructive

Argument	Type	Description
note	string	Optional cancellation note.
confirm*	boolean	Must be true: the user has confirmed this cancellation (it may charge a fee and notify the patient).
reasonId*	integer	Cancellation reason id.
patient_id	integer	Group appointments only: cancel just this patient's participation.
appointment_id*	integer	Appointment id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "appointment_id",
    "reasonId",
    "confirm"
  ],
  "properties": {
    "note": {
      "type": "string",
      "maxLength": 5000,
      "description": "Optional cancellation note."
    },
    "confirm": {
      "type": "boolean",
      "const": true,
      "description": "Must be true: the user has confirmed this cancellation (it may charge a fee and notify the patient)."
    },
    "reasonId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Cancellation reason id.",
      "exclusiveMinimum": 0
    },
    "patient_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Group appointments only: cancel just this patient's participation.",
      "exclusiveMinimum": 0
    },
    "appointment_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Appointment id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_create_appointment

WRITE: books ONE appointment for one patient with one practitioner, service and location, from start to end (UTC). Splose may send the patient its normal booking confirmation or reminders according to the practice's settings, and the appointment can later be invoiced. Check splose_find_free_slots first. Not idempotent: calling twice books twice. POST /appointments.

destructive

Argument	Type	Description
end*	string	Appointment end (UTC), after start.
note	string	Appointment note.
start*	string	Appointment start (UTC).
caseId	integer	Case (funding plan) id to attach.
patientId*	integer	Patient id.
serviceId*	integer	Service id.
locationId*	integer	Location id.
practitionerId*	integer	Practitioner id.

splose_create_contact

WRITE: adds ONE contact (GP, plan manager, referrer, payer). type, name and email are required (type is Splose's contact type, e.g. Standard; see splose_list_contacts for the values in use). Not idempotent: calling twice creates two contacts. POST /contacts.

Argument	Type	Description
name*	string	Display name, e.g. a plan manager's business name.
type*	string	Contact type, e.g. Standard (copy the value from an existing contact).
email*	string
state	string
title	string
suburb	string
country	string
lastName	string
addressL1	string
addressL2	string

splose_create_patient

WRITE: adds ONE new patient record (first and last name required). Search with splose_list_patients first to avoid a duplicate. Patient messaging follows the practice's settings and communicationPreference. Not idempotent: calling twice creates two patients. HEALTH DATA: only enter what the user supplied. POST /patients.

Argument	Type	Description
irn	string	Medicare reference number.
sex	string
city	string
alert	string	Alert message shown on the patient record.
email	string
state	string
title	string	e.g. Mr., Ms., Dr.
country	string
lastname*	string	Last name.
pronouns	string
timezone

splose_find_free_slots

Bookable free slots for one or more practitioners at a location for one patient service, between from and to (the window is at most 7 days). Returns, per practitioner, the start/end of each open slot in UTC. Read-only. GET /free-slots.

read-only

Argument	Type	Description
to	string	End of the search window, up to 7 days after from.
from*	string	Start of the search window (UTC).
interval	integer	Slot step in minutes (default 15).
serviceId*	integer	Service id (splose_list_services).
locationId*	integer	Location id (splose_list_locations).
practitionerIds*	array	One or more practitioner ids.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "serviceId",
    "locationId",
    "practitionerIds",
    "from"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "End of the search window, up to 7 days after from."
    },
    "from": {
      "type": "string",
      "description": "Start of the search window (UTC)."
    },
    "interval": {
      "type": "integer",
      "maximum": 240,
      "minimum": 5,
      "description": "Slot step in minutes (default 15)."
    },
    "serviceId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Service id (splose_list_services).",
      "exclusiveMinimum": 0
    },
    "locationId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Location id (splose_list_locations).",
      "exclusiveMinimum": 0
    },
    "practitionerIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "One or more practitioner ids."
    }
  }
}

splose_get_account

The organisation and the practitioner who owns the API key, plus the key's expiry date. Good first call. GET /me.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

splose_get_appointment

One appointment in full, with each patient's status, case, invoice and cancellation details. GET /appointments/{id}.

read-only

Argument	Type	Description
appointment_id*	integer	Appointment id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "appointment_id"
  ],
  "properties": {
    "appointment_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Appointment id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_get_case

One case in full, with its appointment connections. GET /cases/{id}.

read-only

Argument	Type	Description
case_id*	integer	Case id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "case_id"
  ],
  "properties": {
    "case_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Case id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_get_contact

One contact in full. GET /contacts/{id}.

read-only

Argument	Type	Description
contact_id*	integer	Contact id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id"
  ],
  "properties": {
    "contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Contact id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_get_invoice

One invoice in full with its line items and payments. GET /invoices/{id}.

read-only

Argument	Type	Description
invoice_id*	integer	Invoice id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "invoice_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoice id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_get_location

One location in full. GET /locations/{id}.

read-only

Argument	Type	Description
location_id*	integer	Location id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "location_id"
  ],
  "properties": {
    "location_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Location id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_get_patient

One patient in full: contact details, address, NDIS number and plan info, Medicare/health fund, emergency contact, tags and custom fields. HEALTH DATA. GET /patients/{id}.

read-only

Argument	Type	Description
patient_id*	integer	Patient id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "patient_id"
  ],
  "properties": {
    "patient_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Patient id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_get_payment

One payment in full. GET /payments/{id}.

read-only

Argument	Type	Description
payment_id*	integer	Payment id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "payment_id"
  ],
  "properties": {
    "payment_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Payment id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_get_practitioner

One practitioner in full, including provider numbers and connections. GET /practitioners/{id}.

read-only

Argument	Type	Description
practitioner_id*	integer	Practitioner id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "practitioner_id"
  ],
  "properties": {
    "practitioner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Practitioner id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_get_practitioner_availability

A practitioner's working-hours availability per date and location (start/end time, weekly or fortnightly repeat). The window is at most 100 days. This is the roster, not the open slots: use splose_find_free_slots for bookable times. GET /availabilities/{practitionerId}.

read-only

Argument	Type	Description
endDate*	string	Last date of the window, at most 100 days after startDate.
startDate*	string	First date of the window.
locationId	integer	Only this location.
practitioner_id*	integer	Practitioner id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "practitioner_id",
    "startDate",
    "endDate"
  ],
  "properties": {
    "endDate": {
      "type": "string",
      "description": "Last date of the window, at most 100 days after startDate."
    },
    "startDate": {
      "type": "string",
      "description": "First date of the window."
    },
    "locationId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only this location.",
      "exclusiveMinimum": 0
    },
    "practitioner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Practitioner id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_get_service

One service in full, including provider-travel pricing. GET /services/{id}.

read-only

Argument	Type	Description
service_id*	integer	Service id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "service_id"
  ],
  "properties": {
    "service_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Service id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_list_appointments

Appointments in id order: start/end (UTC), service, location, practitioner, price, note and the per-patient status (Arrived, Did not arrive, Cancelled, Completed, cancellation reason, invoice id). Filter by time window, patient, practitioner or status. GET /appointments.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
status	string	Patient status of the appointment.
start_gt	string	Only appointments starting after this date or date-time.
start_lt	string	Only appointments starting before this date or date-time.
patientId	integer	Only appointments of this patient.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).

splose_list_busy_times

Blocked-out time in practitioner calendars (leave, admin time): start/end, location, practitioners, type and note. GET /busy-times.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
start_gt	string	Only busy times starting after this date or date-time.
start_lt	string	Only busy times starting before this date or date-time.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
busyTimeTypeId	integer	Only busy times of this type.
practitionerId	integer	Only busy times of this practitioner.
include_archived

splose_list_cancellation_reasons

Cancellation reasons with their ids, needed to cancel an appointment. GET /cancellation-reasons.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
include_archived	boolean	true to include archived objects (default false).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "include_archived": {
      "type": "boolean",
      "description": "true to include archived objects (default false)."
    }
  }
}

splose_list_cases

Cases (funding referrals and plans): case number, budget, hours or appointment allowance, issue and expiry dates, tracking type, open flag and utilisation alert. HEALTH/FUNDING DATA. GET /cases.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
status	string	Case status.
contactId	integer	Only cases referred by / billed to this contact.
patientId	integer	Only cases of this patient.
trackType	string	How the case is tracked.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
practitionerId	integer

splose_list_contacts

Contacts (GPs, plan managers, referrers, invoice recipients): name, type, email, address, phones and the ids of their patients, invoices and cases. GET /contacts.

read-only

Argument	Type	Description
email	string	Contact email.
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
lastname	string	Contact last name.
firstname	string	Contact first name.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
phoneNumber	string	Phone number without the country code.
include_archived	boolean	true to include archived objects (default false).

splose_list_credit_notes

Credit notes: number, invoice, patient, subtotal, tax, total, sent status, items and allocations. GET /credit-notes.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
invoiceId	integer	Only credit notes of this invoice.
patientId	integer	Only credit notes of this patient.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
sentStatus	string	Sent status.
practitionerId	integer	Only credit notes created by this practitioner.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "invoiceId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only credit notes of this invoice.",
      "exclusiveMinimum": 0
    },
    "patientId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only credit notes of this patient.",
      "exclusiveMinimum": 0
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "sentStatus": {
      "enum": [
        "Sent",
        "Viewed"
      ],
      "type": "string",
      "description": "Sent status."
    },
    "practitionerId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only credit notes created by this practitioner.",
      "exclusiveMinimum": 0
    }
  }
}

splose_list_custom_fields

The custom fields defined for patients: id, name, type (short text, dropdown, date and so on), required flag and options. GET /custom-field/.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

splose_list_invoices

Invoices: number, issue/due dates, patient, contact, location, practitioner, subtotal, tax, total, paid amount, status (Draft, Awaiting Payment, Paid), line items and payment ids. Use status=Awaiting Payment for what is owed. GET /invoices.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
status	string	Invoice status.
patientId	integer	Only invoices of this patient.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
locationId	integer	Only invoices created at this location.
practitionerId	integer	Only invoices created by this practitioner.
include_archived

splose_list_locations

Practice locations: title, address, phone, email, timezone, online-booking flag and the ids of the services offered there. GET /locations.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
title	string	Location title.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
include_archived	boolean	true to include archived objects (default false).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "title": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Location title."
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "include_archived": {
      "type": "boolean",
      "description": "true to include archived objects (default false)."
    }
  }
}

splose_list_patient_forms

Forms sent to patients: title, status (Incomplete, In progress, Completed), patient, appointment, template and submission time. The form content is included. GET /patient-forms.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
patientId	integer	Only forms of this patient.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
templateId	integer	Only forms from this template.
include_archived	boolean	true to include archived objects (default false).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "patientId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only forms of this patient.",
      "exclusiveMinimum": 0
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "templateId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only forms from this template.",
      "exclusiveMinimum": 0
    },
    "include_archived": {
      "type": "boolean",
      "description": "true to include archived objects (default false)."
    }
  }
}

splose_list_patients

Patients (clients) of the practice, filtered, in id order, as short rows: id, name, email, birthdate, phones, tags, alert, archived. Use splose_get_patient for the full record. HEALTH DATA: only look people up when the user asks. GET /patients.

read-only

Argument	Type	Description
ids	array	Only these patient ids (max 100).
email	string	Patient email.
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
lastname	string	Patient last name.
birthdate	string	Patient birth date, yyyy-mm-dd.
firstname	string	Patient first name.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).

splose_list_payment_methods

Payment methods (cash, card, bank transfer and so on) with their ids, needed to record a payment. GET /payment-methods.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
include_archived	boolean	true to include archived objects (default false).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "include_archived": {
      "type": "boolean",
      "description": "true to include archived objects (default false)."
    }
  }
}

splose_list_payments

Payments received: payment number, amount, date, patient, location, payment method, the invoices each payment settles and credit allocations. GET /payments.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
patientId	integer	Only payments of this patient.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
locationId	integer	Only payments created at this location.
include_archived	boolean	true to include archived objects (default false).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "patientId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only payments of this patient.",
      "exclusiveMinimum": 0
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "locationId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only payments created at this location.",
      "exclusiveMinimum": 0
    },
    "include_archived": {
      "type": "boolean",
      "description": "true to include archived objects (default false)."
    }
  }
}

splose_list_practitioners

Practitioners (staff): name, email, profession, role, active flag, online-booking flag, timezone and their location/service connections. GET /practitioners.

read-only

Argument	Type	Description
email	string	Practitioner email.
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
isActive	boolean	true = only active practitioners, false = only inactive.
lastname	string	Practitioner last name.
roleName	string	A predefined or custom role name.
firstname	string	Practitioner first name.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).

splose_list_services

The service catalogue: name, type, code, duration (minutes), unit (Hour or Each), price, tax type, group size and tags. GET /services.

read-only

Argument	Type	Description
code	string	Service code.
name	string	Service name.
type	string	Service type.
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
serviceTag	string	A service tag.
include_archived	boolean	true to include archived objects (default false).

splose_list_support_activities

Non-appointment billable activities (NDIS support activities): patient, practitioner, service, item code, quantity, price, invoice id. GET /support-activities.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
start_gt	string	Only activities starting after this date or date-time.
start_lt	string	Only activities starting before this date or date-time.
patientId	integer	Only activities of this patient.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
include_archived	boolean	true to include archived objects (default false).

Input schema (JSON)

splose_list_waitlist

Waitlist entries: patient, practitioner, location, wanted services, preferred days and time, tags and active flag. GET /waitlists.

read-only

Argument	Type	Description
id_gt	integer	Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).
id_lt	integer	Only objects with an id less than this: the previous page.
isActive	boolean	true = still waiting, false = closed.
patientId	integer	Only items of this patient.
update_gt	string	Only objects updated after this date or date-time (UTC).
update_lt	string	Only objects updated before this date or date-time (UTC).
locationId	integer	Only items for this location.
serviceIds	array	Only items waiting for these services.
dateAddedGt	string	Only items added after this date.

splose_mark_patient_arrived

WRITE: marks the patient of ONE appointment as arrived (check-in). For a group appointment pass patient_id to mark just that patient. Marking twice has the same effect. POST /appointments/{id}/arrival or /appointments/{id}/patients/{patientId}/arrival.

Argument	Type	Description
patient_id	integer	Group appointments only: the patient who arrived.
appointment_id*	integer	Appointment id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "appointment_id"
  ],
  "properties": {
    "patient_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Group appointments only: the patient who arrived.",
      "exclusiveMinimum": 0
    },
    "appointment_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Appointment id.",
      "exclusiveMinimum": 0
    }
  }
}

splose_record_payment

WRITE, MONEY: records ONE payment received (cash, card, transfer) against ONE invoice; it moves the invoice towards Paid and is shown in the patient's account. It does NOT charge anyone's card. amount must not exceed what is owed (check splose_get_invoice). Not idempotent: calling twice records two payments, and this server cannot delete a payment, so confirm the details with the user first and pass confirm: true. Ids come from splose_get_invoice and splose_list_payment_methods. POST /payments.

destructive

Argument	Type	Description
amount*	number	Amount paid, in dollars.
confirm*	boolean	Must be true: the user has confirmed the invoice, amount and payment method.
invoiceId*	integer	Invoice id the payment settles.
patientId*	integer	Patient id of the invoice.
locationId*	integer	Location id.
paymentDate*	string	Date the money was received.
paymentMethodId*

splose_update_appointment

WRITE: changes the time, service, location, practitioner, case or patient of ONE existing appointment; send only the fields to change. Splose may notify the patient of a change according to the practice's settings. Same input twice gives the same result. PUT /appointments/{id}.

destructive

Argument	Type	Description
end	string	New end (UTC).
start	string	New start (UTC).
caseId	integer	New case id.
patientId	integer	New patient id.
serviceId	integer	New service id.
locationId	integer	New location id.
appointment_id*	integer	Appointment id.
practitionerId	integer	New practitioner id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "appointment_id"
  ],
  "properties": {
    "end": {
      "type": "string",
      "description": "New end (UTC)."
    },
    "start": {
      "type": "string",
      "description": "New start (UTC)."
    },
    "caseId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "New case id.",
      "exclusiveMinimum": 0
    },
    "patientId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "New patient id.",
      "exclusiveMinimum": 0
    },
    "serviceId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "New service id.",
      "exclusiveMinimum": 0
    },
    "locationId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "New location id.",
      "exclusiveMinimum": 0
    },
    "appointment_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Appointment id.",
      "exclusiveMinimum": 0
    },
    "practitionerId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "New practitioner id.",
      "exclusiveMinimum": 0
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "type",
    "name",
    "email"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Display name, e.g. a plan manager's business name."
    },
    "type": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "Contact type, e.g. Standard (copy the value from an existing contact)."
    },
    "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": 320
    },
    "state": {
      "type": "string",
      "maxLength": 50
    },
    "title": {
      "type": "string",
      "maxLength": 30
    },
    "suburb": {
      "type": "string",
      "maxLength": 100
    },
    "country": {
      "type": "string",
      "maxLength": 100
    },
    "lastName": {
      "type": "string",
      "maxLength": 100
    },
    "addressL1": {
      "type": "string",
      "maxLength": 200
    },
    "addressL2": {
      "type": "string",
      "maxLength": 200
    },
    "firstName": {
      "type": "string",
      "maxLength": 100
    },
    "doctorType": {
      "enum": [
        "GP",
        "Specialist"
      ],
      "type": "string"
    },
    "occupation": {
      "type": "string",
      "maxLength": 100
    },
    "postalCode": {
      "type": "string",
      "maxLength": 20
    },
    "companyName": {
      "type": "string",
      "maxLength": 200
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "phoneNumber"
        ],
        "properties": {
          "code": {
            "type": "string",
            "maxLength": 8,
            "description": "Country code, e.g. +61."
          },
          "type": {
            "enum": [
              "Mobile",
              "Home",
              "Work",
              "Fax",
              "Other"
            ],
            "type": "string"
          },
          "phoneNumber": {
            "type": "string",
            "maxLength": 32,
            "minLength": 3,
            "description": "Number without the country code."
          }
        },
        "additionalProperties": false
      },
      "maxItems": 5
    },
    "preferredName": {
      "type": "string",
      "maxLength": 100
    },
    "providerNumber": {
      "type": "string",
      "maxLength": 50
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "firstname",
    "lastname"
  ],
  "properties": {
    "irn": {
      "type": "string",
      "maxLength": 5,
      "description": "Medicare reference number."
    },
    "sex": {
      "type": "string",
      "maxLength": 50
    },
    "city": {
      "type": "string",
      "maxLength": 100
    },
    "alert": {
      "type": "string",
      "maxLength": 5000,
      "description": "Alert message shown on the patient record."
    },
    "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": 320
    },
    "state": {
      "type": "string",
      "maxLength": 50
    },
    "title": {
      "type": "string",
      "maxLength": 30,
      "description": "e.g. Mr., Ms., Dr."
    },
    "country": {
      "type": "string",
      "maxLength": 100
    },
    "lastname": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Last name."
    },
    "pronouns": {
      "type": "string",
      "maxLength": 50
    },
    "timezone": {
      "type": "string",
      "maxLength": 64,
      "description": "IANA timezone, e.g. Australia/Adelaide."
    },
    "addressL1": {
      "type": "string",
      "maxLength": 200
    },
    "addressL2": {
      "type": "string",
      "maxLength": 200
    },
    "birthdate": {
      "type": "string",
      "description": "Birth date, yyyy-mm-dd."
    },
    "extraInfo": {
      "type": "string",
      "maxLength": 5000
    },
    "firstname": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "First name."
    },
    "middleName": {
      "type": "string",
      "maxLength": 100
    },
    "ndisNumber": {
      "type": "string",
      "maxLength": 20,
      "description": "NDIS participant number."
    },
    "postalCode": {
      "type": "string",
      "maxLength": 20
    },
    "medicareNum": {
      "type": "string",
      "maxLength": 20
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "phoneNumber"
        ],
        "properties": {
          "code": {
            "type": "string",
            "maxLength": 8,
            "description": "Country code, e.g. +61."
          },
          "type": {
            "enum": [
              "Mobile",
              "Home",
              "Work",
              "Fax",
              "Other"
            ],
            "type": "string"
          },
          "phoneNumber": {
            "type": "string",
            "maxLength": 32,
            "minLength": 3,
            "description": "Number without the country code."
          }
        },
        "additionalProperties": false
      },
      "maxItems": 5
    },
    "preferredName": {
      "type": "string",
      "maxLength": 100
    },
    "genderIdentity": {
      "type": "string",
      "maxLength": 100
    },
    "invoiceRecipientId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Contact id that receives the invoices.",
      "exclusiveMinimum": 0
    },
    "emergencyContactName": {
      "type": "string",
      "maxLength": 200
    },
    "emergencyContactNumber": {
      "type": "string",
      "maxLength": 32
    },
    "communicationPreference": {
      "enum": [
        "NONE",
        "SMS",
        "SMS_EMAIL",
        "EMAIL"
      ],
      "type": "string",
      "description": "Defaults to the organisation's preference."
    },
    "emergencyContactRelationship": {
      "type": "string",
      "maxLength": 100
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "status": {
      "enum": [
        "Arrived",
        "Did not arrive",
        "Cancelled",
        "Completed"
      ],
      "type": "string",
      "description": "Patient status of the appointment."
    },
    "start_gt": {
      "type": "string",
      "description": "Only appointments starting after this date or date-time."
    },
    "start_lt": {
      "type": "string",
      "description": "Only appointments starting before this date or date-time."
    },
    "patientId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only appointments of this patient.",
      "exclusiveMinimum": 0
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "practitionerId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only appointments of this practitioner.",
      "exclusiveMinimum": 0
    },
    "include_archived": {
      "type": "boolean",
      "description": "true to include archived objects (default false)."
    },
    "status_update_gt": {
      "type": "string",
      "description": "Only appointments whose status changed after this date or date-time."
    },
    "status_update_lt": {
      "type": "string",
      "description": "Only appointments whose status changed before this date or date-time."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these patient ids (max 100)."
    },
    "email": {
      "type": "string",
      "maxLength": 320,
      "minLength": 3,
      "description": "Patient email."
    },
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "lastname": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Patient last name."
    },
    "birthdate": {
      "type": "string",
      "description": "Patient birth date, yyyy-mm-dd."
    },
    "firstname": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Patient first name."
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "patientTag": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "A patient tag, e.g. Self-managed."
    },
    "phoneNumber": {
      "type": "string",
      "maxLength": 32,
      "minLength": 3,
      "description": "Phone number without the country code."
    },
    "include_archived": {
      "type": "boolean",
      "description": "true to include archived objects (default false)."
    }
  }
}

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Service code."
    },
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Service name."
    },
    "type": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Service type."
    },
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "serviceTag": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "A service tag."
    },
    "include_archived": {
      "type": "boolean",
      "description": "true to include archived objects (default false)."
    }
  }
}

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "start_gt": {
      "type": "string",
      "description": "Only activities starting after this date or date-time."
    },
    "start_lt": {
      "type": "string",
      "description": "Only activities starting before this date or date-time."
    },
    "patientId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only activities of this patient.",
      "exclusiveMinimum": 0
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "include_archived": {
      "type": "boolean",
      "description": "true to include archived objects (default false)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "id_gt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id greater than this: the next page (pass the previous reply's next_id_gt).",
      "exclusiveMinimum": 0
    },
    "id_lt": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only objects with an id less than this: the previous page.",
      "exclusiveMinimum": 0
    },
    "isActive": {
      "type": "boolean",
      "description": "true = still waiting, false = closed."
    },
    "patientId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only items of this patient.",
      "exclusiveMinimum": 0
    },
    "update_gt": {
      "type": "string",
      "description": "Only objects updated after this date or date-time (UTC)."
    },
    "update_lt": {
      "type": "string",
      "description": "Only objects updated before this date or date-time (UTC)."
    },
    "locationId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only items for this location.",
      "exclusiveMinimum": 0
    },
    "serviceIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 50,
      "minItems": 1,
      "description": "Only items waiting for these services."
    },
    "dateAddedGt": {
      "type": "string",
      "description": "Only items added after this date."
    },
    "dateAddedLt": {
      "type": "string",
      "description": "Only items added before this date."
    },
    "userGroupId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only items for this practitioner group.",
      "exclusiveMinimum": 0
    },
    "practitionerId": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only items for this practitioner.",
      "exclusiveMinimum": 0
    },
    "include_archived": {
      "type": "boolean",
      "description": "true to include archived objects (default false)."
    }
  }
}