Error Management and Response

This page provides detail on how to use Ideon's API endpoints for error visibility, management and response

Mapping and Implementation Guide

A full guide on the schema and endpoints is provided here.

This includes:

• Set-up

• Endpoints

• Design Questions

• Request Mapping

• Response Mapping

Use-cases

The main use-cases for error management are:

Viewing Errors

• Distribute errors and make them visible to various parties in your organization

  • Use coverage period id to determine and partition access for a given user in your interface

Resolving & Maintaining Errors

• Comment or view current comments

• Resolve an error and provide a message to describe the resolution

• Link up associated member maintenance or user actions such as:

  • Sending updated demographic information

  • Sending new or updated coverage information

  • Raising a system enhancement due to systematic issue

Designing an Error Management Interface

There are four endpoints available for error management:

1. GET /coverage_periods/{id}/errors

2. GET /errors/{id}

3. POST /errors/{id}/comments

4. POST /errors/{id}/resolution

A full mapping guide is provided here.

Consider some of the Design Questions provided to better understand the scope of your development.

The steps necessary to resolve an error will differ based on your integration and system. In your user interface for error management, ensure that a user can:

• View the error message

• View any error comments that may have been sent by Ideon

• Return an error to the Ideon team

• Add a comment to an error that is a pending or returned error

• Resend a member's updated or missing demographic, coverage information

• Resolve an error and provide a resolution message