Skip to main content

Validate Coverage


Use the Validate Coverage step to confirm that the selected or newly added coverage is valid for the current request.

This screen appears when coverage validation fails.

The platform returns validation errors when:

  • policy data is invalid,
  • required identifiers are missing or incorrect,
  • or the coverage is not eligible for the current request.
ValidateCoverage screen showing error policy number not found

This screen includes:

  • A modal header with an error title and a close control.
  • A validation message that describes the failure reason.
  • Guidance text that explains available next steps.
  • A support link for further assistance.
  • A primary action button labeled Try again to retry validation.
  • A secondary action labeled Continue as private user.

Workflow

  1. Select an existing policy or submit new coverage data.

  2. Submit the coverage for validation.

  3. The platform validates:

    • policy existence,
    • required identifiers,
    • eligibility for the current request.
  4. The platform returns the validation result.

    • Success: The platform confirms eligibility and updates the active coverage context.
    • Failure: The platform returns validation errors and the Validate Coverage screen appears.
  5. If validation fails:

    • Display validation error details.
    • Allow retry or alternative action.

Validations

These rules define coverage validation constraints enforced by the platform.

ConditionApp behaviorSDK output
Policy is expired.Display error and block continuation.Validation error indicating expired policy.
Policy is not yet active.Display error and block continuation.Validation error indicating inactive policy.
Required identifier is missing.Display inline validation.Validation error indicating missing field.
Identifier format is invalid.Display inline validation.Validation error indicating invalid format.
Policy is not eligible for the current request.Display error and block progression.Validation error indicating ineligible coverage.
Coverage does not match patient context.Display error and require correction.Error response indicating mismatch.
Platform validation fails.Display error state and stop progression.Structured error response with validation details.

Actions

These actions define behavior during coverage validation.

ConditionApp behaviorSDK output
Validation request sent.Display loading or pending state.Validation request submitted to platform.
Validation succeeds.Proceed with the flow.Response confirming valid coverage.
Validation fails.Display validation error screen.Response containing validation errors.
User selects Try again.Retry validation flow.New validation request.
User selects private option.Switch to private-pay mode.Session context update request.
Flow resumes.Continue based on selected action.Navigation depends on integration configuration.

Endpoint Resources

Show Policy not Found

PUT 

v3/coverage/add/new-coverage/error/policy-not-found

Shows error popup if policy number was not found.

Show Policy Wrong Data

PUT 

v3/coverage/add/new-coverage/error/wrong-policy-data

Shows error popup if policy data is not correct.

Show association success

PUT 

v3/coverage/add/new-coverage/success

Shows success popup if policy was associated with user.

Update Fields

PATCH 

v3/coverage/add/new-coverage

Shows additional data fields after policy validation.