v1

latestOpenAPI 3.0.12026-07-261252271.9 KB
Appointments and Slots

Retrieve All Appointments for a Practice/Firm

get/fhir/v2/Appointment

Query parameters

_countstring

Number of records to use as the page size for paginated search. The maximum page size for this Resource is 50

_lastUpdatedstring date

This is an Optional Date in the format _lastUpdated=gtDATE, _lastUpdated=eqDATE and _lastUpdated=leDATE in the format yyyy-mm-dd

appointment-typestring

The style of appointment or patient that has been booked in the slot (not service type)

createdstring date

Created date in format of yyyy-MM-dd'T'HH:mm:ss.SSSSSSSZ

datestring date

Appointment date/time.

locationstring

This location is listed in the participants of the appointment

pagestring

Page to be used for paginated search

patientstring

One of the individuals of the appointment is this patient

practitionerstring

One of the individuals of the appointment is this practitioner

statusstring

The overall status of the appointment

supporting-infostring

Additional information to support the appointment

Headers

Content-flag'Referral'

Optional header. Referral adds Referral Contact and Referral Source information to the Appointment payload.

Response

Success