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.
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 |
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}... |
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_confirmation_emails | boolean or null |
referral_source | string or null <= 255 characters |
object | |
reminder_type | string or null Enum: "None" "SMS" "Email" "SMS & Email" |
sex | string or null |
state | string or null |
time_zone | string or null |
title | string or null <= 255 characters |
updated_at | string <date-time> |
{- "accepted_email_marketing": true,
- "accepted_privacy_policy": true,
- "accepted_sms_marketing": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "appointment_notes": "string",
- "archived_at": "2019-08-24T14:15:22Z",
- "city": "string",
- "country": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "sections": [
- {
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "archived": true,
- "fields": [
- {
- "archived": true,
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "type": "string",
- "options": [
- {
- "archived": null,
- "name": null,
- "token": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "archived": true,
- "selected": true,
- "value": "string"
}, - "value": "string"
}
]
}
]
}, - "date_of_birth": "2019-08-24",
- "deleted_at": "2019-08-24T14:15:22Z",
- "dva_card_number": "string",
- "email": "string",
- "emergency_contact": "string",
- "first_name": "string",
- "gender": "string",
- "gender_identity": "string",
- "id": "1",
- "invoice_default_to": "string",
- "invoice_email": "string",
- "invoice_extra_information": "string",
- "label": "string",
- "last_name": "string",
- "medicare": "string",
- "medicare_reference_number": "string",
- "merged_at": "2019-08-24T14:15:22Z",
- "notes": "string",
- "occupation": "string",
- "old_reference_id": "string",
- "patient_attachments": {
}, - "patient_phone_numbers": [
- {
- "normalized_number": "39012345678",
- "number": "0-123-456-78",
- "phone_type": "Fax"
}
], - "post_code": "string",
- "preferred_first_name": "string",
- "pronouns": {
- "accusative": "string",
- "nominative": "string",
- "predicative_possessive": "string",
- "pronominal_possessive": "string",
- "reflexive": "string"
}, - "receives_confirmation_emails": true,
- "referral_source": "string",
- "reminder_type": "None",
- "sex": "string",
- "state": "string",
- "time_zone": "Australia/Melbourne",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
successful operation
{- "patients": [
- {
- "accepted_email_marketing": true,
- "accepted_privacy_policy": true,
- "accepted_sms_marketing": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "appointment_notes": "string",
- "archived_at": "2019-08-24T14:15:22Z",
- "city": "string",
- "country": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "sections": [
- {
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "archived": true,
- "fields": [
- {
- "archived": null,
- "name": null,
- "token": null,
- "type": null,
- "options": [ ],
- "other": { },
- "value": null
}
]
}
]
}, - "date_of_birth": "2019-08-24",
- "deleted_at": "2019-08-24T14:15:22Z",
- "dva_card_number": "string",
- "email": "string",
- "emergency_contact": "string",
- "first_name": "string",
- "gender": "string",
- "gender_identity": "string",
- "id": "1",
- "invoice_default_to": "string",
- "invoice_email": "string",
- "invoice_extra_information": "string",
- "label": "string",
- "last_name": "string",
- "medicare": "string",
- "medicare_reference_number": "string",
- "merged_at": "2019-08-24T14:15:22Z",
- "notes": "string",
- "occupation": "string",
- "old_reference_id": "string",
- "patient_attachments": {
}, - "patient_phone_numbers": [
- {
- "normalized_number": "39012345678",
- "number": "0-123-456-78",
- "phone_type": "Fax"
}
], - "post_code": "string",
- "preferred_first_name": "string",
- "pronouns": {
- "accusative": "string",
- "nominative": "string",
- "predicative_possessive": "string",
- "pronominal_possessive": "string",
- "reflexive": "string"
}, - "receives_confirmation_emails": true,
- "referral_source": "string",
- "reminder_type": "None",
- "sex": "string",
- "state": "string",
- "time_zone": "Australia/Melbourne",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "total_entries": 1,
- "links": {
}
}
Resource was created
Resource could not be saved due to validation errors
{- "accepted_privacy_policy": true,
- "accepted_email_marketing": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "appointment_notes": "string",
- "city": "string",
- "concession_type_id": "1",
- "country": "string",
- "custom_fields": {
- "sections": [
- {
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "archived": true,
- "fields": [
- {
- "archived": true,
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "type": "string",
- "options": [
- {
- "archived": null,
- "name": null,
- "token": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "archived": true,
- "selected": true,
- "value": "string"
}, - "value": "string"
}
]
}
]
}, - "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": "string",
- "medicare_reference_number": "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_confirmation_emails": true,
- "referral_source": "string",
- "reminder_type": "None",
- "sex": "string",
- "state": "string",
- "time_zone": "Australia/Melbourne",
- "title": "string",
- "unsubscribe_sms_marketing": true,
- "referring_doctor_id": "1",
- "patient_phone_numbers": [
- {
- "phone_type": "Fax",
- "number": "0-123-456-78"
}
]
}
{- "accepted_email_marketing": true,
- "accepted_privacy_policy": true,
- "accepted_sms_marketing": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "appointment_notes": "string",
- "archived_at": "2019-08-24T14:15:22Z",
- "city": "string",
- "country": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "sections": [
- {
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "archived": true,
- "fields": [
- {
- "archived": true,
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "type": "string",
- "options": [
- {
- "archived": null,
- "name": null,
- "token": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "archived": true,
- "selected": true,
- "value": "string"
}, - "value": "string"
}
]
}
]
}, - "date_of_birth": "2019-08-24",
- "deleted_at": "2019-08-24T14:15:22Z",
- "dva_card_number": "string",
- "email": "string",
- "emergency_contact": "string",
- "first_name": "string",
- "gender": "string",
- "gender_identity": "string",
- "id": "1",
- "invoice_default_to": "string",
- "invoice_email": "string",
- "invoice_extra_information": "string",
- "label": "string",
- "last_name": "string",
- "medicare": "string",
- "medicare_reference_number": "string",
- "merged_at": "2019-08-24T14:15:22Z",
- "notes": "string",
- "occupation": "string",
- "old_reference_id": "string",
- "patient_attachments": {
}, - "patient_phone_numbers": [
- {
- "normalized_number": "39012345678",
- "number": "0-123-456-78",
- "phone_type": "Fax"
}
], - "post_code": "string",
- "preferred_first_name": "string",
- "pronouns": {
- "accusative": "string",
- "nominative": "string",
- "predicative_possessive": "string",
- "pronominal_possessive": "string",
- "reflexive": "string"
}, - "receives_confirmation_emails": true,
- "referral_source": "string",
- "reminder_type": "None",
- "sex": "string",
- "state": "string",
- "time_zone": "Australia/Melbourne",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
q[] | Array of strings |
Successful operation
{- "accepted_email_marketing": true,
- "accepted_privacy_policy": true,
- "accepted_sms_marketing": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "appointment_notes": "string",
- "archived_at": "2019-08-24T14:15:22Z",
- "city": "string",
- "country": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "sections": [
- {
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "archived": true,
- "fields": [
- {
- "archived": true,
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "type": "string",
- "options": [
- {
- "archived": null,
- "name": null,
- "token": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "archived": true,
- "selected": true,
- "value": "string"
}, - "value": "string"
}
]
}
]
}, - "date_of_birth": "2019-08-24",
- "deleted_at": "2019-08-24T14:15:22Z",
- "dva_card_number": "string",
- "email": "string",
- "emergency_contact": "string",
- "first_name": "string",
- "gender": "string",
- "gender_identity": "string",
- "id": "1",
- "invoice_default_to": "string",
- "invoice_email": "string",
- "invoice_extra_information": "string",
- "label": "string",
- "last_name": "string",
- "medicare": "string",
- "medicare_reference_number": "string",
- "merged_at": "2019-08-24T14:15:22Z",
- "notes": "string",
- "occupation": "string",
- "old_reference_id": "string",
- "patient_attachments": {
}, - "patient_phone_numbers": [
- {
- "normalized_number": "39012345678",
- "number": "0-123-456-78",
- "phone_type": "Fax"
}
], - "post_code": "string",
- "preferred_first_name": "string",
- "pronouns": {
- "accusative": "string",
- "nominative": "string",
- "predicative_possessive": "string",
- "pronominal_possessive": "string",
- "reflexive": "string"
}, - "receives_confirmation_emails": true,
- "referral_source": "string",
- "reminder_type": "None",
- "sex": "string",
- "state": "string",
- "time_zone": "Australia/Melbourne",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Resource was updated
Resource could not be saved due to validation errors
{- "accepted_privacy_policy": true,
- "accepted_email_marketing": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "appointment_notes": "string",
- "city": "string",
- "concession_type_id": "1",
- "country": "string",
- "custom_fields": {
- "sections": [
- {
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "archived": true,
- "fields": [
- {
- "archived": true,
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "type": "string",
- "options": [
- {
- "archived": null,
- "name": null,
- "token": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "archived": true,
- "selected": true,
- "value": "string"
}, - "value": "string"
}
]
}
]
}, - "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": "string",
- "medicare_reference_number": "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_confirmation_emails": true,
- "referral_source": "string",
- "reminder_type": "None",
- "sex": "string",
- "state": "string",
- "time_zone": "Australia/Melbourne",
- "title": "string",
- "unsubscribe_sms_marketing": true,
- "referring_doctor_id": "1",
- "patient_phone_numbers": [
- {
- "phone_type": "Fax",
- "number": "0-123-456-78"
}
]
}
{- "accepted_email_marketing": true,
- "accepted_privacy_policy": true,
- "accepted_sms_marketing": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "appointment_notes": "string",
- "archived_at": "2019-08-24T14:15:22Z",
- "city": "string",
- "country": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "sections": [
- {
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "archived": true,
- "fields": [
- {
- "archived": true,
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "type": "string",
- "options": [
- {
- "archived": null,
- "name": null,
- "token": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "archived": true,
- "selected": true,
- "value": "string"
}, - "value": "string"
}
]
}
]
}, - "date_of_birth": "2019-08-24",
- "deleted_at": "2019-08-24T14:15:22Z",
- "dva_card_number": "string",
- "email": "string",
- "emergency_contact": "string",
- "first_name": "string",
- "gender": "string",
- "gender_identity": "string",
- "id": "1",
- "invoice_default_to": "string",
- "invoice_email": "string",
- "invoice_extra_information": "string",
- "label": "string",
- "last_name": "string",
- "medicare": "string",
- "medicare_reference_number": "string",
- "merged_at": "2019-08-24T14:15:22Z",
- "notes": "string",
- "occupation": "string",
- "old_reference_id": "string",
- "patient_attachments": {
}, - "patient_phone_numbers": [
- {
- "normalized_number": "39012345678",
- "number": "0-123-456-78",
- "phone_type": "Fax"
}
], - "post_code": "string",
- "preferred_first_name": "string",
- "pronouns": {
- "accusative": "string",
- "nominative": "string",
- "predicative_possessive": "string",
- "pronominal_possessive": "string",
- "reflexive": "string"
}, - "receives_confirmation_emails": true,
- "referral_source": "string",
- "reminder_type": "None",
- "sex": "string",
- "state": "string",
- "time_zone": "Australia/Melbourne",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "accepted_email_marketing": true,
- "accepted_privacy_policy": true,
- "accepted_sms_marketing": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "appointment_notes": "string",
- "archived_at": "2019-08-24T14:15:22Z",
- "city": "string",
- "country": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "sections": [
- {
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "archived": true,
- "fields": [
- {
- "archived": true,
- "name": "string",
- "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
- "type": "string",
- "options": [
- {
- "archived": null,
- "name": null,
- "token": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "archived": true,
- "selected": true,
- "value": "string"
}, - "value": "string"
}
]
}
]
}, - "date_of_birth": "2019-08-24",
- "deleted_at": "2019-08-24T14:15:22Z",
- "dva_card_number": "string",
- "email": "string",
- "emergency_contact": "string",
- "first_name": "string",
- "gender": "string",
- "gender_identity": "string",
- "id": "1",
- "invoice_default_to": "string",
- "invoice_email": "string",
- "invoice_extra_information": "string",
- "label": "string",
- "last_name": "string",
- "medicare": "string",
- "medicare_reference_number": "string",
- "merged_at": "2019-08-24T14:15:22Z",
- "notes": "string",
- "occupation": "string",
- "old_reference_id": "string",
- "patient_attachments": {
}, - "patient_phone_numbers": [
- {
- "normalized_number": "39012345678",
- "number": "0-123-456-78",
- "phone_type": "Fax"
}
], - "post_code": "string",
- "preferred_first_name": "string",
- "pronouns": {
- "accusative": "string",
- "nominative": "string",
- "predicative_possessive": "string",
- "pronominal_possessive": "string",
- "reflexive": "string"
}, - "receives_confirmation_emails": true,
- "referral_source": "string",
- "reminder_type": "None",
- "sex": "string",
- "state": "string",
- "time_zone": "Australia/Melbourne",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}