Skip to main content

Add New Patient


Use the Add a new patient modal to create a patient profile during the appointment request flow.


Select patient dialog showing existing patient entries and Someone else option

This screen includes:

#ElementDescription
1Modal titleDisplays Add a new patient
2Close actionDismisses the modal without changes
3First name fieldRequired patient first name
4Last name fieldRequired patient last name
5Date of birth fieldRequired date of birth with date picker
6Sex selectorSelects Female, Male, or Other
7Close actionCloses the modal without creating a patient
8Add new patient actionCreates the patient profile

Workflow

  1. Open the appointment request flow.
  2. Select Patient name.
  3. Select Add a new patient.
  4. Enter the required patient details.
  5. Select Add new patient.
  6. Return to the appointment request with the new patient available for selection.

Validations

ScenarioApp BehaviorSDK Output
Required field emptyDisable Add new patient or show field errorvalidation = required
Date of birth invalidDisplay date field errorerror = invalid_date_of_birth
Sex not selected when requiredDisable Add new patientvalidation = required
Non-Latin name requires Latin fieldsDisplay Latinized name fieldslatinFields = required
Request in progressShow loading statestate = loading
Request blockedDisplay restriction messageHTTP 405

Actions

ScenarioApp BehaviorSDK Output
Screen openedLoad patient creation formPUT /api/v3/patients/create
Patient details enteredUpdate local form statepatient = updated
Date picker selectedUpdate date of birthdateOfBirth = updated
Sex selectedUpdate sex valuesex = updated
Add new patient selectedSubmit patient creation requestCreate request triggered
Patient creation succeedsAdd patient to the request flowpatient = saved
Close selectedDismiss modal without changesNo state change

Endpoint Resources

New patient 🤒

PUT 

v3/patients/create

Provides the new patient creation form and required onboarding fields.

Update patient 🤒

POST 

v3/patients/update

Updates patient details with the required onboarding information.