Calendar Management (3.0.0)

Appointment

Access and manage appointments

Retrieve Appointments

Retrieve a list of appointment objects

query Parameters

required	object (Pageable) Pageable parameters
location-uuid	string <uuid> Example: location-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
contact-practitioner-uuid	string <uuid> Example: contact-practitioner-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
assigned-practitioner-uuid	string <uuid> Example: assigned-practitioner-uuid=6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3
patient-uuid	string <uuid> Example: patient-uuid=E0CCC3B8-75D3-491B-BEB9-97DD982941A7
account-uuid	string <uuid> Example: account-uuid=086898ea-04b0-11ec-9a03-0242ac130003
appointment-date	string <date> Example: appointment-date=2019-09-07
modified-start	string <date-time> Example: modified-start=2021-06-01T00:00:00.00Z
modified-end	string <date-time> Example: modified-end=2021-07-01T00:00:00.00Z

Responses

Response Schema: application/json

Array of objects (Appointment)

Array

appointment-uuid	string <uuid>
account-uuid	string <uuid>
account-contact-uuid	string <uuid>
patient-uuid	string <uuid>
start-date	string <date-time>
end-date	string <date-time>
reason-uuid	string <uuid>
reason-text	string
note	string
initials	string
booked-by	string
booked-date	string <date-time>
location-uuid	string <uuid>
contact-practitioner-uuid	string <uuid>
assigned-practitioner-uuid	string <uuid>
modified	string <date-time>
online-booking	boolean
address-denormalised	string

Response samples

200
400
500

Content type

application/json

{"results": [{"appointment-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"account-uuid": "eb375715-c776-4d49-a9c0-6ceef457f1f6",
"account-contact-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"patient-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
"start-date": "2020-07-07T15:50:00.00Z",
"end-date": "2019-08-07T15:50:00.00Z",
"reason-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
"reason-text": "Booster",
"note": "Good Friday",
"initials": "TJ",
"booked-by": "Tom",
"booked-date": "2024-02-27T10:28:59Z",
"location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"contact-practitioner-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"assigned-practitioner-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
"modified": "2019-09-07T15:50:00.00Z",
"online-booking": true,
"address-denormalised": "Bocketts Farm"
}
]
}

Create an appointment

Request Body schema: application/json
required

account-uuid required	string <uuid>
account-contact-uuid required	string <uuid>
patient-uuid required	string <uuid>
start-date required	string <date-time>
end-date required	string <date-time>
reason-uuid	string <uuid>
reason-text	string <= 255 characters
note	string <= 250 characters
initials	string <= 50 characters
location-uuid required	string <uuid>
contact-practitioner-uuid required	string <uuid>
assigned-practitioner-uuid	string <uuid>
online-booking	boolean
address-denormalised	string <= 900 characters
booked-by	string <= 100 characters

Responses

Response Schema: application/json

appointment-uuid

string <uuid>

Request samples

Content type

application/json

{"account-uuid": "C6683774-5DB8-4CC6-876C-7548D9AA2498",
"account-contact-uuid": "FE3845C2-8D72-457A-971D-115AFE69A603",
"patient-uuid": "1B23878A-272A-49B3-AEFC-65CFBE416F3C",
"start-date": "2022-02-10T09:15:00.00Z",
"end-date": "2022-02-10T09:30:00.00Z",
"reason-uuid": "5CFAA893-95CA-4950-A929-0C1D29276057",
"reason-text": "Booster",
"note": "Good Friday",
"initials": "TJ",
"location-uuid": "2A1820D9-9C94-42AA-BC0E-603E6B7D28AF",
"contact-practitioner-uuid": "F7E706DF-DD8A-4824-A9C4-5E158CC01920",
"assigned-practitioner-uuid": "48AC0E06-B6B3-4509-AA53-6463718BB785",
"online-booking": true,
"address-denormalised": "Bocketts Farm",
"booked-by": "John Wick"
}

Response samples

201
400
422
500

Content type

application/json

