GetProposedAppointments

Gets proposed appointments according given filters.

JavaScript library method 

patientportal.appointment.getProposedAppointments({
    appointmentType: <appointment-type>,
    clinician: <clinician>,
    clinicianSex: <clinician-sex>,
    site: <site>,
    location: <location>,
    fromDate: <from-date>,
    toDate: <to-date>,
    timePreference: <time-preference>,
    timeFrom: <time-from>,
    timeTo: <time-to>,
    modules: <modules>,
    payerType: <payer-type>,
    numberOfResults: <number-of-results>
});

HTTP Method

Verb URL
POST /patientportalapi/appointment/proposed

URL Parameters

appointment-type

string

Type of the appointment provided by the API upon GetAppointmentTypes.

clinician

int (optional)

Clinician filter. Identifier provide by the API upon GetClinicians. Allow 0 for any clinician.

clinician-sex

int (optional)

Clinician’s gender filter:

  • 0 = any sex
  • 1 = male
  • 2 = female

site

int (optional)

Site filter. Identifier provide by the API upon GetSites. Allow 0 for any site.

location

int (optional)

Location filter. Identifier provide by the API upon GetSites. Allow 0 for any location.

from-date

LocalDateTime (optional)

Filters appointments on or after provided date/time (inclusive).

The parameter is a local date/time on a site. If you search across multiple sites in different time zones the search looks for the local date/time at each site.

to-date

LocalDateTime (optional)

The end date/time for the search (exclusive). If not provided the API is looking for days/months into the future to satisfy the requested number-of-results. This may take some time. If you need to get slots for a specific day only it is recommended to provide to-date to make the request quick.

time-preference

int (optional)

Preferred time filter:

  • 0 = any time
  • 1 = Morning 00:00 – 12:00
  • 2 = Afternoon 12:00 – 00:00

Note this parameter is ignored if any from time-from or time-to are provided.

time-from

string “HH:ss”

(optional)

Time filter for the appointment start time. E.g 09:30.

time-to

string “HH:ss”

(optional)

Time filter for the appointment finish time. E.g 11:00.

from-date

DateTime (optional)

Filters appointments on or after this date.

Note: Only day is accepted. Time is ignored.

time-preference

int (optional)

Preferred time filter:

  • 0 = any time
  • 1 = Morning
  • 2 = Afternoon

payer-type

String

(Optional)

The signup code of a chargeband, that will provide eligibility and price information for the search.

number-of-results

Int (optional)

Required number of proposed slots. Value must be in a range 1 – 100.

POST Parameters

Parameter Type Description
modules AppointmentData[] (optional) Selection of modules and additional services provided by the API upon GetAppointmentTypes.
services ServiceData[] (optional) Selection of services provided by GetServices

Returns

AppointmentData[]

Remarks

The server sorts the result by day and time of the appointment (the soonest appointment first).