Skip to main content

Add New Coverage


Use Add New Coverage to create and link a new insurance policy.

Required fields and insurer-specific validation rules derive from the coverage configuration response.


Add Coverage screen showing insurer selection and policy input fields

This screen includes:

#ElementDescription
1HeaderDisplays screen title and close action
2Insurer selectorSelects the insurance provider
3Policy number fieldUpdates the policy identifier
4Dynamic form fieldsDisplays insurer-specific required fields
5Date fieldUpdates date-based identifiers when required
6Validation messageDisplays invalid or missing field errors
7Add coverage actionSubmits coverage details
8Cancel actionDismisses the screen

Workflow

  1. Open Add New Coverage.
  2. Render insurer-specific fields.
  3. Select or update the insurer.
  4. Refresh required fields when insurer changes.
  5. Enter required policy information.
  6. Validate field values.
  7. Submit coverage details.
  8. Link the policy to the active account.
  9. Update the active coverage state when applicable.

Validations

ScenarioApp BehaviorSDK Output
Required field missingBlock submissionerror = required_field
Policy number invalidDisplay validation errorerror = invalid_policy
Identifier invalidDisplay validation errorerror = invalid_identifier
Date invalidDisplay validation errorerror = invalid_date
Insurer updatedRefresh required fieldsfields = updated
Coverage unsupportedDisplay error statecoverage = unsupported
Validation failsPreserve editable statestate = error
Request in progressDisplay loading statestate = loading

Actions

ScenarioApp BehaviorSDK Output
Add New Coverage openedLoad coverage formPUT /api/v3/coverage/add
Insurer changedRefresh insurer fieldsPATCH /api/v3/coverage/add/new-coverage/change-company
Field updatedUpdate form stateform = updated
Add coverage selectedSubmit coverage requestPOST /api/v3/coverage/add/new-coverage
Coverage createdLink active policycoverage = linked
Coverage activatedRefresh coverage contextcoverage = active
Submission rejectedDisplay validation errorsstate = error
Cancel selectedDismiss screenstate = unchanged

Endpoint Resources

Add Coverage

PUT 

v3/coverage/add

Displays add coverage screen.

Proceed Add New Coverage

POST 

v3/coverage/add/new-coverage

Assigns patient to specified policy.