{"appointment-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E"
}

Retrieve Deleted Appointments

Retrieve a list of deleted appointment objects

query Parameters

required	object (Pageable) Pageable parameters
location-uuid	string <uuid> Example: location-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
contact-practitioner-uuid	string <uuid> Example: contact-practitioner-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
assigned-practitioner-uuid	string <uuid> Example: assigned-practitioner-uuid=6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3
patient-uuid	string <uuid> Example: patient-uuid=E0CCC3B8-75D3-491B-BEB9-97DD982941A7
account-uuid	string <uuid> Example: account-uuid=086898ea-04b0-11ec-9a03-0242ac130003
appointment-date	string <date> Example: appointment-date=2019-09-07
deleted-start	string <date-time> Example: deleted-start=2021-06-01T00:00:00.00Z
deleted-end	string <date-time> Example: deleted-end=2021-07-01T00:00:00.00Z
include-last-status	boolean Default: false

Responses

Response Schema: application/json

Array of objects (DeletedAppointment)

Array

appointment-uuid	string <uuid>
account-uuid	string <uuid>
account-contact-uuid	string <uuid>
patient-uuid	string <uuid>
start-date	string <date-time>
end-date	string <date-time>
reason-uuid	string <uuid>
reason-text	string
note	string
initials	string
booked-by	string
booked-date	string <date-time>
location-uuid	string <uuid>
contact-practitioner-uuid	string <uuid>
assigned-practitioner-uuid	string <uuid>
modified	string <date-time>
online-booking	boolean
address-denormalised	string
	Array of objects (LastAppointmentStatus)

Response samples

200
400
500

Content type

application/json

{"results": [{"appointment-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"account-uuid": "eb375715-c776-4d49-a9c0-6ceef457f1f6",
"account-contact-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"patient-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
"start-date": "2020-07-07T15:50:00.00Z",
"end-date": "2019-08-07T15:50:00.00Z",
"reason-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
"reason-text": "Booster",
"note": "Good Friday",
"initials": "TJ",
"booked-by": "Tom",
"booked-date": "2024-02-27T10:28:59Z",
"location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"contact-practitioner-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"assigned-practitioner-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
"modified": "2019-09-07T15:50:00.00Z",
"online-booking": true,
"address-denormalised": "Bocketts Farm",
"last-appointment-statuses": [{"appointment-status-type-uuid": "358A8DDC-5B76-11EE-B8B1-465D73579FA4",
"description": "Arrived"
}
]
}
]
}

Retrieve appointment

Retrieve an appointment object from its id

path Parameters

appointment-uuid

required

string <uuid>

Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json

appointment-uuid	string <uuid>
account-uuid	string <uuid>
account-contact-uuid	string <uuid>
patient-uuid	string <uuid>
start-date	string <date-time>
end-date	string <date-time>
reason-uuid	string <uuid>
reason-text	string
note	string
initials	string
booked-by	string
booked-date	string <date-time>
location-uuid	string <uuid>
contact-practitioner-uuid	string <uuid>
assigned-practitioner-uuid	string <uuid>
modified	string <date-time>
online-booking	boolean
address-denormalised	string

Response samples

200
400
404
500

Content type

application/json

{"appointment-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"account-uuid": "eb375715-c776-4d49-a9c0-6ceef457f1f6",
"account-contact-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"patient-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
"start-date": "2020-07-07T15:50:00.00Z",
"end-date": "2019-08-07T15:50:00.00Z",
"reason-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
"reason-text": "Booster",
"note": "Good Friday",
"initials": "TJ",
"booked-by": "Tom",
"booked-date": "2024-02-27T10:28:59Z",
"location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"contact-practitioner-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"assigned-practitioner-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
"modified": "2019-09-07T15:50:00.00Z",
"online-booking": true,
"address-denormalised": "Bocketts Farm"
}

Delete appointment

Delete an appointment

path Parameters

appointment-uuid

required

string <uuid>

Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json

appointment-uuid

string <uuid>

