Add New Coverage

---

Use Add New Coverage to collect insurer-specific policy data and submit a new coverage record for the authenticated patient.

After successful submission, the platform validates the coverage data, links the policy to the patient account, and updates the active coverage context when applicable.

This screen includes:

• A modal header with the title Add coverage and a close control.
• A preselected insurer field with a dropdown selector.
• Input fields for policy number and required identifiers.
• A date picker field for date-based identifiers, when required.
• Inline validation for missing or incorrectly formatted values.
• A Cancel action that closes the modal without saving.
• A primary action button labeled Add coverage, which remains disabled until all required fields pass client-side validation.

---

Workflow

1. Open the Policy field from the Home screen.

2. Select Add new coverage.

3. The platform returns insurer-specific field requirements for the selected insurer.

4. Render the required input fields.

5. Select or confirm the insurer.

6. Enter the required policy data:

   • Policy number.
   • Required identifiers.
   • Date-based values, when required.

7. Perform client-side validation on required and formatted fields.

8. Submit the coverage request.

9. The platform validates the submitted data.

   • Success: The platform creates and links the coverage to the patient account.
   • Active policy update (if applicable): The platform sets the new policy as the active coverage.
   • Failure: The platform returns validation errors and the UI remains editable.

---

Validations

These rules define client-side and platform validation behavior for new coverage creation.

Condition	App behavior	SDK output
Required field is missing.	Display inline validation and block submission.	No request is sent.
Policy number format is invalid.	Display inline validation and block submission.	No request is sent, or validation error if server-side rules also apply.
Identifier format is invalid.	Display inline validation and block submission.	No request is sent, or validation error if server-side rules also apply.
Date value is invalid.	Display inline validation and block submission.	No request is sent, or validation error if server-side rules also apply.
One or more fields are invalid.	Keep Add coverage disabled.	No request is sent.
Platform validation fails.	Display returned error and keep the form editable.	Structured error response with validation details.
Coverage does not match patient context in wizard flow.	Display generic error and stop progression.	Error response indicating coverage mismatch or rejected request.

Actions

These actions define runtime behavior during coverage creation.

Condition	App behavior	SDK output
Screen opens.	Render insurer-specific input fields.	Field configuration returned by platform or prior step context.
User enters coverage details.	Validate input locally and update field state.	No request sent.
User submits coverage.	Send coverage creation request.	Request with policy identifiers and required metadata.
Validation succeeds.	Update UI and proceed in flow.	Response confirming coverage creation and linkage.
Coverage becomes active.	Update pricing and coverage-dependent UI.	Updated active coverage context returned.
Wizard flow validation fails.	Display error and stop progression.	Structured error response.
Flow completes.	Return to the previous screen or next configured route.	Navigation depends on integration configuration.

---

Endpoint Resources

Add Coverage

PUT 

v3/coverage/add

Displays add coverage screen.

Change Selected Company

PATCH 

v3/coverage/add/new-coverage/change-company

Updates new coverage registration screen by selected company.

Proceed Add New Coverage

POST 

v3/coverage/add/new-coverage

Assigns patient to specified policy.