Patient

Patients are the people that book in for appointments. There isn't much in Cliniko that doesn't revolve around patients.

When you're working with patient information, make sure you abide by the relevant regulations for security and privacy.

A couple of fields in the patient record deserve special consideration:

accepted_privacy_policy stores the patient's consent to the business's own privacy policy. Values can be null (no response), true (accepted) or false (rejected). Please consider how this may affect you storing information on this patient.

time_zone will contain a valid IANA time zone identifier if the patient's time zone has been set, or null if it hasn't. It can be set via the API, in which case it accepts IANA time zone identifiers.

Patient

accepted_email_marketing
boolean or null
accepted_privacy_policy
boolean or null
accepted_sms_marketing
boolean or null
address_1
string or null <= 255 characters
address_2
string or null <= 255 characters
address_3
string or null <= 255 characters
appointment_notes
string or null
object
archived_at
string or null <date-time>
object
city
string or null <= 255 characters
object
country
string or null
Deprecated
country_code
string or null

ISO 3166-1 country code

created_at
string <date-time>
object or null
date_of_birth
string or null <date>
deleted_at
string or null <date-time>
dva_card_number
string or null^[NVQSWT]([A-Z ][0-9]{1,6}|[A-Z]{2}[0-9]{1,5}...
email
string or null <= 255 characters ^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
emergency_contact
string or null <= 255 characters
first_name
string <= 255 characters
gender
string or null
Deprecated
gender_identity
string or null
id
string <int64>
invoice_default_to
string or null
invoice_email
string or null^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
invoice_extra_information
string or null
object
label
string or null

Full name

last_name
string <= 255 characters
object
object
object
medicare
string or null <= 255 characters
medicare_reference_number
string or null <= 255 characters
merged_at
string or null <date-time>
object
notes
string or null
occupation
string or null <= 255 characters
old_reference_id
string or null <= 255 characters
object
Array of objects or null (PhoneNumber)
post_code
string or null
preferred_first_name
string or null <= 255 characters
object or null
receives_cancellation_emails
boolean or null
receives_confirmation_emails
boolean or null
referral_source
string or null <= 255 characters
object
object
reminder_type
string or null
Enum: "None" "SMS" "Email" "SMS & Email"
sex
string or null
state
string or null
time_zone
title
string or null <= 255 characters
updated_at
string <date-time>
{}

List patients

get/patients
SecuritybasicAuth
Request
query Parameters
order
string
Deprecated
Enum: "asc" "desc"
page
integer
per_page
integer [ 1 .. 100 ]
q[]
Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value Format
archived_at date-time
created_at date-time
date_of_birth date
email string
first_name string
id int64
last_name string
old_reference_id string
preferred_first_name string
updated_at date-time
sort
Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
Responses
200

successful operation

Request samples 
Response samples 
application/json
{}
Create patient
post/patients
SecuritybasicAuth 
Request 
Request Body schema: application/json
accepted_email_marketing
boolean or null
 
accepted_privacy_policy
boolean or null
 
address_1
string or null  <= 255 characters 
 
address_2
string or null  <= 255 characters 
 
address_3
string or null  <= 255 characters 
 
appointment_notes
string or null
 
city
string or null  <= 255 characters 
 
concession_type_id
string <int64> 
concession type id


 
country
string or null
 
country_code
string or null
ISO 3166-1 country code


 
object or null
 
date_of_birth
string or null <date> 
 
dva_card_number
string or null^[NVQSWT]([A-Z ][0-9]{1,6}|[A-Z]{2}[0-9]{1,5}...
 
email
string or null  <= 255 characters ^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
 
emergency_contact
string or null  <= 255 characters 
 
first_name
string  <= 255 characters 
 
gender_identity
string or null
 
invoice_default_to
string or null
 
invoice_email
string or null^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
 
invoice_extra_information
string or null
 
last_name
string  <= 255 characters 
 
medicare
string or null  <= 255 characters 
 
medicare_reference_number
string or null  <= 255 characters 
 
notes
string or null
 
occupation
string or null  <= 255 characters 
 
old_reference_id
string or null  <= 255 characters 
 
Array of objects
 
post_code
string or null
 
preferred_first_name
string or null  <= 255 characters 
 
object or null
 
receives_cancellation_emails
boolean or null
 
receives_confirmation_emails
boolean or null
 
referral_source
string or null  <= 255 characters 
 
referring_doctor_id
string <int64> 
contact id


 
reminder_type
string or null
 Enum: "None" "SMS" "Email" "SMS & Email"  
sex
string or null
 
state
string or null
 
time_zone
title
string or null  <= 255 characters 
 
unsubscribe_sms_marketing
boolean
 
Responses 
201
Resource was created


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "accepted_email_marketing": true,
  • "accepted_privacy_policy": true,
  • "address_1": "string",
  • "address_2": "string",
  • "address_3": "string",
  • "appointment_notes": "string",
  • "city": "string",
  • "concession_type_id": "1",
  • "country": "string",
  • "country_code": "AU",
  • "custom_fields": {
    • "sections": [
      • {
        }
      ]
    },
  • "date_of_birth": "2019-08-24",
  • "dva_card_number": "string",
  • "email": "string",
  • "emergency_contact": "string",
  • "first_name": "string",
  • "gender_identity": "string",
  • "invoice_default_to": "string",
  • "invoice_email": "string",
  • "invoice_extra_information": "string",
  • "last_name": "string",
  • "medicare_reference_number": "string",
  • "medicare": "string",
  • "notes": "string",
  • "occupation": "string",
  • "old_reference_id": "string",
  • "post_code": "string",
  • "preferred_first_name": "string",
  • "pronouns": {
    • "accusative": "string",
    • "nominative": "string",
    • "predicative_possessive": "string",
    • "pronominal_possessive": "string",
    • "reflexive": "string"
    },
  • "receives_cancellation_emails": true,
  • "receives_confirmation_emails": true,
  • "referral_source": "string",
  • "referring_doctor_id": "1",
  • "reminder_type": "None",
  • "sex": "string",
  • "state": "string",
  • "time_zone": "Australia/Melbourne",
  • "title": "string",
  • "unsubscribe_sms_marketing": true,
  • "patient_phone_numbers": [
    • {
      • "phone_type": "Fax",
      • "number": "0-123-456-78"
      }
    ]
}
Response samples 
application/json
{}
Get patient
get/patients/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
query Parameters
q[]
Array of strings
Filter result by one or more fields.


See Filtering Results


Available filters:






Value
Format





archived_at
date-time





 
Responses 
200
Successful operation


Request samples 
Response samples 
application/json
{}
Update patient
patch/patients/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Request Body schema: application/json
accepted_email_marketing
boolean or null
 
accepted_privacy_policy
boolean or null
 
address_1
string or null  <= 255 characters 
 
address_2
string or null  <= 255 characters 
 
address_3
string or null  <= 255 characters 
 
appointment_notes
string or null
 
city
string or null  <= 255 characters 
 
concession_type_id
string <int64> 
concession type id


 
country
string or null
 
country_code
string or null
ISO 3166-1 country code


 
object or null
 
date_of_birth
string or null <date> 
 
dva_card_number
string or null^[NVQSWT]([A-Z ][0-9]{1,6}|[A-Z]{2}[0-9]{1,5}...
 
email
string or null  <= 255 characters ^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
 
emergency_contact
string or null  <= 255 characters 
 
first_name
string  <= 255 characters 
 
gender_identity
string or null
 
invoice_default_to
string or null
 
invoice_email
string or null^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
 
invoice_extra_information
string or null
 
last_name
string  <= 255 characters 
 
medicare
string or null  <= 255 characters 
 
medicare_reference_number
string or null  <= 255 characters 
 
notes
string or null
 
occupation
string or null  <= 255 characters 
 
old_reference_id
string or null  <= 255 characters 
 
Array of objects
 
post_code
string or null
 
preferred_first_name
string or null  <= 255 characters 
 
object or null
 
receives_cancellation_emails
boolean or null
 
receives_confirmation_emails
boolean or null
 
referral_source
string or null  <= 255 characters 
 
referring_doctor_id
string <int64> 
contact id


 
reminder_type
string or null
 Enum: "None" "SMS" "Email" "SMS & Email"  
sex
string or null
 
state
string or null
 
time_zone
title
string or null  <= 255 characters 
 
unsubscribe_sms_marketing
boolean
 
Responses 
200
Resource was updated


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "accepted_email_marketing": true,
  • "accepted_privacy_policy": true,
  • "address_1": "string",
  • "address_2": "string",
  • "address_3": "string",
  • "appointment_notes": "string",
  • "city": "string",
  • "concession_type_id": "1",
  • "country": "string",
  • "country_code": "AU",
  • "custom_fields": {
    • "sections": [
      • {
        }
      ]
    },
  • "date_of_birth": "2019-08-24",
  • "dva_card_number": "string",
  • "email": "string",
  • "emergency_contact": "string",
  • "first_name": "string",
  • "gender_identity": "string",
  • "invoice_default_to": "string",
  • "invoice_email": "string",
  • "invoice_extra_information": "string",
  • "last_name": "string",
  • "medicare_reference_number": "string",
  • "medicare": "string",
  • "notes": "string",
  • "occupation": "string",
  • "old_reference_id": "string",
  • "post_code": "string",
  • "preferred_first_name": "string",
  • "pronouns": {
    • "accusative": "string",
    • "nominative": "string",
    • "predicative_possessive": "string",
    • "pronominal_possessive": "string",
    • "reflexive": "string"
    },
  • "receives_cancellation_emails": true,
  • "receives_confirmation_emails": true,
  • "referral_source": "string",
  • "referring_doctor_id": "1",
  • "reminder_type": "None",
  • "sex": "string",
  • "state": "string",
  • "time_zone": "Australia/Melbourne",
  • "title": "string",
  • "unsubscribe_sms_marketing": true,
  • "patient_phone_numbers": [
    • {
      • "phone_type": "Fax",
      • "number": "0-123-456-78"
      }
    ]
}
Response samples 
application/json
{}
Archive patientDeprecated
delete/patients/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived successfully


Request samples 
Archive patient
post/patients/{id}/archive
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived


Request samples 
Unarchive patient
post/patients/{id}/unarchive
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
200
Resource was unarchived


Request samples 
Response samples 
application/json
{}