Response samples

200
400
404
500

Content type

application/json

{"appointment-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632"
}

Update appointment

Update an existing appointment for specific fields

path Parameters

appointment-uuid

required

string <uuid>

Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Request Body schema: application/json
required

address-denormalised required	string or null <= 900 characters
initials required	string or null <= 50 characters
note required	string or null <= 250 characters
reason-text required	string or null <= 255 characters

Responses

Response Schema: application/json

appointment-uuid

string <uuid>

Request samples

Content type

application/json

{"address-denormalised": "Bocketts Farm",
"initials": "TJ",
"note": "Good Friday",
"reason-text": "Booster"
}

Response samples

200
400
500

Content type

application/json

{"appointment-uuid": "AFF41A2C-1254-4DDF-A31B-2F3B921365D6"
}

Reason

Access and manage appointment reasons categories

Retrieve Reasons

Retrieve a list of reasons

query Parameters

required	object (Pageable) Pageable parameters
location-uuid	string <uuid> Example: location-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
reason-type	string Enum: "Appointment" "Hospital" "Declined Reasons" Example: reason-type=Appointment
active	boolean Example: active=true
search-name	string Filter where the appointment reason name starts with this search term

Responses

Response Schema: application/json

Array of objects (AppointmentReason)

Array

reason-uuid	string <uuid>
location-uuid	string <uuid>
reason-type	string Enum: "Appointment" "Hospital" "Declined Reasons"
name	string
description	string
duration-minutes	number
view-order	integer <int32>
active	boolean
return-duration	integer <int32>
return-type	string Enum: "DAY" "WEEK" "MONTH"
return-active	boolean

Response samples

200
400
500

Content type

application/json

{"results": [{"reason-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"reason-type": "Appointment",
"name": "Consultation",
"description": "Consultation",
"duration-minutes": 30,
"view-order": 1,
"active": false,
"return-duration": 10,
"return-type": "DAY",
"return-active": true
}
]
}

Retrieve a reason

Retrieve a reason from its id

path Parameters

reason-uuid

required

string <uuid>

Example: 6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3

Responses

Response Schema: application/json

reason-uuid	string <uuid>
location-uuid	string <uuid>
reason-type	string Enum: "Appointment" "Hospital" "Declined Reasons"
name	string
description	string
duration-minutes	number
view-order	integer <int32>
active	boolean
return-duration	integer <int32>
return-type	string Enum: "DAY" "WEEK" "MONTH"
return-active	boolean

Response samples

200
400
404
500

Content type

application/json

{"reason-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"reason-type": "Appointment",
"name": "Consultation",
"description": "Consultation",
"duration-minutes": 30,
"view-order": 1,
"active": false,
"return-duration": 10,
"return-type": "DAY",
"return-active": true
}

Appointment Status

Access and manage appointment status metadata

Retrieve Appointment Statuses

Retrieve a list of appointment statuses for an appointment from its id

path Parameters

appointment-uuid

required

string <uuid>

Example: 6F0E07B2-ED8B-474A-B2E6-45B69407451C

query Parameters

required

object (Pageable)

Pageable parameters

Responses

Response Schema: application/json

Array of objects (Status)

Array

appointment-status-type-uuid	string <uuid>
description	string
display-order	integer
created-on	string <date-time>
created-by	string
updated-on	string <date-time>
updated-by	string

Response samples

200
400
404
500

Content type

application/json

{"results": [{"appointment-status-type-uuid": "CEFE3CC8-7D3F-446F-8D61-8F4BCC61B05C",
"description": "Arrived",
"display-order": 1,
"created-on": "2021-11-04T11:00:00.00Z",
"created-by": "Bonnie",
"updated-on": "2021-11-04T11:10:00.00Z",
"updated-by": "Clyde"
}
]
}

Retrieve Appointment Status Types

Retrieve a list of appointment status type objects

query Parameters

required

object (Pageable)

Pageable parameters

Responses

Response Schema: application/json

