Patient Case

PatientCase

archived_at	string or null <date-time>
attendee_ids	Array of strings or null <int64>
	object
	object
closed	boolean or null Deprecated
closed_at	string or null <date-time>
	object
created_at	string <date-time>
expiry_date	string or null <date>
id	string <int64>
include_cancelled_attendees	boolean or null
include_dna_attendees	boolean or null
	object
issue_date	string or null <date>
	object
max_invoiceable_amount	string or null <decimal> > 0
max_sessions	integer or null [ 1 .. 200 ]
name	string
notes	string or null
	object
	object
referral	boolean or null
referral_type	string or null Enum: "dva" "medicare"
updated_at	string <date-time>

{"archived_at": "2019-08-24T14:15:22Z",
"attendee_ids": ["string"
],
"attendees": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees"
}
},
"bookings": {"links": {"self": "https://api.au1.cliniko.com/v1/bookings?q%5B%5D=patient_case_id%3A%3D1"
}
},
"closed": true,
"closed_at": "2019-08-24T14:15:22Z",
"contact": {"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24",
"id": "string",
"include_cancelled_attendees": true,
"include_dna_attendees": true,
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices?q%5B%5D=patient_case_id%3A%3D1"
}
},
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1"
},
"max_invoiceable_amount": "string",
"max_sessions": 1,
"name": "string",
"notes": "string",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_attachments": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments?q%5B%5D=patient_case_id%3A%3D1"
}
},
"referral": true,
"referral_type": "dva",
"updated_at": "2019-08-24T14:15:22Z"
}

List patient cases

get/patient_cases

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
closed_at	date-time
created_at	date-time
expiry_date	date
id	int64
issue_date	date
name	string
patient_id	int64
referral_type	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

curl
JavaScript
Python
Ruby

Response samples

application/json

{"patient_cases": [{"archived_at": "2019-08-24T14:15:22Z",
"attendee_ids": ["string"
],
"attendees": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees"
}
},
"bookings": {"links": {"self": "https://api.au1.cliniko.com/v1/bookings?q%5B%5D=patient_case_id%3A%3D1"
}
},
"closed": true,
"closed_at": "2019-08-24T14:15:22Z",
"contact": {"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24",
"id": "string",
"include_cancelled_attendees": true,
"include_dna_attendees": true,
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices?q%5B%5D=patient_case_id%3A%3D1"
}
},
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1"
},
"max_invoiceable_amount": "string",
"max_sessions": 1,
"name": "string",
"notes": "string",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_attachments": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments?q%5B%5D=patient_case_id%3A%3D1"
}
},
"referral": true,
"referral_type": "dva",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases?page=2",
"previous": "https://api.au1.cliniko.com/v1/patient_cases?page=1",
"next": "https://api.au1.cliniko.com/v1/patient_cases?page=3"
}
}

Create patient case

post/patient_cases

SecuritybasicAuth

Request

Request Body schema: application/json

attendee_ids	Array of strings or null <int64>
closed	boolean or null
contact_id	string <int64> contact id
expiry_date	string or null <date>
include_cancelled_attendees	boolean or null
include_dna_attendees	boolean or null
issue_date	string or null <date>
max_invoiceable_amount	string or null <decimal> > 0
max_sessions	integer or null [ 1 .. 200 ]
name	string
notes	string or null
patient_attachment_ids	Array of strings <int64> Patient attachment ids
patient_id	string <int64> patient id
referral	boolean or null
referral_type	string or null Enum: "dva" "medicare"

Responses

201

Resource was created

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"closed": true,
"contact_id": "1",
"expiry_date": "2019-08-24",
"include_cancelled_attendees": true,
"include_dna_attendees": true,
"issue_date": "2019-08-24",
"name": "string",
"notes": "string",
"max_invoiceable_amount": "string",
"max_sessions": 1,
"patient_id": "1",
"referral": true,
"referral_type": "dva",
"attendee_ids": [1
],
"patient_attachment_ids": ["1"
]
}

Response samples

application/json

{"archived_at": "2019-08-24T14:15:22Z",
"attendee_ids": ["string"
],
"attendees": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees"
}
},
"bookings": {"links": {"self": "https://api.au1.cliniko.com/v1/bookings?q%5B%5D=patient_case_id%3A%3D1"
}
},
"closed": true,
"closed_at": "2019-08-24T14:15:22Z",
"contact": {"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24",
"id": "string",
"include_cancelled_attendees": true,
"include_dna_attendees": true,
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices?q%5B%5D=patient_case_id%3A%3D1"
}
},
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1"
},
"max_invoiceable_amount": "string",
"max_sessions": 1,
"name": "string",
"notes": "string",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_attachments": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments?q%5B%5D=patient_case_id%3A%3D1"
}
},
"referral": true,
"referral_type": "dva",
"updated_at": "2019-08-24T14:15:22Z"
}

