Coverage Periods

Detailed mapping of the fields used in a POST request to create a coverage_period. The schema below is used in the /groups/{id}/coverage_periods endpoint.

Ideon
Provide?
Usage and Mapping

external_identifier*

Required

This is an identifier that your system can use or generate to identify the coverage period. This is in addition to our id for a coverage period.

coverage_start_date*

Required

Required. This is the most recent policy start date for the employer at the given carrier. Note: - Map a recent (rather than original) effective date for the carrier policy. - Coverage periods can have different start dates per carrier for one employer.

coverage_end_date

Preferred

This is the most recent policy effective end date for the employer at the given carrier. Note: - Map the most accurate date at the time of creation. If a policy is extended, we can adjust our system to display a more accurate end date (this date only informs reach-out actions on our end)

open_enrollment_end_date

Preferred

Use these fields to note operational dates around open enrollment. This information is used by our team to inform priorities and upcoming renewals.

open_enrollment_start_date

Preferred

Use these fields to note operational dates around open enrollment. This information is used by our team to inform priorities and upcoming renewals.

additional_information

Optional

This is a free-text field that allow special information like: - expected client contact - additional mapping information - boolean values to indicate whether a group is part of a PEO, multi-group file.

carrier_name*

Required

Required. This is the carrier name from Ideon's enum with which the employer has coverage.

carrier_group_number

Preferred, Required by several Carriers

This field holds the "group" or policy number under which the employer is known by the carrier.

Several carriers have specific formats and require this number to be provided -

  • if the number is unknown or a filler value is given, Ideon Operations can override this value for implementation.

enrollment_type

Hardcode

Default this to member_management

Last updated

Was this helpful?