Array of objects (AppointmentStatusType)

Array

appointment-status-type-uuid	string <uuid>
description	string
type	string

Response samples

200
400
500

Content type

application/json

{"results": [{"appointment-status-type-uuid": "6C9367CA-021A-499B-87F8-166B3DA830F4",
"description": "Arrived",
"type": "Daylist"
}
]
}

Retrieve Appointment Status Type

Retrieve an appointment status type object from its id

path Parameters

appointment-status-type-uuid

required

string <uuid>

Example: A67F85E9-DF02-44F7-BFE8-832A968B22EA

Responses

Response Schema: application/json

appointment-status-type-uuid	string <uuid>
description	string
type	string

Response samples

200
400
404
500

Content type

application/json

{"appointment-status-type-uuid": "6C9367CA-021A-499B-87F8-166B3DA830F4",
"description": "Arrived",
"type": "Daylist"
}

Availability

Access and manage appointment availability metadata

Create Available Slot

Request Body schema: application/json
required

location-uuid required	string <uuid>
contact-practitioner-uuid required	string <uuid>
start-date required	string <date-time>
end-date required	string <date-time>
duration-minutes required	integer <int32> [ 5 .. 1439 ]
background-colour	string (HexColour) ^#?[0-9a-fA-F]{6}$
foreground-colour	string (HexColour) ^#?[0-9a-fA-F]{6}$
appointment-reminder	boolean
empty-slot-text	string <= 50 characters
unavailability-reason	string <= 255 characters If provided, then unavailability slots will be created for the whole availability duration

Responses

Response Schema: application/json

results

Array of strings <uuid> [ items <uuid > ]

Request samples

Content type

application/json

{"location-uuid": "2A1820D9-9C94-42AA-BC0E-603E6B7D28AF",
"contact-practitioner-uuid": "F7E706DF-DD8A-4824-A9C4-5E158CC01920",
"start-date": "2023-05-10T09:15:00.00Z",
"end-date": "2023-05-10T09:30:00.00Z",
"duration-minutes": 30,
"background-colour": "#00FF00",
"foreground-colour": "#00FF00",
"appointment-reminder": true,
"empty-slot-text": "Consult room 1",
"unavailability-reason": "Gone fishing"
}

Response samples

201
400
409
422
500

Content type

application/json

{"results": ["F63A63CA-BBDC-4E62-A66E-3E428A69548E"
]
}

Delete Available Slots

Request Body schema: application/json
required

location-uuid required	string <uuid>
contact-practitioner-uuid required	string <uuid>
start-date required	string <date-time>
end-date required	string <date-time>
date-rule	string Enum: "inclusive" "overlap"
force-delete	boolean Default: false
delete-unavailability	boolean Default: false

Responses

Response Schema: application/json

results

Array of strings <uuid> [ items <uuid > ]

Request samples

Content type

application/json

{"location-uuid": "2A1820D9-9C94-42AA-BC0E-603E6B7D28AF",
"contact-practitioner-uuid": "F7E706DF-DD8A-4824-A9C4-5E158CC01920",
"start-date": "2023-05-10T09:15:00.00Z",
"end-date": "2023-05-10T09:30:00.00Z",
"date-rule": "inclusive",
"force-delete": true,
"delete-unavailability": true
}

Response samples

200
400
409
422
500

Content type

application/json

{"results": ["F63A63CA-BBDC-4E62-A66E-3E428A69548E"
]
}

Retrieve Available Slots

Retrieve a list of available appointment slots for a given location and date range

path Parameters

location-uuid

required

string <uuid>

Example: ED919742-256A-4331-A1E8-9B7E0389BC8D

query Parameters

date-start required	string <date> Example: date-start=2021-06-01
date-end required	string <date> Example: date-end=2021-06-07
required	object (Pageable) Pageable parameters

Responses

Response Schema: application/json

Array of objects (AvailableSlot)

Array

practitioner-uuid	string <uuid>
start-time	string <date-time>
duration-minutes	integer <int32>

