Cliniko
Category: EHR & Practice Mgmt
Node id: cliniko
Standards: GDPR, HIPAA-eligible
Cliniko practice management (AU/UK/NZ) REST API. Tier 1 — open public API, self-service signup. Auth via API key Basic.
What it does
- Patient CRUD (list, get, create)
- Appointment, practitioner, business reads
- Treatment notes and invoice retrieval
- Automatic shard detection from API key suffix
Use cases
- Sync allied-health clinic patients into FHIR
- Pull treatment notes into a clinical RAG index
- Reconcile invoices against billing pipelines
Runtime
- Performance tier:
fast
Input ports
| Name | Type | Required | Description |
|---|---|---|---|
patient_id | text | No | Cliniko patient ID |
patient | json | No | Patient payload for create |
query | json | No | Optional query parameters (e.g. updated_at, page) |
Output ports
| Name | Type | Required | Description |
|---|---|---|---|
result | json | No | Parsed JSON response payload from the vendor API |
metadata | json | No | Operation, HTTP status code, and content length |
success | boolean | No | True if HTTP 2xx |
Settings
Basic
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Operation | operation | enum | Yes | list_appointments | list_patients, get_patient, create_patient, list_appointments, list_practitioners, list_businesses, list_treatment_notes, list_invoices |
Auth
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| API Key | api_key | secret | Yes | Cliniko API key (suffix encodes the shard, e.g. -au1) |
Advanced
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Base URL | base_url | string | No | Optional override (defaults derived from key suffix) | ||
| User-Agent | user_agent | string | No | TietAI-Hydra (support@tiet.ai) | Cliniko requires identifying User-Agent (vendor/contact) |
Errors
| Code | Description |
|---|---|
CLINIKO_AUTH_FAILED | API key missing or invalid |
CLINIKO_REQUEST_FAILED | HTTP request to Cliniko failed |
See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.
¿Algo no está claro? Envíe sus comentarios sobre la documentación por correo electrónico..