Patient Attachment

AttachmentPresignedPost

	object or null
url	string or null <uri>

{"fields": {"key": "string",
"policy": "string",
"x-amz-credential": "string",
"x-amz-signature": "string",
"x-amz-algorithm": "string",
"success_action_status": "201",
"acl": "private"
},
"url": "http://example.com"
}

PatientAttachment

Any of:

	object or null
content_type	string or null mime type
created_at	string <date-time>
description	string or null <= 255 characters
filename	string or null
id	string <int64>
	object
	object
pinned_at	string or null <date-time>
processed_at	string or null <date-time>
processing_completed	boolean or null
size	integer or null
updated_at	string <date-time>
	object

{"content": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1/content"
}
},
"content_type": "text/plain",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"filename": "string",
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"pinned_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"processing_completed": true,
"size": 0,
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}

List patient attachments

get/patient_attachments

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
id	int64
archived_at	date-time
created_at	date-time
updated_at	date-time
content_type	string
description	string
filename	string
patient_id	int64
processed_at	date-time
size	integer
user_id	int64

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_attachments": [{"content": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1/content"
}
},
"content_type": "text/plain",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"filename": "string",
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"pinned_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"processing_completed": true,
"size": 0,
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments?page=2",
"previous": "https://api.au1.cliniko.com/v1/patient_attachments?page=1",
"next": "https://api.au1.cliniko.com/v1/patient_attachments?page=3"
}
}

Create uploaded patient attachment

post/patient_attachments

To create a patient attachment, you must first generate a presigned URL, upload your file to that URL, and then supply that URL and response key in the upload_url request body parameter.

Uploading patient attachments

SecuritybasicAuth

Request

Request Body schema: application/json

description	string or null <= 255 characters
patient_id	string <int64> patient id
upload_url	string <uri> Must be a presigned URL returned by the presigned URL upload process

Responses

201

Resource was created

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"patient_id": "1",
"description": "string",
"upload_url": "https://cliniko-files-example-bucket.s3.amazonaws.com/123/patients/456/attachments/temp/s0m3-w31rd-l0c4t10n-1na-t3mpd1r/the-name-of-the-file.txt"
}

Response samples

application/json

{"archived_at": "2019-08-24T14:15:22Z",
"content": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1"
}
},
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"filename": "string",
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"pinned_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"processing_completed": true,
"size": 0,
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}

Get patient attachment

get/patient_attachments/{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

{"content": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1/content"
}
},
"content_type": "text/plain",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"filename": "string",
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"pinned_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"processing_completed": true,
"size": 0,
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}

Archive patient attachmentDeprecated

delete/patient_attachments/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived successfully

Request samples

curl
JavaScript
Python
Ruby

Archive patient attachment

post/patient_attachments/{id}/archive

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived

Request samples

curl
JavaScript
Python
Ruby

List patient attachments for patient case

get/patient_cases/{patient_case_id}/patient_attachments

SecuritybasicAuth

Request

path Parameters

patient_case_id

required

string <int64>

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
id	int64
archived_at	date-time
created_at	date-time
updated_at	date-time
content_type	string
description	string
filename	string
patient_id	int64
processed_at	date-time
size	integer
user_id	int64

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_attachments": [{"content": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1/content"
}
},
"content_type": "text/plain",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"filename": "string",
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"pinned_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"processing_completed": true,
"size": 0,
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1/patient_attachments?page=2",
"previous": "https://api.au1.cliniko.com/v1/patient_cases/1/patient_attachments?page=1",
"next": "https://api.au1.cliniko.com/v1/patient_cases/1/patient_attachments?page=3"
}
}

Get a presigned URL to upload your file to S3

get/patients/{patient_id}/attachment_presigned_post

Uploading patient attachments

SecuritybasicAuth

Request

path Parameters

patient_id

required

string <int64>

Example: 1

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"fields": {"key": "string",
"policy": "string",
"x-amz-credential": "string",
"x-amz-signature": "string",
"x-amz-algorithm": "string",
"success_action_status": "201",
"acl": "private"
},
"url": "http://example.com"
}

List patient attachments for patient

get/patients/{patient_id}/patient_attachments

SecuritybasicAuth

Request

path Parameters

patient_id

required

string <int64>

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
id	int64
archived_at	date-time
created_at	date-time
updated_at	date-time
content_type	string
description	string
filename	string
processed_at	date-time
size	integer
user_id	int64

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_attachments": [{"content": {"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1/content"
}
},
"content_type": "text/plain",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"filename": "string",
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_attachments/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"pinned_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"processing_completed": true,
"size": 0,
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/patients/1/patient_attachments?page=2",
"previous": "https://api.au1.cliniko.com/v1/patients/1/patient_attachments?page=1",
"next": "https://api.au1.cliniko.com/v1/patients/1/patient_attachments?page=3"
}
}