Patient Attachment

Create uploaded patient attachment

Changed on

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.

post/patient_attachments

Request

  • Base URL
    https://api.au1.cliniko.com/v1
  • URL
    https://api.au1.cliniko.com/v1/patient_attachments
  • Auth
    HTTP basic

Request body

patient_idstring int64

patient id

descriptionstring nullable
upload_urlstring uri

Must be a presigned URL returned by the presigned URL upload process

filenamestring nullable

Example request

{
  "patient_id": "1",
  "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

Resource was created

archived_atstring date-time nullable
category'audio' | 'data' | 'document' | 'image' | 'other' | 'video' nullable
content_typestring nullable
created_atstring date-time
descriptionstring nullable
filenamestring nullable
idstring int64
pinned_atstring date-time nullable
processed_atstring date-time nullable
processing_completedboolean nullable
sizestring int64 nullable
updated_atstring date-time

Example response

{
  "content": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_attachments/1"
    }
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/patient_attachments/1"
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  },
  "user": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/users/1"
    }
  }
}

Changes

  • 9c509c169ad8Revision changes
    • warning

      added the new document enum value to the response property for the response status

    • warning

      added the new image enum value to the response property for the response status

    • warning

      added the new video enum value to the response property for the response status

    • info

      removed the documents enum value from the response property for the response status

    • info

      removed the images enum value from the response property for the response status

    • info

      removed the videos enum value from the response property for the response status

  • 79f172e1968dRevision changes
    • info

      added the optional property to the response with the status