Add Coverage

---

Use the Add Coverage screen to link an insurance policy to a patient account.

This screen includes:

• A modal header that displays the screen title and a close control.
• A search field that filters available insurance providers.
• A scrollable list of selectable coverage options.
• Icons that identify coverage entries.
• An informational message for users who do not find their insurance provider.
• A primary button that confirms the selected coverage and continues the flow.

note

Each insurer defines its required identifiers. The screen displays only the fields required for the selected insurer.

---

Entry Points

The SDK presents the Add Coverage screen from the following flows:

Flow	Trigger	Screen Behavior	Screenshot
Home	User selects the Policy field.	The coverage selection or creation flow opens.
Account > My coverage	User selects Add Coverage.	The coverage creation flow opens.

---

Workflow

1. On the Home screen, select the Policy field.

   

2. Choose an insurance provider or select Add a new coverage.

   

3. On the Add Coverage screen, select a insurance provider from the list.

4. Enter the policy number and any required information > Continue.

5. Select Add Coverage.

To Change the active policy

1. Reopen the Add Coverage field.
2. Select a different insurance provider or select Private.

---

Validations

Scenario	App Behavior
Invalid policy number format.	An inline error appears and submission remains blocked.
Missing or invalid required identifier.	The field displays an inline error and requires correction.
Personal ID does not match required pattern.	The field shows an inline error message.
Date of birth value is invalid.	The app displays an inline validation error.
Phone number format is invalid.	An inline error appears under the field.
One or more visible fields contain invalid values.	The Add Coverage button remains unavailable.
Insurer validation fails.	An error pop-up displays retry and Private options.

Actions

Scenario	App Behavior
Coverage state is missing, invalid, or unverified.	The Add Coverage screen opens.
User submits coverage details.	The app sends the policy number and identifiers for validation.
Successful validation response.	The coverage links and the screen closes.
Insurer branding metadata exists.	The UI reflects insurer-specific configuration.
Coverage transitions to active state.	Pricing and claim-related UI elements refresh.
Private mode selection.	Insurer fields disappear and private-pay mode activates.
Coverage flow completes.	The app returns to the previous screen.
Coverage status changes.	The UI reflects the updated state.

---

Endpoint Resources

Coverage

PUT 

/coverage

Returns the coverage selection screen configuration for the authenticated user.

The response contains a searchable list of insurance providers, selectable coverage options, and a primary action that submits the selected coverage.

Select Policy

POST 

/coverage/select?policy-id={policyId}

Updates the authenticated user’s active policy to the policy specified by policy-id.

A successful request commits the policy selection and returns no response body.