Response samples

200
400
500

Content type

application/json

{"results": [{"practitioner-uuid": "CC9F157E-90FA-41CD-9732-69FA4D5D3117",
"start-time": "2021-06-01T09:00:00Z",
"duration-minutes": 15
}
]
}

Retrieve Unavailable Slots

Retrieve a list of unavailable appointment slots for a given location

path Parameters

location-uuid

required

string <uuid>

Example: ED919742-256A-4331-A1E8-9B7E0389BC8D

query Parameters

contact-practitioner-uuid	string <uuid> Example: contact-practitioner-uuid=ED919742-256A-4331-A1E8-9B7E0389BC8D
start-date	string <date-time> Example: start-date=2021-06-01T00:00:00.00Z
end-date	string <date-time> Example: end-date=2021-06-01T00:00:00.00Z
modified-start	string <date-time> Example: modified-start=2021-06-01T00:00:00.00Z
modified-end	string <date-time> Example: modified-end=2021-06-01T00:00:00.00Z
required	object (Pageable) Pageable parameters

Responses

Response Schema: application/json

Array of objects (UnavailableSlot)

Array

availability-block-uuid	string <uuid>
contact-practitioner-uuid	string <uuid>
start-date	string <date-time>
end-date	string <date-time>
note	string
modified	string <date-time>

Response samples

200
400
500

Content type

application/json

{"results": [{"availability-block-uuid": "CC9F157E-90FA-41CD-9732-69FA4D5D3117",
"contact-practitioner-uuid": "CC9F157E-90FA-41CD-9732-69FA4D5D3117",
"start-date": "2021-06-01T09:00:00Z",
"end-date": "2021-06-01T09:00:00Z",
"note": "Running late, can't get in basket",
"modified": "2021-06-01T09:00:00Z"
}
]
}

Create Unavailable Slots

Request Body schema: application/json
required

location-uuid required	string <uuid>
contact-practitioner-uuid required	string <uuid>
start-date required	string <date-time>
end-date required	string <date-time>
reason	string <= 255 characters

Responses

Response Schema: application/json

results

Array of strings <uuid> [ items <uuid > ]

Request samples

Content type

application/json

{"location-uuid": "2A1820D9-9C94-42AA-BC0E-603E6B7D28AF",
"contact-practitioner-uuid": "F7E706DF-DD8A-4824-A9C4-5E158CC01920",
"start-date": "2023-05-10T09:15:00.00Z",
"end-date": "2023-05-10T09:30:00.00Z",
"reason": "Holiday"
}

Response samples

201
400
422
500

Content type

application/json

{"results": ["2608EC9C-9076-11EF-9892-465D73579FA4"
]
}

Task

Access and manage Tasks

Retrieve Tasks

Retrieve a list of task objects

query Parameters

required	object (Pageable) Pageable parameters
location-uuid	string <uuid> Example: location-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
task-list-uuid	string <uuid> Example: task-list-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
task-start-date	string <date-time> Example: task-start-date=2021-06-01T00:00:00.00Z
task-end-date	string <date-time> Example: task-end-date=2021-07-01T00:00:00.00Z
patient-uuid	string <uuid> Example: patient-uuid=E0CCC3B8-75D3-491B-BEB9-97DD982941A7
assigned-practitioner-uuid	string <uuid> Example: assigned-practitioner-uuid=6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3

Responses

Response Schema: application/json

Array of objects (Task)

Array

task-uuid	string <uuid>
account-uuid	string <uuid>
account-contact-uuid	string <uuid>
patient-uuid	string <uuid>
start-date	string <date-time>
end-date	string <date-time>
reason-uuid	string <uuid>
reason-text	string
note	string
initials	string
booked-by	string
location-uuid	string <uuid>
task-list-uuid	string <uuid>
assigned-practitioner-uuid	string <uuid>
modified	string <date-time>
online-booking	boolean

Response samples

200
400
500

Content type

application/json

