Plans

Detailed mapping of the fields used in a POST request to create a plan. One or more Plans are associated with one Coverage Period. The schema below is used in the /coverage_periods/{id}/plans endpoint

Ideon	Provide?	Usage and Mapping
external_identifier*	Required	This is an identifier that your system can use or generate to identify the plan. This is in addition to our id that we generate upon creation.
description*	Required	This is the description of a given plan - This is often the Plan Marketing Name displayed to an employee when electing the plan option
product_line*	Required	This is the Product Line of the given plan option - Values: medical dental vision life accidental_death_dismemberment life_accidental_death_dismemberment accident critical_illness hospital_indemnity disability Note: These values are less specific than the values used in the qualifying life events plan_elections enum.

For most product lines, there are additional specific Required fields that are enumerated in our schema:

Ideon		Usage and Mapping
product_type	Required	Required for: medical - values health_maintenance_organization, high_deductible_health_plan, preferred_provider_organization, exclusive_provider_organization, point_of_service, indemnity disability - values short_term, long_term This is the "type of plan" for which the group has coverage. For Medical, this can be used to provide information and shorten the Description.
premium_level	Required	Required for: dental vision values: base, buyup, none This element is used to mark whether an option is a Base (Lowest Cost, Default) offering or a higher cost option (Buy-Up)
voluntary	Required	critical illness hospital_indemnity life life_accidental_death_dismemberment accidental_death_dismemberment disability This element denotes whether a plan is partially employee-paid (Voluntary) or a fully employee-paid option, when applicable for the product line. "Basic Group Life" is an example of a product that we would anticipate being "voluntary": "false"
covered_member_types	Required	life life_accidental_death_dismemberment accidental_death_dismemberment disability Values: employee , partner , child This element describes which type of member is eligible for this plan. This is not a given member's coverage level, but rather helps us know the allowable type of dependent, and whether the plan is employee only.

See Additional Documentation for links to our current API documentation.