List active patient cases

get/patient_cases/active

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
closed_at	date-time
created_at	date-time
expiry_date	date
id	int64
issue_date	date
name	string
patient_id	int64
referral_type	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

curl
JavaScript
Python
Ruby

Response samples

application/json

{"patient_cases": [{"archived_at": "2019-08-24T14:15:22Z",
"attendee_ids": ["string"
],
"attendees": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees"
}
},
"bookings": {"links": {"self": "https://api.au1.cliniko.com/v1/bookings?q%5B%5D=patient_case_id%3A%3D1"
}
},
"closed": true,
"closed_at": "2019-08-24T14:15:22Z",
"contact": {"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24",
"id": "string",
"include_cancelled_attendees": true,
"include_dna_attendees": true,
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices?q%5B%5D=patient_case_id%3A%3D1"
}
},
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1"
},
"max_invoiceable_amount": "string",
"max_sessions": 1,
"name": "string",
"notes": "string",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_attachments": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments?q%5B%5D=patient_case_id%3A%3D1"
}
},
"referral": true,
"referral_type": "dva",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/active?page=2",
"previous": "https://api.au1.cliniko.com/v1/patient_cases/active?page=1",
"next": "https://api.au1.cliniko.com/v1/patient_cases/active?page=3"
}
}

Get patient case

get/patient_cases/{id}

SecuritybasicAuth

Request

path Parameters

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

curl
JavaScript
Python
Ruby

Response samples

application/json

{"archived_at": "2019-08-24T14:15:22Z",
"attendee_ids": ["string"
],
"attendees": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees"
}
},
"bookings": {"links": {"self": "https://api.au1.cliniko.com/v1/bookings?q%5B%5D=patient_case_id%3A%3D1"
}
},
"closed": true,
"closed_at": "2019-08-24T14:15:22Z",
"contact": {"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24",
"id": "string",
"include_cancelled_attendees": true,
"include_dna_attendees": true,
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices?q%5B%5D=patient_case_id%3A%3D1"
}
},
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1"
},
"max_invoiceable_amount": "string",
"max_sessions": 1,
"name": "string",
"notes": "string",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_attachments": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments?q%5B%5D=patient_case_id%3A%3D1"
}
},
"referral": true,
"referral_type": "dva",
"updated_at": "2019-08-24T14:15:22Z"
}

Update patient case

patch/patient_cases/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Request Body schema: application/json

attendee_ids	Array of strings or null <int64>
closed	boolean or null
contact_id	string <int64> contact id
expiry_date	string or null <date>
include_cancelled_attendees	boolean or null
include_dna_attendees	boolean or null
issue_date	string or null <date>
max_invoiceable_amount	string or null <decimal> > 0
max_sessions	integer or null [ 1 .. 200 ]
name	string
notes	string or null
patient_attachment_ids	Array of strings <int64> Patient attachment ids
patient_id	string <int64> patient id
referral	boolean or null
referral_type	string or null Enum: "dva" "medicare"

Responses

200

Resource was updated

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"closed": true,
"contact_id": "1",
"expiry_date": "2019-08-24",
"include_cancelled_attendees": true,
"include_dna_attendees": true,
"issue_date": "2019-08-24",
"name": "string",
"notes": "string",
"max_invoiceable_amount": "string",
"max_sessions": 1,
"patient_id": "1",
"referral": true,
"referral_type": "dva",
"attendee_ids": [1
],
"patient_attachment_ids": ["1"
]
}

Response samples

application/json

{"archived_at": "2019-08-24T14:15:22Z",
"attendee_ids": ["string"
],
"attendees": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees"
}
},
"bookings": {"links": {"self": "https://api.au1.cliniko.com/v1/bookings?q%5B%5D=patient_case_id%3A%3D1"
}
},
"closed": true,
"closed_at": "2019-08-24T14:15:22Z",
"contact": {"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24",
"id": "string",
"include_cancelled_attendees": true,
"include_dna_attendees": true,
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices?q%5B%5D=patient_case_id%3A%3D1"
}
},
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1"
},
"max_invoiceable_amount": "string",
"max_sessions": 1,
"name": "string",
"notes": "string",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_attachments": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments?q%5B%5D=patient_case_id%3A%3D1"
}
},
"referral": true,
"referral_type": "dva",
"updated_at": "2019-08-24T14:15:22Z"
}

Archive patient case

post/patient_cases/{id}/archive

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived

Request samples

curl
JavaScript
Python
Ruby