{"results": [{"task-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"account-uuid": "eb375715-c776-4d49-a9c0-6ceef457f1f6",
"account-contact-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"patient-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
"start-date": "2020-07-07T15:50:00.00Z",
"end-date": "2019-08-07T15:50:00.00Z",
"reason-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
"reason-text": "Booster",
"note": "Good Friday",
"initials": "TJ",
"booked-by": "Tom",
"location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"task-list-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"assigned-practitioner-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
"modified": "2019-09-07T15:50:00.00Z",
"online-booking": true
}
]
}

Create a task

Request Body schema: application/json
required

account-uuid required	string <uuid>
account-contact-uuid required	string <uuid>
patient-uuid required	string <uuid>
start-date required	string <date-time>
end-date required	string <date-time>
reason-uuid	string <uuid>
reason-text	string <= 255 characters
note	string <= 250 characters
initials	string <= 50 characters
booked-by	string <= 100 characters
location-uuid required	string <uuid>
task-list-uuid required	string <uuid>
assigned-practitioner-uuid	string <uuid>
online-booking	boolean

Responses

Response Schema: application/json

task-uuid

string <uuid>

Request samples

Content type

application/json

{"account-uuid": "C6683774-5DB8-4CC6-876C-7548D9AA2498",
"account-contact-uuid": "FE3845C2-8D72-457A-971D-115AFE69A603",
"patient-uuid": "1B23878A-272A-49B3-AEFC-65CFBE416F3C",
"start-date": "2022-02-10T09:15:00.00Z",
"end-date": "2022-02-10T09:30:00.00Z",
"reason-uuid": "5CFAA893-95CA-4950-A929-0C1D29276057",
"reason-text": "Booster",
"note": "Good Friday",
"initials": "TJ",
"booked-by": "John Wick",
"location-uuid": "2A1820D9-9C94-42AA-BC0E-603E6B7D28AF",
"task-list-uuid": "F7E706DF-DD8A-4824-A9C4-5E158CC01920",
"assigned-practitioner-uuid": "48AC0E06-B6B3-4509-AA53-6463718BB785",
"online-booking": true
}

Response samples

201
400
422
500

Content type

application/json

{"task-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E"
}

Delete task

Delete a task

path Parameters

task-uuid

required

string <uuid>

Example: 670D405A-8A09-413B-922F-64AA6A9A9904

Responses

Response Schema: application/json

task-uuid

string <uuid>

Response samples

200
400
404
500

Content type

application/json

{"task-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632"
}

Waiting Times

Access and manage appointment waiting times metadata

Retrieve Waiting Times

Retrieve a list of waiting times

query Parameters

required

object (Pageable)

Pageable parameters

Responses

Response Schema: application/json

Array of objects (WaitingTime)

Array

location-uuid	string <uuid>
max-time-minutes	integer <int32>
min-time-minutes	integer <int32>
count-appointments	integer <int32>
avg-time-minutes	integer <int32>

Response samples

200
400
500

Content type

application/json

{"results": [{"location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"max-time-minutes": 1,
"min-time-minutes": 1,
"count-appointments": 1,
"avg-time-minutes": 1
}
]
}

Retrieve a waiting time

Retrieve a waiting time for location

path Parameters

location-uuid

required

string <uuid>

Example: 6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3

Responses

Response Schema: application/json

location-uuid	string <uuid>
max-time-minutes	integer <int32>
min-time-minutes	integer <int32>
count-appointments	integer <int32>
avg-time-minutes	integer <int32>

Response samples

200
400
404
500

Content type

application/json

{"location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"max-time-minutes": 1,
"min-time-minutes": 1,
"count-appointments": 1,
"avg-time-minutes": 1
}

Task List

Access and manage task lists

Retrieve Task List Types

Retrieve task list types (only non practitioner types)

query Parameters

required

object (Pageable)

Pageable parameters

Responses

Response Schema: application/json

Array of objects (TaskListType)

Array

task-list-type-id	integer <int32>
name	string
description	string
view-order	integer <int32>

