schedule
Provides an api to schedule a retail appointment
See also
Parameters
A PaymentMethod object containing the patient's payment information
A RetailVisitInformation object containing additional details required to schedule the retail appointment.
A TimeSlot that the user is requesting to schedule the appointment in. TimeSlots are returned by getTimeSlots.
The EHR system the appointment will be scheduled in. This is determined based on the Retail RetailDepartment's ehrSystemName property.
A DexCarePatient object containing demographics information about the patient.
Optional, a DexCarePatient object containing information about a parent or app user who's booking the visit for someone else. This is only used when VirtualVisitInformation.patientDeclaration is org.dexcare.services.models.PatientDeclaration.Other.
Throws
Returned when any of the following required properties are empty string:
This error is additionally returned when:
RetailVisitInformation.userEmail does not meet validation requirements (see org.dexcare.util.EmailValidator)
RetailVisitInformation.contactPhoneNumber does not meet validation requirements (see org.dexcare.util.PhoneValidator)
patientDexCarePatient does not have a demographic link in the EHR system specified by ehrSystemName,
patientDexCarePatient's address list is empty or the first address contains an invalid zip code (see org.dexcare.util.ZipCodeValidator)
actorDexCarePatient is non-null but has no demographic links,
RetailVisitInformation.actorRelationshipToPatient is null when booking a "someone else" visit,
actorDexCarePatient is not set when RetailVisitInformation.patientDeclaration is set to org.dexcare.services.models.PatientDeclaration.Other.
Returned when another user has already claimed this time slot.
Returned when the user has already booked another appointment at the same time.
An unexpected error occurred when communicating with Epic and the appointment failed to book.
This error indicates the time slot selected is unavailable.
Returned when the selected time slot is in the past and is no longer available.