Skip to main content

Wizard for Direct Clinic Appointment Request


Use the Direct Clinic Appointment Request screen to create a clinic appointment request with a selected provider and clinic location.



This screen includes:

#ElementDescription
1HeaderDisplays the Appointment request title and back action
2Provider cardDisplays provider name, specialty, appointment date, time, visit type, distance, and clinic note
3Coverage sectionDisplays the selected coverage or payment option
4Patient details sectionDisplays the selected patient profile
5Contact information sectionCollects contact name, email, phone number, and preferred contact methods
6Medications sectionCaptures whether the patient takes medications on a regular basis
7Medical issue sectionCollects the medical problem description
8Attachment actionAdds supporting documents
9Primary actionContinues to the next appointment request step
10Data-sharing noticeExplains that details are shared with the doctor

Workflow

  1. Select a doctor > Clinic location.
  2. Open the Direct Clinic Appointment Request screen.
  3. Review provider and appointment details.
  4. Select coverage and patient information.
  5. Enter required contact information.
  6. Complete medical information.
  7. Select Next.

Validations

ScenarioApp BehaviorSDK Output
Provider missingBlock screen loaderror = profile_required
Location missingBlock screen loaderror = location_required
Specialty missingBlock screen loaderror = specialty_required
Patient missingDisable Nextvalidation = patient_required
Contact name missingDisable Nextvalidation = contact_name_required
Email missing or invalidDisplay field validationerror = invalid_email
Phone number missing or invalidDisplay field validationerror = invalid_phone
Contact method missingDisable Nextvalidation = contact_method_required
Medical issue missingDisable Nextvalidation = medical_issue_required
Required fields completeEnable Nextstate = ready
Request rejectedDisplay error statestatus = 405

Actions

ScenarioApp BehaviorSDK Output
Screen opensLoad clinic appointment request formPUT /api/v3/wizard/direct-clinic
Coverage selectedUpdate coverage contextcoverage = selected
Patient selectedUpdate patient contextpatient = selected
Contact details enteredUpdate contact statecontact = updated
Contact method selectedUpdate contact preferencecontactPreference = updated
Medication option selectedUpdate medication statemedications = updated
Medical issue enteredUpdate request detailsmedicalIssue = updated
Attachment selectedAdd supporting documentattachment = added
Next selectedContinue appointment request flownavigation = next
Back selectedReturn to previous screennavigation = back

Endpoint Resources

Wizard for Direct Clinic

PUT 

v3/wizard/direct-clinic

Returns the appointment request screen for a direct clinic appointment with the selected provider and location.