Skip to main content

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​

NameTypeRequiredDescription
patient_idtextNoCliniko patient ID
patientjsonNoPatient payload for create
queryjsonNoOptional query parameters (e.g. updated_at, page)

Output ports​

NameTypeRequiredDescription
resultjsonNoParsed JSON response payload from the vendor API
metadatajsonNoOperation, HTTP status code, and content length
successbooleanNoTrue if HTTP 2xx

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
OperationoperationenumYeslist_appointmentslist_patients, get_patient, create_patient, list_appointments, list_practitioners, list_businesses, list_treatment_notes, list_invoices

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
API Keyapi_keysecretYesCliniko API key (suffix encodes the shard, e.g. -au1)

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Base URLbase_urlstringNoOptional override (defaults derived from key suffix)
User-Agentuser_agentstringNoTietAI-Hydra (support@tiet.ai)Cliniko requires identifying User-Agent (vendor/contact)

Errors​

CodeDescription
CLINIKO_AUTH_FAILEDAPI key missing or invalid
CLINIKO_REQUEST_FAILEDHTTP 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.

Something unclear? Send documentation feedback by email.