---
description: >-
  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
---

# Qualifying Life Events

## Required Elements

&#x20;These elements are <mark style="background-color:red;">Required</mark> when creating a qualifying life event using a POST request to the Ideon API.&#x20;

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

<table><thead><tr><th width="259">Ideon </th><th>Usage and Mapping</th></tr></thead><tbody><tr><td>*external_identifier</td><td>This is an identifier that your system can use or generate to identify the qualifying_life_event. This is in addition to our <code>id</code> that we generate upon creation. </td></tr><tr><td>*coverage_period_id</td><td>This is a foreign key formatted reference to a coverage period uuid - the Ideon generated unique identifier referring to the created coverage period. <br><br><mark style="background-color:green;">This creates a link between a Carrier and Subscriber when you send coverages to Ideon.</mark></td></tr><tr><td>*eligibility_start_date</td><td>This field is a place to provide the date that the member was first eligible for coverage, across product lines</td></tr><tr><td>*date</td><td>This field is used to capture the date that the Event took place. <br><br>This Event is the life event which qualified the member for coverages. </td></tr><tr><td>*event</td><td>This field is used to express the Type of Event that qualified the member for coverages. <br><br><strong>More information on each event type can be found in the</strong> <a href="qualifying-life-events/events"><strong>Events</strong></a> <strong>mapping sub-guide.</strong><br><br>Accepted values: <br>birth, cobra, divorce, initial_enrollment, loss_of_coverage, marriage, new_hire, newly_eligible, open_enrollment, termination_of_employment, re_hire</td></tr><tr><td>*plan_elections</td><td><p>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. </p><p></p><p>Each plan election entry can be either an <mark style="color:green;">Election</mark> of coverage, or a <mark style="color:yellow;">Waiver</mark> of coverage<br><br><strong>More information on each event type can be found in the</strong> <a href="qualifying-life-events/plan-elections"><strong>Plan Elections</strong></a> <strong>mapping sub-guide.</strong><br><br>Accepted product line values: </p><p><br>medical</p><p>dental</p><p>vision</p><p>voluntary_life</p><p>non_voluntary_life</p><p>accidental_death_dismemberment voluntary_accidental_death_dismemberment life_accidental_death_dismemberment voluntary_life_accidental_death_dismemberment short_term_disability</p><p>long_term_disability</p><p>hospital_indemnity</p><p>critical_illness</p><p>accident</p><p>cancer</p><p>legal</p><p>identity_protection</p><p>pet</p><p>absence_management</p><p>employee_assistance_program</p></td></tr></tbody></table>



## Conditionally Required Elements&#x20;

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

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

These elements are <mark style="background-color:purple;">**Recommended**</mark>



<table><thead><tr><th width="259">Ideon </th><th>Usage and Mapping</th></tr></thead><tbody><tr><td>eligibility_end_date</td><td>Situationally, this should be provided for a member that is becoming ineligible for coverages or ending them. <br><br>This end date should be provided alongside benefit level end dates for each relevant product line.</td></tr><tr><td>enrollment_signature_date</td><td>This value is the date the member signed-up for coverages. </td></tr></tbody></table>



## Elements Provided in a Successful Response&#x20;

These fields are produced in a successful response.

<table><thead><tr><th width="259">Ideon </th><th>Usage and Mapping</th></tr></thead><tbody><tr><td>received_date</td><td>This is the date that we received that request.  </td></tr><tr><td>id</td><td>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.</td></tr><tr><td>status</td><td><p>This is the status of the QLE in our system - at creation, this will be a "pending" status.<br><br>Possible values:</p><p></p><ul><li>pending - newly created or not yet transmitted to the carrier</li><li>submitted - transmitted to the carrier, but not yet confirmed </li><li>synced - transmitted to the carrier, confirmed by the carrier</li><li>errors - error before or during transmission</li><li>superseded - this QLE was disregarded, as a new request came in afterwards more relevant data</li></ul></td></tr><tr><td>created_at</td><td>This is the date that the successful QLE was created.</td></tr></tbody></table>



See Additional Documentation for links to our current API documentation.

