Add Patient

---

Use the Patient details section to select or create a patient profile for the appointment request.

The selected patient defines the identity details shared with the doctor during the appointment flow.

This screen includes

• A patient selector with existing patient profiles.
• An option to Add new patient.
• A modal with required patient fields:
  • First name
  • Last name
  • Date of birth
• A gender selector, when applicable.
• Inline validation for required and invalid fields.
• A primary action to confirm patient creation.
• A close action to dismiss the modal without changes.

---

Workflow

1. Open the Appointment request and select Patient name.
   
2. The platform returns existing patient profiles.
3. Select an existing patient or choose Add new patient.
   
4. If creating a new patient, enter required details and submit the request.
   
5. The platform validates and returns the updated patient list.
6. Assign the selected patient and continue the flow.

---

Latinized Patient Name

The platform supports non-Latin characters in patient names.

When First name or Last name contains non-Latin characters:

• The platform returns a requirement for Latinized fields.
• The client renders additional input fields:
  • First name in Latin letters
  • Last name in Latin letters

Field requirements are determined by the validation endpoint.

PATCH /patients/create/validate

---

Validations

These rules define patient selection and creation constraints.

Condition	App behavior	SDK output
Required field is empty	Highlight field and block submission	Validation error indicating missing field
Date of birth is invalid	Display validation state and block submission	Validation error indicating invalid date
No patient selected	Block progression	Validation state indicating missing patient
Non-Latin characters require Latin fields	Render additional fields	Validation response indicating required fields

Actions

These actions define patient selection and creation behavior.

Condition	App behavior	SDK output
Load patient selector	Render patient list	Response with patient profiles
Select existing patient	Assign patient to appointment	Update with selected patient
Select Add new patient	Open creation modal	No request sent
Submit new patient	Send creation request	Request to create patient profile
Creation succeeds	Update patient list and assign patient	Response with updated patient list
Creation fails	Display validation errors	Error response
Close modal	Dismiss without changes	No update

---

Endpoint Resources

This section lists the parameters used to render patient pages and submit patient identity data.

Parameter Reference

Use this table for endpoints that accept patient identity fields.

Parameter	Type	Required	Description
patient-details-id	Integer (int32)	Conditional	Unique identifier for an existing patient in the current flow context.
first-name	String	Conditional	Patient first name.
last-name	String	Conditional	Patient last name.
date-of-birth	String (date)	Conditional	Patient date of birth.
gender	Enum	Conditional	Patient gender. Allowed values: male, female, both, other.
personal-id	String	Optional	Patient personal identification number.
first-name-latin	String	Conditional	First name in Latin characters when required by validation.
last-name-latin	String	Conditional	Last name in Latin characters when required by validation.

Required Behavior

Parameter requirements depend on the request type:

Existing patient selection

Requires patient-details-id.

New patient creation

Requires:

• first-name
• last-name
• date-of-birth
• gender

Latinized name requirement

When validation requires Latin characters:

• first-name-latin
• last-name-latin must be provided.

Each endpoint defines its exact required fields.

---

Patients

PUT 

/patients

Returns the patient list page model.

The response contains a complete page definition used to render the patient selection surface. The structure follows the internal Put Response Format and includes layout components, actions, and navigation metadata required by the client runtime.

New Patient

PUT 

/patients/create

Returns the new patient creation page model.

The response defines all required input fields, validation rules, conditional Latin name logic, and action bindings. The structure follows the internal Put Response Format.

Existing Patient

PUT 

/patients/update

Returns the patient update page model for the specified patient-details-id.

The response pre-populates editable fields and provides validation and action bindings. The structure follows the internal Put Response Format.

Validate Name

PATCH 

/patients/create/validate

Evaluates first-name and last-name values.

The response returns incremental UI updates that control:

Visibility of Latin name fields

Field-level validation states

The structure follows the internal Patch Response Format and applies updates to the currently mounted page without reloading it.

Create Patient

POST 

/patients/create

Persists a new patient record.

The operation validates required identity attributes and optional Latin name fields, then commits the entity. No response body returns. See Committing Data.

Save Selected Patient

POST 

/patients/select

Sets the specified patient as active in the current flow context.

The operation commits the selection state. No response body returns. See Committing Data.

Update Patient

POST 

/patients/update

Persists additional or corrected patient attributes for the specified patient-details-id.

The operation updates identity metadata and commits the changes. No response body returns. See Committing Data.