Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
case

Get a single case

Get case data by id

get/cases/{id}

Path parameters

idinteger required
Example:1

Response

Object with case data.

idinteger required

Case id

caseNumberstring

Case number

budgetnumber nullable

Budget

appointmentCountnumber nullable

Appointment count

contactIdinteger nullable required

Contact Id

providerNumberstring nullable

Provider number

referralPeriodstring nullable

Referral Period

notesstring nullable

Notes

trackType'Appointments' | 'Hours' | 'Budget'

Track type

hoursnumber nullable required

hours

includeDidNotArriveboolean nullable

Did not arrive

includeCancelledboolean nullable

Include cancelled

practitionerIdinteger nullable required

Practitioner id

organisationIdinteger required

Organisation id

patientIdinteger required

Patient id

isOpenboolean nullable

Is open

hasAlertboolean nullable

Has alert

remindTimestring nullable

Remind time

utilisationAlertnumber nullable

Utilisation alert

isAlertUtilizationSentboolean nullable

Is alert utilization sent

Example response

{
  "id": 1,
  "caseNumber": "0002",
  "budget": 200,
  "appointmentCount": 12,
  "contactId": 1,
  "providerNumber": "1512",
  "referralPeriod": "Standard",
  "notes": "Notes",
  "trackType": "Budget",
  "hours": 32,
  "includeDidNotArrive": true,
  "includeCancelled": true,
  "practitionerId": 1,
  "items": [
    {
      "typeId": 1,
      "type": "Appointment"
    }
  ],
  "organisationId": 1,
  "patientId": 2,
  "isOpen": true,
  "hasAlert": true,
  "remindTime": "Time",
  "utilisationAlert": 1,
  "isAlertUtilizationSent": true
}