Skip to main content

Select Patient


Use the Select patient modal to choose an existing patient profile during the appointment request flow


Select patient modal with existing patient options and Add a new patient action

This screen includes:

#ElementDescription
1Patient name fieldOpens the patient selector from Patient details
2Modal titleDisplays Select patient
3Close actionDismisses the modal without changing the selected patient
4Patient listDisplays existing patient profiles
5Patient optionSelects one patient for the appointment request
6Add a new patient actionOpens the Add a new patient modal

Workflow

  1. Open the appointment request flow.
  2. Select Patient name in Patient details.
  3. Review the existing patient profiles.
  4. Select an existing patient or select Add a new patient.
  5. Return to the appointment request with the selected patient.

Validations

ScenarioApp BehaviorSDK Output
No patient profiles existDisplay Add a new patient actionpatients = empty
No patient selectedKeep appointment request incompletevalidation = patient_required
Patient list fails to loadDisplay error stateerror = patients_load_failed
Request in progressShow loading statestate = loading
Request blockedDisplay restriction messageHTTP 405

Actions

ScenarioApp BehaviorSDK Output
Patient name selectedOpen patient selectorPatient selector opened
Patient selectedAssign patient to appointment requestpatient = selected
Add a new patient selectedOpen patient creation modalNavigation or modal event
Close selectedDismiss selector without changesNo state change

Endpoint Resources

Patients

PUT 

v3/patients

Returns the patient selection page model with existing patient profiles.

Parameter Reference

ParameterTypeRequiredDescription
patient-details-idintegerYesExisting patient identifier in the current flow context

Save Selected Patient

POST 

v3/patients/select

Sets the selected patient as active in the current appointment flow.