Patient Case

Create patient case

Changed on
post/patient_cases

Request

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

Request body

closedboolean nullable
contact_idstring int64

contact id

expiry_datestring date nullable
include_cancelled_attendeesboolean nullable
include_dna_attendeesboolean nullable
issue_datestring date nullable
namestring
notesstring nullable
max_invoiceable_amountstring decimal nullable
max_sessionsinteger nullable
patient_idstring int64

patient id

referralboolean nullable
referral_type'dva' | 'medicare' nullable
attendee_idsstring[] nullable
patient_attachment_idsstring[]

Patient attachment ids

Example request

{
  "contact_id": "1",
  "patient_id": "1",
  "patient_attachment_ids": [
    "1"
  ]
}

Response

Resource was created

archived_atstring date-time nullable
attendee_idsstring[] nullable
closedboolean nullable
closed_atstring date-time nullable
created_atstring date-time
expiry_datestring date nullable
idstring int64
include_cancelled_attendeesboolean nullable
include_dna_attendeesboolean nullable
issue_datestring date nullable
max_invoiceable_amountstring decimal nullable
max_sessionsinteger nullable
namestring
notesstring nullable
referralboolean nullable
referral_type'dva' | 'medicare' nullable
updated_atstring date-time

Example response

{
  "attendees": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees"
    }
  },
  "bookings": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_cases/1/bookings"
    }
  },
  "contact": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/contacts/1"
    }
  },
  "invoices": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_cases/1/invoices"
    }
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/patient_cases/1"
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  },
  "patient_attachments": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_cases/1/patient_attachments"
    }
  }
}

Changes

  • 17c94435647aRevision changes
    • breaking

      the response property's max was increased from 200.00 to 300.00 for the response status

    • info

      the request property's max was increased from 200.00 to 300.00