GetSites

Gets possible sites for the specific appointment type. A site is a geographically-unique place. Each site may include additional ‘locations’, which are typically rooms at the site (Room 123, Surgery, etc.), but may also be geographically different places associated with the site (First floor, West wing, Building 3, etc.).

The API will only present you with locations which mean something to a user. So they’re unlikely to get a choice about Room 1, 2, 3, etc. but they may get a choice about Site: My Bank, Location: Floor 1, Floor 50, Floor 100, etc.

JavaScript library method 

patientportal.appointment.getSites({
    appointmentType: <appointment-type>,
    lat: <lat>,
    long: <long>,
    addressType: <address-type>,
    clinicians: <clinicians>,
    payerType: <payer-type>,
    patient: <patient>,
    referral: <referral>,
    recall: <recall>
});

HTTP Method

Verb URL
POST /patientportalapi/appointment/sites

URL Parameters

appointment-type

string

Type of the appointment provided by the API upon GetAppointmentTypes.

lat

long

decimal (optional)

Latitude and Longitude from GPS so server can sort sites by distance.

Latitudes and Longitudes are defined using numerals that have a precision to 6 decimal places. For example, “lat=51.541743&long=-0.13715" is a valid value.

address-type

int (optional)

Parameter specifies how the response should be sorted:

  • 1 = Home address
  • 2 = Work address

The server uses this value only if the GPS coordinate is not provided.

payer-type

string

Type of the payer provided by the API upon GetPayerTypes.

patient

string (optional)

The key of the patient provided by the API upon section Patients.

Used to book an appointment for a different patient within your company. Default is the logged in patient.

referral

string (optional)

The key of the referral provided by the API upon GetReferrals.

Used to book an appointment for a specific referral.

recall

string (optional)

The key of the recall provided by the API upon method GetRecalls.

Used to book an appointment for a specific recall.

POST Parameters

Parameter Type Description
clinicians int[] (optional) Clinicians filter. Array of identifiers provide by the API upon GetClinicians. Null or empty for any clinicians.
modules AppointmentModuleData[] (optional) Selection of modules and additional services provided by the API upon GetAppointmentTypes. Available sites will be filtered according to availability of the specified modules.

Returns

SiteData[]

Remarks

If no lat/long or addressType is provided the server sorts sites by the patient’s home address.