Qualifying Life Events

Detailed mapping of the fields used in a POST request to create a qualifying life event. The schema below is used in the /subscribers/{id}/qualifying_life_events endpoint

Required Elements

These elements are Required when creating a qualifying life event using a POST request to the Ideon API.

Qualifying Life Events contain an element called Plan Elections, which contain the members coverage details, dates, and status.

Ideon	Usage and Mapping
*external_identifier	This is an identifier that your system can use or generate to identify the qualifying_life_event. This is in addition to our id that we generate upon creation.
*coverage_period_id	This is a foreign key formatted reference to a coverage period uuid - the Ideon generated unique identifier referring to the created coverage period. This creates a link between a Carrier and Subscriber when you send coverages to Ideon.
*eligibility_start_date	This field is a place to provide the date that the member was first eligible for coverage, across product lines
*date	This field is used to capture the date that the Event took place. This Event is the life event which qualified the member for coverages.
*event	This field is used to express the Type of Event that qualified the member for coverages. More information on each event type can be found in the Events mapping sub-guide. Accepted values: birth, cobra, divorce, initial_enrollment, loss_of_coverage, marriage, new_hire, newly_eligible, open_enrollment, termination_of_employment, re_hire
*plan_elections	This object holds the association between a Member and a Plan, per coverage period. It is used to store coverage details for each product line elected or waived. Each plan election entry can be either an Election of coverage, or a Waiver of coverage More information on each event type can be found in the Plan Elections mapping sub-guide. Accepted product line values: medical dental vision voluntary_life non_voluntary_life accidental_death_dismemberment voluntary_accidental_death_dismemberment life_accidental_death_dismemberment voluntary_life_accidental_death_dismemberment short_term_disability long_term_disability hospital_indemnity critical_illness accident cancer legal identity_protection pet absence_management employee_assistance_program

Conditionally Required Elements

While the elements above are required, there are additional common elements that your system will likely have available.

We ask you provide these common values if available, as these can be required by Carriers on their data transmissions.

These elements are Recommended

Ideon	Usage and Mapping
eligibility_end_date	Situationally, this should be provided for a member that is becoming ineligible for coverages or ending them. This end date should be provided alongside benefit level end dates for each relevant product line.
enrollment_signature_date	This value is the date the member signed-up for coverages.

Elements Provided in a Successful Response

These fields are produced in a successful response.

Ideon	Usage and Mapping
received_date	This is the date that we received that request.
id	This is the uuid generated for each qualifying life event. This is unique and can be used to identify the exact transmission created by your system.
status	This is the status of the QLE in our system - at creation, this will be a "pending" status. Possible values: pending newly created or not yet transmitted to the carrier submitted transmitted to the carrier, but not yet confirmed synced transmitted to the carrier, confirmed by the carrier errors error before or during transmission superseded this QLE was disregarded, as a new request came in afterwards more relevant data
created_at	This is the date that the successful QLE was created.

See Additional Documentation for links to our current API documentation.