Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required
Required range: x > 0

Response

200 - application/json
id
integer
required

Case id

Required range: x > 0
contactId
integer | null
required

Contact Id

Required range: x > 0
issueDate
required

Issued date in YYYY-MM-DD HH:MM:SS format

expiryDate
required

Expiry date in YYYY-MM-DD HH:MM:SS format

hours
number | null
required

hours

practitionerId
integer | null
required

Practitioner id

Required range: x > 0
items
object[]
required

An array of appointment connections associated with this case

organisationId
integer
required

Organisation id

Required range: x > 0
patientId
integer
required

Patient id

Required range: x > 0
createdAt
required

Object creation date time

updatedAt
required

Object update date time

caseNumber
string

Case number

budget
number | null

Budget

appointmentCount
number | null

Appointment count

providerNumber
string | null

Provider number

referralPeriod
string | null

Referral Period

notes
string | null

Notes

trackType
enum<string>

Track type

Available options:
Appointments,
Hours,
Budget
includeDidNotArrive
boolean | null

Did not arrive

includeCancelled
boolean | null

Include cancelled

isOpen
boolean | null

Is open

hasAlert
boolean | null

Has alert

remindTime
string | null

Remind time

utilisationAlert
number | null

Utilisation alert

isAlertUtilizationSent
boolean | null

Is alert utilization sent