GetServices

Gets available services

JavaScript library method 

patientportal.appointment.getServices({
    payerType: <payer-type>,
    appointmentType: <appointment-type>,
    serviceType: <service-type>,
    serviceName:<service-name>,
    referralTypes: <referral-types>,
    patient: <patient>,
    referral: <referral>,
    recall: <recall>,
    pageSortColumn: <page-sort-column>,
    pageSortDescending: <page-sort-descending>,
    pageNumber: <page-number>,
    pageSize: <page-size>
});

HTTP Method

Verb URL
GET /patientportalapi/appointment/services

URL Parameters

Parameter Type Description
payer-type string Type of the payer provided by the API upon GetPayerTypes.
appointment-type string Type of the appointment provided by the API upon GetAppointmentTypes
service-type string (optional) Key of the service type to filter services by, provided by GetServiceTypes
service-name string (optional) Name of service to filter services by.
referral-types bool (optional)

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

Used to get service types for a specific referral.
patient string (optional)

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

Get the services specific for the patient. 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 get service types for a specific recall.
page-sort-column int (optional)

The column index to sort the result:

  • 0 – Name
  • 1 – Code
  • 2- Service Type
  • 3- ServiceId

Default: 0,2
page-sort-descending int (optional) True to sort result descending. Default false.
page-number int (optional) Required page number. Default 1.
page-size int (optional) Required page size. Default 10. Minimum 5. Maximum 50.

Returns

ServiceData[]

Remarks

If no services are returned for the appointment type, either the appointment type does not allow additional services or no services exist in self book rule.