Response samples

200
400
500

Content type

application/json

{"results": [{"task-list-type-id": 546345,
"name": "Operations",
"description": "Operations",
"view-order": 2
}
]
}

Retrieve the task lists

Retrieve the task lists, aka Special Surgeons / Day lists

query Parameters

required	object (Pageable) Pageable parameters
active	boolean
task-list-type-id	integer Example: task-list-type-id=1237 Include only task lists of the specified type
location-uuid	string <uuid> Example: location-uuid=E4F8C8C3-2189-4059-9C06-6DF32A38DA15 Include only task lists attached to the specified location

Responses

Response Schema: application/json

Array of objects (TaskList)

Array

task-list-uuid	string <uuid>
deactivated	boolean
first-name	string
last-name	string
task-list-type-id	integer <int32>

Response samples

200
400
500

Content type

application/json

{"results": [{"task-list-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"deactivated": false,
"first-name": "Lois",
"last-name": "Lane",
"task-list-type-id": 546345
}
]
}

Retrieve Task List

Retrieve a single task list record

path Parameters

task-list-uuid

required

string <uuid>

Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

Response Schema: application/json

task-list-uuid	string <uuid>
deactivated	boolean
first-name	string
last-name	string
task-list-type-id	integer <int32>

Response samples

200
400
404
500

Content type

application/json

{"task-list-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"deactivated": false,
"first-name": "Lois",
"last-name": "Lane",
"task-list-type-id": 546345
}

Retrieve Task Lists Locations

Retrieve a list of task lists and the locations associated

query Parameters

required	object (Pageable) Pageable parameters
task-list-uuid	string <uuid> Example: task-list-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
location-uuid	string <uuid> Example: location-uuid=6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3
display-diary	boolean Example: display-diary=true
display-treatment	boolean Example: display-treatment=true

Responses

Response Schema: application/json

Array of objects (TaskListLocation)

Array

task-list-uuid	string <uuid>
location-uuid	string <uuid>
view-order	integer <int32>
display-diary	boolean
display-treatment	boolean

Response samples

200
400
500

Content type

application/json

{"results": [{"task-list-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
"location-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
"view-order": 2,
"display-diary": true,
"display-treatment": true
}
]
}

Appointment Identifiers

Access appointment identifiers

Retrieve appointment identifiers

Retrieve a list of appointment identifiers

query Parameters

required	object (Pageable) Pageable parameters
appointment-uuid	string <uuid> Example: appointment-uuid=EB74C7A1-AEA0-4053-A48E-76FF9FD13797
appointment-id	integer <int32> Example: appointment-id=82457

Responses

Response Schema: application/json

Array of objects (AppointmentIdentifiers)

Array

appointment-uuid	string <uuid>
appointment-id	integer <int32>

Response samples

200
400
500

Content type

application/json

{"results": [{"appointment-uuid": "AFF41A2C-1254-4DDF-A31B-2F3B921365D6",
"appointment-id": 52873
}
]
}

Calendar Management (3.0.0)

Appointment

Retrieve Appointments

query Parameters

Responses

Response Schema: application/json

Response samples

Create an appointment

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Retrieve Deleted Appointments

query Parameters

Responses

Response Schema: application/json

Response samples

Retrieve appointment

path Parameters

Responses

Response Schema: application/json

Response samples

Delete appointment

path Parameters

Responses

Response Schema: application/json

Response samples

Update appointment

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Reason

Retrieve Reasons

query Parameters

Responses

Response Schema: application/json

Response samples

Retrieve a reason

path Parameters

Responses

Response Schema: application/json

Response samples

Appointment Status

Retrieve Appointment Statuses

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Retrieve Appointment Status Types

query Parameters

Responses

Response Schema: application/json

Response samples

Retrieve Appointment Status Type

path Parameters

Responses

Response Schema: application/json

Response samples

Availability

Create Available Slot

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Delete Available Slots

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Retrieve Available Slots

path Parameters

query Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required