EN AD&D fields   127 fields   EN schema GroupADAndDPlan · POST /Quoting/companies/{companyId}/plans/adandd/notification
— / —
EN field pathTypeReqDescription / enum
(root)
planIdentifierstring✓The unique identifier assigned for the purpose of identifying a plan. This value is the key used to link a plan between the two systems and how we will communicate about the plan. A plan is a set of benefit of rates and should not include billing groups.
configurationPlanConfiguration✓
configuration
configuration.policyNumberstringValue assigned to the plan for the specific company
configuration.carrierNamestring
configuration.planNamestring
configuration.startDatestring✓Effective date representing the most recent plan year start date for the current set of benefits and rates. Our plans couple benefits and rates together.
configuration.endDatestringEffective date representing the plan year end date for the current set of benefits and rates. Typically plans are 12-month plan years, unless policy is Issue Age and rates do not change.
configuration.nextRenewalDatestringEffective date of coverage for next annual open enrollment.
configuration.carrierPlanCodestringSpecifies a plan code assigned by the carrier to identify a plan. This value would be returned with the enrollment record.
configuration.carrierPlanTypeCodestringSpecifies a plan code assigned by the carrier to identify the plan type. This value would be returned with the enrollment record.
configuration.planBillOptionstringUnspecified, SelfBill, ListBill
configuration.isSelfFundedboolean
configuration.situsStatestringThe state in which the legal, organizational entity exists or originated. Send the State Name or the 2-character ISO abbreviation. Either value will be accepted.
configuration.benefitstring✓Medical, Dental, Vision, Life, ADAndD, VoluntaryLife, VoluntaryADAndD, ShortTermDisability, VoluntaryShortTermDisability, LongTermDisability, VoluntaryLongTermDisability, Prescription, CriticalIllness, HospitalIndemnity, PermanentLife, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Cancer, Telemedicine
configuration.originalPlanStartDatestringDate the plan initially began between the carrier and group.
configuration.carrierPlanTypeDescriptionstringA carrier-defined standardized description that categorizes plans based on common characteristics. For example, medical plans may be categorized as HMO, PPO, etc.; dental plans as DHMO, etc. Note that this description is limited to 150 characters.
(root)
planDependenciesGroupADAndD.GroupADAndDPlanDependencies
planDependencies
planDependencies.benefitEnrollmentDependencyGroupADAndD.GroupADAndDPlanBenefitEnrollmentDependency
planDependencies.benefitEnrollmentDependency.enrollmentBenefitstring✓The pre-defined benefit category a plan may be dependent upon. · Life
(root)
eligibilityOptionsarray of PlanEligibilityOptions
eligibilityOptions
eligibilityOptions.groupStructurePlanEligibilityGroupStructure
eligibilityOptions.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.eligibilityRulesPlanEligibilityRules
eligibilityOptions.eligibilityRules.waitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.waitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.waitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.entryDateRulestringUsed in conjunction with Waiting Period to define when the coverage is effective after the waiting period for a new employee. Use First of the Month Coinciding With or After rule when waiting period ending on the first of the month has entry on that day. Use First of the Month After when waiting period ending on the first of the month has entry on the first of the next month. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.terminationRulestringUsed to define the last day of coverage on loss of eligibility. · Unspecified, EndOfMonthOfTermination, EmploymentTermination, FirstOfMonthAfterEmploymentTermination
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationinteger
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehirePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.rehirePeriod.durationinteger
eligibilityOptions.eligibilityRules.rehirePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehireEntryDateRulestringUsed in conjunction with Rehire Period to define when coverage is effective after rehire date for employees rehired within the rehire period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.eligibilityChangeEntryDateRulestringUsed in conjunction with Eligibility Change Waiting Period to define when the coverage is effective after the employee becomes eligible after a classification change and completes waiting period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
(root)
planCommunicationsPlanCommunications
planCommunications
planCommunications.marketingDescriptionstringCustomizes the employee enrollment experience with marketing information about the benefits of the plan.
planCommunications.benefitSummaryUrlstringCustomizes the employee enrollment experience with a URL hosting the benefit summary.
(root)
optionsGroupLife.OptionsType
options
options.employeeOptionsEmployeePlanOptions
options.employeeOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
options.employeeOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
options.employeeOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
options.supplementalOptionsGroupLife.SupplementalOptions
options.supplementalOptions.captureBeneficiaryboolean
(root)
benefitsarray of GroupADAndD.Benefit
benefits
benefits.groupStructurePlanEligibilityGroupStructure
benefits.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.optionsGroupLife.BenefitOptions
benefits.options.salaryRedeterminationOnstringSpecifies when salary changes update benefit amount. · Unspecified, FirstOfFollowingMonth, FirstOfSpecifiedMonth, DayOfChange
benefits.options.salaryRedeterminationMonthstringIdentifies the month when salary changes are to be applied when salary redetermination option is specified as FirstOfSpecfiedMonth. If used in conjunction with ageBandChangesMonth, that value will drive both age and salary changes. · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
benefits.options.ageReductionOptionsGroupLife.AgeReductionOptions
benefits.options.ageReductionOptions.ageReductionsBasedOnPreviousBenefitbooleanChoose this when the percent of reduction is based on the latest benefit, which may have already been reduced. Do not choose this when the percent of reduction is based on the original benefit amount.
benefits.options.ageReductionOptions.ageReductionReduceOnstringSpecifies when to apply reduction age band changes · Unspecified, FirstOfMonthFollowing, FirstOfSpecifiedMonth, Birthday
benefits.options.ageReductionOptions.ageReductionChangeMonthstringIdentifies the month when to apply reductions when the AgeReductionReduceOn option is specified as FirstOfSpecifiedMonth · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
benefits.options.ageReductionOptions.roundingTypestringUsed in conjunction with roundingIncrement, rounding method used for age-reduced benefit. · Unspecified, Up, Down, Nearest
benefits.options.ageReductionOptions.roundingIncrementstringUsed in conjunction with roundingType, specifies to what closest increment the reduced benefit amount should be rounded. · Unspecified, OneThousandDollars, OneHundredDollars, TenDollars, OneDollar, FiftyDollars, OneCent, FiveHundredDollars, FiveThousandDollars, TenThousandDollars
benefits.options.autoEnrollAllEligibleEmployeesbooleanAn indicator to auto create enrollment records - sometimes referred to as census enrollment - for employees who are eligible but not yet enrolled for products that are non-contributory and do not require an employee to make an election.
benefits.options.requiresEmployeeEnrollmentbooleanIndicates that any employee, even those added in the future (new hires/newly eligible), must enroll into the plan when this field is set to true. For non-contributory employer paid plans, be sure and set this field to true the underwriters / actuaries set a rate based on the risk associated with both employees and dependents being enrolled.
benefits.employeeGroupLife.EmployeeBenefit
benefits.employee.benefitClassCodestringCarrier code assigned to the employee benefit class. Commonly used when carrier assigns different codes for employee, spouse, and child benefits.
benefits.employee.benefitDescriptionstringOptional benefit description assigned by the carrier describing the benefit.
benefits.employee.flatBenefitGroupLife.FlatBenefitType
benefits.employee.flatBenefit.amountnumberBenefit amount
benefits.employee.multipleOfEarningsBenefitGroupLife.MultipleEarningsType
benefits.employee.multipleOfEarningsBenefit.multipleOfEarningsnumberThe highest multiplier to be applied to an employee's earnings. For example, if the plan supports 1X, 2X, or 3X earnings, then set the multipleOfEarnings field value to 3.
benefits.employee.multipleOfEarningsBenefit.minimumBenefitnumberMinimum benefit amount
benefits.employee.multipleOfEarningsBenefit.maximumBenefitnumberMaximum benefit amount
benefits.employee.multipleOfEarningsBenefit.roundingTypestringUsed in conjunction with RoundingIncrement, rounding method for multiple of earnings. · Unspecified, Up, Down, Nearest
benefits.employee.multipleOfEarningsBenefit.roundingIncrementstringUsed in conjunction with RoundingType to designate rounding specificity. · Unspecified, OneThousandDollars, OneHundredDollars, TenDollars, OneDollar, FiftyDollars, OneCent, FiveHundredDollars, FiveThousandDollars, TenThousandDollars
benefits.employee.multipleOfEarningsBenefit.benefitAmountAdjustmentnumberThe flat amount to be added to or subtracted from the employee’s multiple earnings benefits. For added to the amount should be a positive amount and subtracted from the amount should be a negative amount.
benefits.employee.ageReductionsGroupLife.AgeReductions
benefits.employee.ageReductions.reductionsarray of BenefitReductionSchedule of reductions as a percent of benefit which occur upon attaining a specific age.
benefits.employee.ageReductions.reductions.atAgeinteger✓Age benefit is reduced.
benefits.employee.ageReductions.reductions.reducedByPercentnumber✓Amount benefit is reduced by as a percent. Not an amount reduced to.
benefits.detailsGroupLife.BenefitDetails
benefits.details.conditionsOrExclusionsstringDescribes the details and definition of any pre-existing condition exclusions which may impose limitations on benefit payment.
(root)
guaranteedIssueGroupLife.GuaranteedIssueType
guaranteedIssue
guaranteedIssue.requiresEvidenceOfInsurabilitybooleanPlan has a guaranteed issue benefit and offers additional coverage upon meeting evidence of insurability underwriting requirements.
guaranteedIssue.employeeGroupLife.GuaranteedIssueEmployeeOptions
guaranteedIssue.employee.initialAmountGroupLife.GuaranteedIssueAmountType
guaranteedIssue.employee.initialAmount.amountnumberFlat amount
guaranteedIssue.employee.initialAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.lateEntrantAmountGroupLife.GuaranteedIssueAmountType
guaranteedIssue.employee.lateEntrantAmount.amountnumberFlat amount
guaranteedIssue.employee.lateEntrantAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.existingAmountGroupLife.GuaranteedIssueExistingType
guaranteedIssue.employee.existingAmount.flatAmountGroupLife.GuaranteedIssueAmountType
guaranteedIssue.employee.existingAmount.flatAmount.amountnumberFlat amount
guaranteedIssue.employee.existingAmount.flatAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.existingAmount.increaseAmountGroupLife.GuaranteedIssueIncreaseAmountType
guaranteedIssue.employee.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
guaranteedIssue.employee.existingAmount.increaseAmount.maximumAmountnumberUsed in conjunction with IncreaseBy amount, an optional maximum flat amount serving as a guaranteed issue limit.
guaranteedIssue.employee.reductionsGroupLife.GuaranteedIssueReductions
guaranteedIssue.employee.reductions.reductionAmountsarray of GroupLife.GuaranteedIssueReduction
guaranteedIssue.employee.reductions.reductionAmounts.atAgeinteger✓Age benefit is reduced.
guaranteedIssue.employee.reductions.reductionAmounts.amountnumber✓Amount guaranteed issue is reduced to.
(root)
ratesGroupADAndD.Rating
rates
rates.optionsGroupLife.RateOptions
rates.options.annualPolicyFeenumberAn annual fee added to the total cost for each policy. Annual fee is applied to both the employee and the spouse policy.
rates.bandedRatesGroupLife.BandedRating
rates.bandedRates.genderBasedRatesGenderBasedRates
rates.bandedRates.genderBasedRates.rateMalenumber✓
rates.bandedRates.genderBasedRates.rateFemalenumber✓
rates.bandedRates.tobaccoBasedRatesTobaccoBasedRates
rates.bandedRates.tobaccoBasedRates.rateNonsmokernumber✓
rates.bandedRates.tobaccoBasedRates.rateSmokernumber✓
rates.bandedRates.genderAndTobaccoBasedRatesGenderAndTobaccoBasedRates
rates.bandedRates.genderAndTobaccoBasedRates.rateMaleNonsmokernumber✓
rates.bandedRates.genderAndTobaccoBasedRates.rateFemaleNonsmokernumber✓
rates.bandedRates.genderAndTobaccoBasedRates.rateMaleSmokernumber✓
rates.bandedRates.genderAndTobaccoBasedRates.rateFemaleSmokernumber✓
rates.compositeRateGroupLife.CompositeRating
rates.compositeRate.ratenumber✓
(root)
contributionsGroupADAndD.Contribution
contributions
contributions.contributionGroupingsarray of GroupADAndD.ContributionGrouping✓A list of monthly contributions by a specified contribution grouping (e.g., everyone, by class, by department).
contributions.contributionGroupings.contributionGroupingBasedOnstringThe textual description of what the specified contribution grouping is based on.
contributions.contributionGroupings.monthlyContributionsGroupADAndD.MonthlyContribution✓
contributions.contributionGroupings.monthlyContributions.contributionBasisstring✓Defines whether the contribution is based on what the employee or employer will pay to cover the cost of the plan. · Unspecified, Employer, Employee
contributions.contributionGroupings.monthlyContributions.contributionTypestring✓Defines whether the contribution is represented as a percent or a flat dollar amount. · Unspecified, Percentage, BenefitAmount
contributions.contributionGroupings.monthlyContributions.contributionnumber✓The actual amount or percent that an employee or employee will pay to cover the cost of the plan.
EN Voluntary AD&D fields   212 fields   EN schema VoluntaryADAndDPlan · POST /Quoting/companies/{companyId}/plans/voluntaryadandd/notification
— / —
EN field pathTypeReqDescription / enum
(root)
planIdentifierstring✓The unique identifier assigned for the purpose of identifying a plan. This value is the key used to link a plan between the two systems and how we will communicate about the plan. A plan is a set of benefit of rates and should not include billing groups.
configurationPlanConfiguration✓
configuration
configuration.policyNumberstringValue assigned to the plan for the specific company
configuration.carrierNamestring
configuration.planNamestring
configuration.startDatestring✓Effective date representing the most recent plan year start date for the current set of benefits and rates. Our plans couple benefits and rates together.
configuration.endDatestringEffective date representing the plan year end date for the current set of benefits and rates. Typically plans are 12-month plan years, unless policy is Issue Age and rates do not change.
configuration.nextRenewalDatestringEffective date of coverage for next annual open enrollment.
configuration.carrierPlanCodestringSpecifies a plan code assigned by the carrier to identify a plan. This value would be returned with the enrollment record.
configuration.carrierPlanTypeCodestringSpecifies a plan code assigned by the carrier to identify the plan type. This value would be returned with the enrollment record.
configuration.planBillOptionstringUnspecified, SelfBill, ListBill
configuration.isSelfFundedboolean
configuration.situsStatestringThe state in which the legal, organizational entity exists or originated. Send the State Name or the 2-character ISO abbreviation. Either value will be accepted.
configuration.benefitstring✓Medical, Dental, Vision, Life, ADAndD, VoluntaryLife, VoluntaryADAndD, ShortTermDisability, VoluntaryShortTermDisability, LongTermDisability, VoluntaryLongTermDisability, Prescription, CriticalIllness, HospitalIndemnity, PermanentLife, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Cancer, Telemedicine
configuration.originalPlanStartDatestringDate the plan initially began between the carrier and group.
configuration.carrierPlanTypeDescriptionstringA carrier-defined standardized description that categorizes plans based on common characteristics. For example, medical plans may be categorized as HMO, PPO, etc.; dental plans as DHMO, etc. Note that this description is limited to 150 characters.
(root)
planDependenciesVoluntaryADandD.VoluntaryADandDPlanDependencies
planDependencies
planDependencies.benefitEnrollmentDependencyVoluntaryADandD.VoluntaryADandDPlanBenefitEnrollmentDependency
planDependencies.benefitEnrollmentDependency.enrollmentBenefitstring✓The pre-defined benefit category a plan may be dependent upon. · VoluntaryLife
(root)
eligibilityOptionsarray of PlanEligibilityOptions
eligibilityOptions
eligibilityOptions.groupStructurePlanEligibilityGroupStructure
eligibilityOptions.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.eligibilityRulesPlanEligibilityRules
eligibilityOptions.eligibilityRules.waitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.waitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.waitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.entryDateRulestringUsed in conjunction with Waiting Period to define when the coverage is effective after the waiting period for a new employee. Use First of the Month Coinciding With or After rule when waiting period ending on the first of the month has entry on that day. Use First of the Month After when waiting period ending on the first of the month has entry on the first of the next month. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.terminationRulestringUsed to define the last day of coverage on loss of eligibility. · Unspecified, EndOfMonthOfTermination, EmploymentTermination, FirstOfMonthAfterEmploymentTermination
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationinteger
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehirePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.rehirePeriod.durationinteger
eligibilityOptions.eligibilityRules.rehirePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehireEntryDateRulestringUsed in conjunction with Rehire Period to define when coverage is effective after rehire date for employees rehired within the rehire period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.eligibilityChangeEntryDateRulestringUsed in conjunction with Eligibility Change Waiting Period to define when the coverage is effective after the employee becomes eligible after a classification change and completes waiting period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
(root)
planCommunicationsPlanCommunications
planCommunications
planCommunications.marketingDescriptionstringCustomizes the employee enrollment experience with marketing information about the benefits of the plan.
planCommunications.benefitSummaryUrlstringCustomizes the employee enrollment experience with a URL hosting the benefit summary.
(root)
optionsVoluntaryLife.OptionsType
options
options.employeeOptionsVoluntaryLife.EmployeePlanOptions
options.employeeOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
options.employeeOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
options.employeeOptions.initialEntrantGracePeriodintegerThe length of time an employee has to enroll after their eligibility date for their original eligible entry date to be honored. E.g. If an employee is eligible on 10/1 and enrolls on 10/13, a 30-day grace period would honor 10/1 as their coverage start date. If no grace period is specified, the employee’s coverage will begin on the date of enrollment, 10/13.
options.employeeOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
options.supplementalOptionsVoluntaryLife.SupplementalOptions
options.supplementalOptions.captureBeneficiarybooleanSpecifies that beneficiary designation should be collected upon enrollment.
(root)
dependentOptionsVoluntaryLife.DependentOptionsType
dependentOptions
dependentOptions.spouseOptionsVoluntaryLife.DependentSpouseOptionsType
dependentOptions.spouseOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
dependentOptions.spouseOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
dependentOptions.spouseOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
dependentOptions.childOptionsVoluntaryLife.DependentChildOptionsType
dependentOptions.childOptions.ageIneligibleintegerAge non-student dependent child is no longer eligible.
dependentOptions.childOptions.studentAgeIneligibleintegerAge student child is no longer eligible to be covered under the plan.
dependentOptions.childOptions.dropOverageChildOnstringUsed in conjunction with AgeIneligible and StudentAgeIneligible, specifies the last day of coverage when a child becomes ineligible due to age. · Unspecified, EndOfMonth, Birthday, EndOfPlan, EndOfCalendarYear
dependentOptions.childOptions.minimumAgeintegerAge dependent child is too young to be covered under benefit.
dependentOptions.childOptions.minimumAgeTypestringUsed in conjunction with minimumAge, specifies how minimumAge is measured. · Unspecified, Days, Months, Years
(root)
benefitsarray of VoluntaryLife.Benefit
benefits
benefits.groupStructurePlanEligibilityGroupStructure
benefits.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.optionsVoluntaryLife.BenefitOptions
benefits.options.ageReductionOptionsVoluntaryLife.AgeReductionOptions
benefits.options.ageReductionOptions.ageReductionsBasedOnPreviousBenefitbooleanChoose this when the percent of reduction is based on the latest benefit, which may have already been reduced. Do not choose this when the percent of reduction is based on the original benefit amount.
benefits.options.ageReductionOptions.ageReductionReduceOnstringSpecifies when to apply reduction age band changes · Unspecified, FirstOfMonthFollowing, FirstOfSpecifiedMonth, Birthday
benefits.options.ageReductionOptions.ageReductionChangeMonthstringIdentifies the month when to apply reductions when the AgeReductionReduceOn option is specified as FirstOfSpecifiedMonth · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
benefits.options.ageReductionOptions.roundingTypestringUsed in conjunction with roundingIncrement, rounding method used for age-reduced benefit. · Unspecified, Up, Down, Nearest
benefits.options.ageReductionOptions.roundingIncrementstringUsed in conjunction with roundingType, specifies to what closest increment the reduced benefit amount should be rounded. · Unspecified, OneThousandDollars, OneHundredDollars, TenDollars, OneDollar, FiftyDollars, OneCent, FiveHundredDollars, FiveThousandDollars, TenThousandDollars
benefits.employeeVoluntaryLife.EmployeeBenefit
benefits.employee.benefitClassCodestringCarrier code assigned to the employee benefit class. Commonly used when carrier assigns different codes for employee, spouse, and child benefits.
benefits.employee.benefitDescriptionstringOptional benefit description assigned by the carrier describing the benefit.
benefits.employee.multiplesOfEarningsBenefitVoluntaryLife.MultiplesOfEarningsType
benefits.employee.multiplesOfEarningsBenefit.multiplesOfEarningsnumberThe highest multiplier to be applied to an employee's earnings. For example, if the plan supports 1X, 2X, or 3X earnings, then set the multipleOfEarnings field value to 3.
benefits.employee.multiplesOfEarningsBenefit.minimumBenefitnumberMinimum benefit amount
benefits.employee.multiplesOfEarningsBenefit.maximumBenefitnumberMaximum benefit amount
benefits.employee.multiplesOfEarningsBenefit.roundingTypestringRounding method for multiple of earnings in thousands. · Unspecified, Up, Down, Nearest
benefits.employee.incrementsBenefitVoluntaryLife.IncrementsMultipleEarningsMaximumType
benefits.employee.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.employee.incrementsBenefit.maximumMultipleOfEarningsnumberMaximum benefit amount as a multiple of earnings
benefits.employee.incrementsBenefit.roundingTypestringRounding method for maximum multiple of earnings in thousands. · Unspecified, Up, Down
benefits.employee.ageReductionsVoluntaryLife.AgeReductions
benefits.employee.ageReductions.reductionsarray of BenefitReductionSchedule of reductions as a percent of benefit which occur upon attaining a specific age.
benefits.employee.ageReductions.reductions.atAgeinteger✓Age benefit is reduced.
benefits.employee.ageReductions.reductions.reducedByPercentnumber✓Amount benefit is reduced by as a percent. Not an amount reduced to.
benefits.spouseVoluntaryLife.SpouseBenefit
benefits.spouse.benefitClassCodestringCarrier code assigned to the spouse benefit class. Commonly used when carrier assigns different codes for employee, spouse, and child benefits
benefits.spouse.benefitDescriptionstringOptional benefit description assigned by the carrier describing the spouse benefit.
benefits.spouse.incrementsBenefitVoluntaryLife.IncrementsMaxPercentEmployeeType
benefits.spouse.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.spouse.incrementsBenefit.maximumPercentOfEmployeeElectionintegerMaximum benefit as a percent of employee benefit amount.
benefits.spouse.percentBenefitVoluntaryLife.PercentOfEmployeeBenefitType
benefits.spouse.percentBenefit.percentOfEmployeeElectionnumberBenefit as a percent of employee election.
benefits.spouse.percentBenefit.minimumBenefitnumberMinimum benefit amount
benefits.spouse.percentBenefit.maximumBenefitnumberMaximum benefit amount
benefits.spouse.ageReductionsVoluntaryLife.AgeReductions
benefits.spouse.ageReductions.reductionsarray of BenefitReductionSchedule of reductions as a percent of benefit which occur upon attaining a specific age.
benefits.spouse.ageReductions.reductions.atAgeinteger✓Age benefit is reduced.
benefits.spouse.ageReductions.reductions.reducedByPercentnumber✓Amount benefit is reduced by as a percent. Not an amount reduced to.
benefits.spouse.optionsVoluntaryLife.SpouseBenefitOptions
benefits.spouse.options.spouseReductionsBasedOnEmployeeAgebooleanWhen benefits are reduced based on age, this determines when spouse benefit reductions are calculated based on the employee age.
benefits.childVoluntaryLife.ChildBenefit
benefits.child.benefitClassCodestringCarrier code assigned to the child benefit class. Commonly used when carrier assigns different codes for employee, spouse, and child benefits.
benefits.child.benefitDescriptionstringOptional benefit description assigned by the carrier describing the child benefit.
benefits.child.incrementsBenefitVoluntaryLife.IncrementsMaxPercentEmployeeType
benefits.child.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.child.incrementsBenefit.maximumPercentOfEmployeeElectionintegerMaximum benefit as a percent of employee benefit amount.
benefits.child.percentBenefitVoluntaryLife.PercentOfEmployeeBenefitType
benefits.child.percentBenefit.percentOfEmployeeElectionnumberBenefit as a percent of employee election.
benefits.child.percentBenefit.minimumBenefitnumberMinimum benefit amount
benefits.child.percentBenefit.maximumBenefitnumberMaximum benefit amount
benefits.child.flatBenefitVoluntaryLife.FlatAmountType
benefits.child.flatBenefit.amountnumberBenefit amount
benefits.detailsVoluntaryLife.BenefitDetails
benefits.details.conditionsOrExclusionsstringDescribes the details and definition of any pre-existing condition exclusions which may impose limitations on benefit payment.
(root)
guaranteedIssueVoluntaryLife.GuaranteedIssueType
guaranteedIssue
guaranteedIssue.employeeVoluntaryLife.GuaranteedIssueEmployeeOptions
guaranteedIssue.employee.initialAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.employee.initialAmount.amountnumberFlat amount
guaranteedIssue.employee.initialAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.lateEntrantAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.employee.lateEntrantAmount.amountnumberFlat amount
guaranteedIssue.employee.lateEntrantAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.existingAmountVoluntaryLife.GuaranteedIssueExistingType
guaranteedIssue.employee.existingAmount.flatAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.employee.existingAmount.flatAmount.amountnumberFlat amount
guaranteedIssue.employee.existingAmount.flatAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.existingAmount.increaseAmountVoluntaryLife.GuaranteedIssueIncreaseAmountType
guaranteedIssue.employee.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
guaranteedIssue.employee.existingAmount.increaseAmount.maximumAmountnumberUsed in conjunction with IncreaseBy amount, an optional maximum flat amount serving as a guaranteed issue limit.
guaranteedIssue.employee.reductionsVoluntaryLife.GuaranteedIssueReductions
guaranteedIssue.employee.reductions.reductionAmountsarray of VoluntaryLife.GuaranteedIssueReduction
guaranteedIssue.employee.reductions.reductionAmounts.atAgeinteger✓Age benefit is reduced.
guaranteedIssue.employee.reductions.reductionAmounts.amountnumber✓Amount guaranteed issue is reduced to.
guaranteedIssue.spouseVoluntaryLife.GuaranteedIssueSpouseOptions
guaranteedIssue.spouse.initialAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.spouse.initialAmount.amountnumberFlat amount
guaranteedIssue.spouse.initialAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.spouse.lateEntrantAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.spouse.lateEntrantAmount.amountnumberFlat amount
guaranteedIssue.spouse.lateEntrantAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.spouse.existingAmountVoluntaryLife.GuaranteedIssueExistingType
guaranteedIssue.spouse.existingAmount.flatAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.spouse.existingAmount.flatAmount.amountnumberFlat amount
guaranteedIssue.spouse.existingAmount.flatAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.spouse.existingAmount.increaseAmountVoluntaryLife.GuaranteedIssueIncreaseAmountType
guaranteedIssue.spouse.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
guaranteedIssue.spouse.existingAmount.increaseAmount.maximumAmountnumberUsed in conjunction with IncreaseBy amount, an optional maximum flat amount serving as a guaranteed issue limit.
guaranteedIssue.spouse.reductionsVoluntaryLife.GuaranteedIssueReductions
guaranteedIssue.spouse.reductions.reductionAmountsarray of VoluntaryLife.GuaranteedIssueReduction
guaranteedIssue.spouse.reductions.reductionAmounts.atAgeinteger✓Age benefit is reduced.
guaranteedIssue.spouse.reductions.reductionAmounts.amountnumber✓Amount guaranteed issue is reduced to.
guaranteedIssue.childVoluntaryLife.GuaranteedIssueChildOptions
guaranteedIssue.child.initialAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.child.initialAmount.amountnumberFlat amount
guaranteedIssue.child.initialAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.child.lateEntrantAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.child.lateEntrantAmount.amountnumberFlat amount
guaranteedIssue.child.lateEntrantAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.child.existingAmountVoluntaryLife.GuaranteedIssueExistingType
guaranteedIssue.child.existingAmount.flatAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.child.existingAmount.flatAmount.amountnumberFlat amount
guaranteedIssue.child.existingAmount.flatAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.child.existingAmount.increaseAmountVoluntaryLife.GuaranteedIssueIncreaseAmountType
guaranteedIssue.child.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
guaranteedIssue.child.existingAmount.increaseAmount.maximumAmountnumberUsed in conjunction with IncreaseBy amount, an optional maximum flat amount serving as a guaranteed issue limit.
guaranteedIssue.requiresEvidenceOfInsurabilitybooleanPlan has a guaranteed issue benefit and offers additional coverage upon meeting evidence of insurability underwriting requirements.
(root)
ratesVoluntaryLife.VolADAndDRating
rates
rates.optionsVoluntaryLife.RateInitialEntrantAgeOptionsVolADAndDRateOptionsType
rates.options.annualPolicyFeenumberAn annual fee added to the total cost for each policy. Annual fee is applied to both the employee and the spouse policy.
rates.options.rateInitialEntrantAgeOnstringRate initial entrant according to age on selected option. · Unspecified, CalculatedEligibilityDate, PriorPolicyAnniversary
rates.options.ageBandChangeUpdateOnstringSpecifies when to update rate upon age band change. · Unspecified, FirstOfMonthFollowing, FirstOfSpecifiedMonth, Birthday
rates.options.ageBandChangesMonthstringIdentifies the month when rate changes are to be applied when the age band change option is specified as FirstOfSpecifiedMonth. · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
rates.employeeVoluntaryLife.VolADAndDEmployeeRating
rates.employee.compositeRatesVoluntaryLife.CompositeRating
rates.employee.compositeRates.tierRatesarray of VoluntaryLife.CompositeRateType
rates.employee.compositeRates.tierRates.tierstring✓Unspecified, Employee, EmployeePlusFamily
rates.employee.compositeRates.tierRates.ratenumber✓Monthly rate
rates.employee.ageBasedRatesVoluntaryLife.VolADAndDAgeBasedRating
rates.employee.ageBasedRates.ratesarray of AgeBandedRateProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.employee.ageBasedRates.rates.fromAgeinteger✓
rates.employee.ageBasedRates.rates.toAgeinteger✓
rates.employee.ageBasedRates.rates.ratenumber✓
rates.spouseVoluntaryLife.VolADAndDSpouseRating
rates.spouse.ageBasedRatesVoluntaryLife.VolADAndDSpouseAgeBasedRating
rates.spouse.ageBasedRates.optionsVoluntaryLife.SpouseAgeBasedOptionsType
rates.spouse.ageBasedRates.options.spouseRatedOnEmployeeAgebooleanWhen rates are based on age, this determines when spouse rates are calculated based on the employee age.
rates.spouse.ageBasedRates.ratesarray of AgeBandedRateProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.spouse.ageBasedRates.rates.fromAgeinteger✓
rates.spouse.ageBasedRates.rates.toAgeinteger✓
rates.spouse.ageBasedRates.rates.ratenumber✓
rates.childVoluntaryLife.ChildRating
rates.child.optionsVoluntaryLife.ChildRateOptionsType
rates.child.options.childRatesBasedOnAllChildrenbooleanThis specifies when the same rate is applied regardless of the number of covered children. When each child is assessed their own rates, the plan does not use All Children rates.
rates.child.flatRateVoluntaryLife.ChildFlatRating
rates.child.flatRate.ratenumber
rates.child.benefitBasedRatesVoluntaryLife.ChildBenefitBasedRating
rates.child.benefitBasedRates.ratesarray of VoluntaryLife.ChildBenefitRateType
rates.child.benefitBasedRates.rates.benefitIncrementnumber✓
rates.child.benefitBasedRates.rates.ratenumber✓
(root)
contributionsVoluntaryLife.Contribution
contributions
contributions.contributionGroupingsarray of VoluntaryLife.ContributionGrouping✓A list of monthly contributions by a specified contribution grouping (e.g., everyone, by class, by department).
contributions.contributionGroupings.contributionGroupingBasedOnstringThe textual description of what the specified contribution grouping is based on.
contributions.contributionGroupings.monthlyContributionsarray of VoluntaryLife.MonthlyContributions✓A list of the monthly plan contributions.
contributions.contributionGroupings.monthlyContributions.memberTypestring✓Defines the universal level of member types covered by the plan based on the selected plan benefit type. · Unspecified, Employee, Spouse, Child
contributions.contributionGroupings.monthlyContributions.contributionBasisstring✓Defines whether the contribution is based on what the employee or employer will pay to cover the cost of the plan. · Unspecified, Employer, Employee
contributions.contributionGroupings.monthlyContributions.contributionTypestring✓Defines whether the contribution is represented as a percent or a flat dollar amount. · Unspecified, Percentage, BenefitAmount
contributions.contributionGroupings.monthlyContributions.contributionnumber✓The actual amount or percent that an employee or employee will pay to cover the cost of the plan.
EN Voluntary Life fields   228 fields   EN schema VoluntaryLifePlan · POST /Quoting/companies/{companyId}/plans/voluntarylife/notification
— / —
EN field pathTypeReqDescription / enum
(root)
planIdentifierstring✓The unique identifier assigned for the purpose of identifying a plan. This value is the key used to link a plan between the two systems and how we will communicate about the plan. A plan is a set of benefit of rates and should not include billing groups.
configurationPlanConfiguration✓
configuration
configuration.policyNumberstringValue assigned to the plan for the specific company
configuration.carrierNamestring
configuration.planNamestring
configuration.startDatestring✓Effective date representing the most recent plan year start date for the current set of benefits and rates. Our plans couple benefits and rates together.
configuration.endDatestringEffective date representing the plan year end date for the current set of benefits and rates. Typically plans are 12-month plan years, unless policy is Issue Age and rates do not change.
configuration.nextRenewalDatestringEffective date of coverage for next annual open enrollment.
configuration.carrierPlanCodestringSpecifies a plan code assigned by the carrier to identify a plan. This value would be returned with the enrollment record.
configuration.carrierPlanTypeCodestringSpecifies a plan code assigned by the carrier to identify the plan type. This value would be returned with the enrollment record.
configuration.planBillOptionstringUnspecified, SelfBill, ListBill
configuration.isSelfFundedboolean
configuration.situsStatestringThe state in which the legal, organizational entity exists or originated. Send the State Name or the 2-character ISO abbreviation. Either value will be accepted.
configuration.benefitstring✓Medical, Dental, Vision, Life, ADAndD, VoluntaryLife, VoluntaryADAndD, ShortTermDisability, VoluntaryShortTermDisability, LongTermDisability, VoluntaryLongTermDisability, Prescription, CriticalIllness, HospitalIndemnity, PermanentLife, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Cancer, Telemedicine
configuration.originalPlanStartDatestringDate the plan initially began between the carrier and group.
configuration.carrierPlanTypeDescriptionstringA carrier-defined standardized description that categorizes plans based on common characteristics. For example, medical plans may be categorized as HMO, PPO, etc.; dental plans as DHMO, etc. Note that this description is limited to 150 characters.
(root)
eligibilityOptionsarray of PlanEligibilityOptions
eligibilityOptions
eligibilityOptions.groupStructurePlanEligibilityGroupStructure
eligibilityOptions.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.eligibilityRulesPlanEligibilityRules
eligibilityOptions.eligibilityRules.waitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.waitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.waitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.entryDateRulestringUsed in conjunction with Waiting Period to define when the coverage is effective after the waiting period for a new employee. Use First of the Month Coinciding With or After rule when waiting period ending on the first of the month has entry on that day. Use First of the Month After when waiting period ending on the first of the month has entry on the first of the next month. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.terminationRulestringUsed to define the last day of coverage on loss of eligibility. · Unspecified, EndOfMonthOfTermination, EmploymentTermination, FirstOfMonthAfterEmploymentTermination
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationinteger
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehirePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.rehirePeriod.durationinteger
eligibilityOptions.eligibilityRules.rehirePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehireEntryDateRulestringUsed in conjunction with Rehire Period to define when coverage is effective after rehire date for employees rehired within the rehire period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.eligibilityChangeEntryDateRulestringUsed in conjunction with Eligibility Change Waiting Period to define when the coverage is effective after the employee becomes eligible after a classification change and completes waiting period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
(root)
planCommunicationsPlanCommunications
planCommunications
planCommunications.marketingDescriptionstringCustomizes the employee enrollment experience with marketing information about the benefits of the plan.
planCommunications.benefitSummaryUrlstringCustomizes the employee enrollment experience with a URL hosting the benefit summary.
(root)
optionsVoluntaryLife.OptionsType
options
options.employeeOptionsVoluntaryLife.EmployeePlanOptions
options.employeeOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
options.employeeOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
options.employeeOptions.initialEntrantGracePeriodintegerThe length of time an employee has to enroll after their eligibility date for their original eligible entry date to be honored. E.g. If an employee is eligible on 10/1 and enrolls on 10/13, a 30-day grace period would honor 10/1 as their coverage start date. If no grace period is specified, the employee’s coverage will begin on the date of enrollment, 10/13.
options.employeeOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
options.supplementalOptionsVoluntaryLife.SupplementalOptions
options.supplementalOptions.captureBeneficiarybooleanSpecifies that beneficiary designation should be collected upon enrollment.
(root)
dependentOptionsVoluntaryLife.DependentOptionsType
dependentOptions
dependentOptions.spouseOptionsVoluntaryLife.DependentSpouseOptionsType
dependentOptions.spouseOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
dependentOptions.spouseOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
dependentOptions.spouseOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
dependentOptions.childOptionsVoluntaryLife.DependentChildOptionsType
dependentOptions.childOptions.ageIneligibleintegerAge non-student dependent child is no longer eligible.
dependentOptions.childOptions.studentAgeIneligibleintegerAge student child is no longer eligible to be covered under the plan.
dependentOptions.childOptions.dropOverageChildOnstringUsed in conjunction with AgeIneligible and StudentAgeIneligible, specifies the last day of coverage when a child becomes ineligible due to age. · Unspecified, EndOfMonth, Birthday, EndOfPlan, EndOfCalendarYear
dependentOptions.childOptions.minimumAgeintegerAge dependent child is too young to be covered under benefit.
dependentOptions.childOptions.minimumAgeTypestringUsed in conjunction with minimumAge, specifies how minimumAge is measured. · Unspecified, Days, Months, Years
(root)
benefitsarray of VoluntaryLife.Benefit
benefits
benefits.groupStructurePlanEligibilityGroupStructure
benefits.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.optionsVoluntaryLife.BenefitOptions
benefits.options.ageReductionOptionsVoluntaryLife.AgeReductionOptions
benefits.options.ageReductionOptions.ageReductionsBasedOnPreviousBenefitbooleanChoose this when the percent of reduction is based on the latest benefit, which may have already been reduced. Do not choose this when the percent of reduction is based on the original benefit amount.
benefits.options.ageReductionOptions.ageReductionReduceOnstringSpecifies when to apply reduction age band changes · Unspecified, FirstOfMonthFollowing, FirstOfSpecifiedMonth, Birthday
benefits.options.ageReductionOptions.ageReductionChangeMonthstringIdentifies the month when to apply reductions when the AgeReductionReduceOn option is specified as FirstOfSpecifiedMonth · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
benefits.options.ageReductionOptions.roundingTypestringUsed in conjunction with roundingIncrement, rounding method used for age-reduced benefit. · Unspecified, Up, Down, Nearest
benefits.options.ageReductionOptions.roundingIncrementstringUsed in conjunction with roundingType, specifies to what closest increment the reduced benefit amount should be rounded. · Unspecified, OneThousandDollars, OneHundredDollars, TenDollars, OneDollar, FiftyDollars, OneCent, FiveHundredDollars, FiveThousandDollars, TenThousandDollars
benefits.employeeVoluntaryLife.EmployeeBenefit
benefits.employee.benefitClassCodestringCarrier code assigned to the employee benefit class. Commonly used when carrier assigns different codes for employee, spouse, and child benefits.
benefits.employee.benefitDescriptionstringOptional benefit description assigned by the carrier describing the benefit.
benefits.employee.multiplesOfEarningsBenefitVoluntaryLife.MultiplesOfEarningsType
benefits.employee.multiplesOfEarningsBenefit.multiplesOfEarningsnumberThe highest multiplier to be applied to an employee's earnings. For example, if the plan supports 1X, 2X, or 3X earnings, then set the multipleOfEarnings field value to 3.
benefits.employee.multiplesOfEarningsBenefit.minimumBenefitnumberMinimum benefit amount
benefits.employee.multiplesOfEarningsBenefit.maximumBenefitnumberMaximum benefit amount
benefits.employee.multiplesOfEarningsBenefit.roundingTypestringRounding method for multiple of earnings in thousands. · Unspecified, Up, Down, Nearest
benefits.employee.incrementsBenefitVoluntaryLife.IncrementsMultipleEarningsMaximumType
benefits.employee.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.employee.incrementsBenefit.maximumMultipleOfEarningsnumberMaximum benefit amount as a multiple of earnings
benefits.employee.incrementsBenefit.roundingTypestringRounding method for maximum multiple of earnings in thousands. · Unspecified, Up, Down
benefits.employee.ageReductionsVoluntaryLife.AgeReductions
benefits.employee.ageReductions.reductionsarray of BenefitReductionSchedule of reductions as a percent of benefit which occur upon attaining a specific age.
benefits.employee.ageReductions.reductions.atAgeinteger✓Age benefit is reduced.
benefits.employee.ageReductions.reductions.reducedByPercentnumber✓Amount benefit is reduced by as a percent. Not an amount reduced to.
benefits.spouseVoluntaryLife.SpouseBenefit
benefits.spouse.benefitClassCodestringCarrier code assigned to the spouse benefit class. Commonly used when carrier assigns different codes for employee, spouse, and child benefits
benefits.spouse.benefitDescriptionstringOptional benefit description assigned by the carrier describing the spouse benefit.
benefits.spouse.incrementsBenefitVoluntaryLife.IncrementsMaxPercentEmployeeType
benefits.spouse.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.spouse.incrementsBenefit.maximumPercentOfEmployeeElectionintegerMaximum benefit as a percent of employee benefit amount.
benefits.spouse.percentBenefitVoluntaryLife.PercentOfEmployeeBenefitType
benefits.spouse.percentBenefit.percentOfEmployeeElectionnumberBenefit as a percent of employee election.
benefits.spouse.percentBenefit.minimumBenefitnumberMinimum benefit amount
benefits.spouse.percentBenefit.maximumBenefitnumberMaximum benefit amount
benefits.spouse.ageReductionsVoluntaryLife.AgeReductions
benefits.spouse.ageReductions.reductionsarray of BenefitReductionSchedule of reductions as a percent of benefit which occur upon attaining a specific age.
benefits.spouse.ageReductions.reductions.atAgeinteger✓Age benefit is reduced.
benefits.spouse.ageReductions.reductions.reducedByPercentnumber✓Amount benefit is reduced by as a percent. Not an amount reduced to.
benefits.spouse.optionsVoluntaryLife.SpouseBenefitOptions
benefits.spouse.options.spouseReductionsBasedOnEmployeeAgebooleanWhen benefits are reduced based on age, this determines when spouse benefit reductions are calculated based on the employee age.
benefits.childVoluntaryLife.ChildBenefit
benefits.child.benefitClassCodestringCarrier code assigned to the child benefit class. Commonly used when carrier assigns different codes for employee, spouse, and child benefits.
benefits.child.benefitDescriptionstringOptional benefit description assigned by the carrier describing the child benefit.
benefits.child.incrementsBenefitVoluntaryLife.IncrementsMaxPercentEmployeeType
benefits.child.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.child.incrementsBenefit.maximumPercentOfEmployeeElectionintegerMaximum benefit as a percent of employee benefit amount.
benefits.child.percentBenefitVoluntaryLife.PercentOfEmployeeBenefitType
benefits.child.percentBenefit.percentOfEmployeeElectionnumberBenefit as a percent of employee election.
benefits.child.percentBenefit.minimumBenefitnumberMinimum benefit amount
benefits.child.percentBenefit.maximumBenefitnumberMaximum benefit amount
benefits.child.flatBenefitVoluntaryLife.FlatAmountType
benefits.child.flatBenefit.amountnumberBenefit amount
benefits.detailsVoluntaryLife.BenefitDetails
benefits.details.conditionsOrExclusionsstringDescribes the details and definition of any pre-existing condition exclusions which may impose limitations on benefit payment.
(root)
guaranteedIssueVoluntaryLife.GuaranteedIssueType
guaranteedIssue
guaranteedIssue.employeeVoluntaryLife.GuaranteedIssueEmployeeOptions
guaranteedIssue.employee.initialAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.employee.initialAmount.amountnumberFlat amount
guaranteedIssue.employee.initialAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.lateEntrantAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.employee.lateEntrantAmount.amountnumberFlat amount
guaranteedIssue.employee.lateEntrantAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.existingAmountVoluntaryLife.GuaranteedIssueExistingType
guaranteedIssue.employee.existingAmount.flatAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.employee.existingAmount.flatAmount.amountnumberFlat amount
guaranteedIssue.employee.existingAmount.flatAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.existingAmount.increaseAmountVoluntaryLife.GuaranteedIssueIncreaseAmountType
guaranteedIssue.employee.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
guaranteedIssue.employee.existingAmount.increaseAmount.maximumAmountnumberUsed in conjunction with IncreaseBy amount, an optional maximum flat amount serving as a guaranteed issue limit.
guaranteedIssue.employee.reductionsVoluntaryLife.GuaranteedIssueReductions
guaranteedIssue.employee.reductions.reductionAmountsarray of VoluntaryLife.GuaranteedIssueReduction
guaranteedIssue.employee.reductions.reductionAmounts.atAgeinteger✓Age benefit is reduced.
guaranteedIssue.employee.reductions.reductionAmounts.amountnumber✓Amount guaranteed issue is reduced to.
guaranteedIssue.spouseVoluntaryLife.GuaranteedIssueSpouseOptions
guaranteedIssue.spouse.initialAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.spouse.initialAmount.amountnumberFlat amount
guaranteedIssue.spouse.initialAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.spouse.lateEntrantAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.spouse.lateEntrantAmount.amountnumberFlat amount
guaranteedIssue.spouse.lateEntrantAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.spouse.existingAmountVoluntaryLife.GuaranteedIssueExistingType
guaranteedIssue.spouse.existingAmount.flatAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.spouse.existingAmount.flatAmount.amountnumberFlat amount
guaranteedIssue.spouse.existingAmount.flatAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.spouse.existingAmount.increaseAmountVoluntaryLife.GuaranteedIssueIncreaseAmountType
guaranteedIssue.spouse.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
guaranteedIssue.spouse.existingAmount.increaseAmount.maximumAmountnumberUsed in conjunction with IncreaseBy amount, an optional maximum flat amount serving as a guaranteed issue limit.
guaranteedIssue.spouse.reductionsVoluntaryLife.GuaranteedIssueReductions
guaranteedIssue.spouse.reductions.reductionAmountsarray of VoluntaryLife.GuaranteedIssueReduction
guaranteedIssue.spouse.reductions.reductionAmounts.atAgeinteger✓Age benefit is reduced.
guaranteedIssue.spouse.reductions.reductionAmounts.amountnumber✓Amount guaranteed issue is reduced to.
guaranteedIssue.childVoluntaryLife.GuaranteedIssueChildOptions
guaranteedIssue.child.initialAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.child.initialAmount.amountnumberFlat amount
guaranteedIssue.child.initialAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.child.lateEntrantAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.child.lateEntrantAmount.amountnumberFlat amount
guaranteedIssue.child.lateEntrantAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.child.existingAmountVoluntaryLife.GuaranteedIssueExistingType
guaranteedIssue.child.existingAmount.flatAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.child.existingAmount.flatAmount.amountnumberFlat amount
guaranteedIssue.child.existingAmount.flatAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.child.existingAmount.increaseAmountVoluntaryLife.GuaranteedIssueIncreaseAmountType
guaranteedIssue.child.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
guaranteedIssue.child.existingAmount.increaseAmount.maximumAmountnumberUsed in conjunction with IncreaseBy amount, an optional maximum flat amount serving as a guaranteed issue limit.
guaranteedIssue.requiresEvidenceOfInsurabilitybooleanPlan has a guaranteed issue benefit and offers additional coverage upon meeting evidence of insurability underwriting requirements.
(root)
ratesVoluntaryLife.Rating
rates
rates.optionsVoluntaryLife.IssueAgeChangeRuleOptionsSimplifiedRateInitialEntrantAgeOptionsExpandedRateOptionsType
rates.options.isIssueAgebooleanAn issue age policy is one in which premium is based on the age at the time the policy is issued and does not change as member ages unless a change in coverage occurs.
rates.options.issueAgeChangeRulestringRerated updates all coverage based on the age at the time of coverage change. Stacked retains the cost for the original coverage, and only calculates a new rate for the additional portion of the coverage based on the age at the time of the change. Original Issue Rated will always use the original issue age for original coverage and coverage changes. · Unspecified, ReRated, Stacked
rates.options.annualPolicyFeenumberAn annual fee added to the total cost for each policy. Annual fee is applied to both the employee and the spouse policy.
rates.options.rateInitialEntrantAgeOnstringRate initial entrant according to age on selected option. When isIssueAge = true and issueAgeChangeRule = Stacked then all four enumerations are applicable; else only three enumerations are applicable for all other configurations (Unspecified, CalculatedEligibilityDate, PriorPolicyAnniversary). · Unspecified, CalculatedEligibilityDate, PriorPolicyAnniversary, FirstOfMonthFollowingEligibilityDate
rates.options.ageBandChangeUpdateOnstringSpecifies when to update rate upon age band change. · Unspecified, FirstOfMonthFollowing, FirstOfSpecifiedMonth, Birthday
rates.options.ageBandChangesMonthstringIdentifies the month when rate changes are to be applied when the age band change option is specified as FirstOfSpecifiedMonth. · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
rates.options.tobaccoRateBasedOnstringWhen rates are based on tobacco usage, this determines how tobacco rates are applied to each covered member. CoveredMember will apply the applicable tobacco rate to each covered member based on their own designated tobacco usage status. Employee will apply the rate based on the Employee’s tobacco usage status to both Employee and Spouse. EmployeeOrSpouse will apply the tobacco rates if either Employee or Spouse are designated as a tobacco user. · Unspecified, CoveredMember, Employee, EmployeeOrSpouse
rates.employeeVoluntaryLife.EmployeeRating
rates.employee.ageBasedRatesVoluntaryLife.AgeBasedRating
rates.employee.ageBasedRates.ratesarray of AgeBandedRateProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.employee.ageBasedRates.rates.fromAgeinteger✓
rates.employee.ageBasedRates.rates.toAgeinteger✓
rates.employee.ageBasedRates.rates.ratenumber✓
rates.employee.ageBasedRates.genderBasedRatesarray of AgeBandedGenderBasedRatesProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.employee.ageBasedRates.genderBasedRates.fromAgeinteger✓The lowest age in the range.
rates.employee.ageBasedRates.genderBasedRates.toAgeinteger✓The highest age in the range.
rates.employee.ageBasedRates.genderBasedRates.rateMalenumber✓The amount of money that must be paid to receive a specific amount of insurance under this plan if a Male.
rates.employee.ageBasedRates.genderBasedRates.rateFemalenumber✓The amount of money that a must be paid to receive a specific amount of insurance under this plan if a Female.
rates.employee.ageBasedRates.tobaccoBasedRatesarray of AgeBandedTobaccoBasedRatesProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.employee.ageBasedRates.tobaccoBasedRates.fromAgeinteger✓
rates.employee.ageBasedRates.tobaccoBasedRates.toAgeinteger✓
rates.employee.ageBasedRates.tobaccoBasedRates.rateNonsmokernumber✓
rates.employee.ageBasedRates.tobaccoBasedRates.rateSmokernumber✓
rates.spouseVoluntaryLife.SpouseRating
rates.spouse.ageBasedRatesVoluntaryLife.SpouseAgeBasedRating
rates.spouse.ageBasedRates.optionsVoluntaryLife.SpouseAgeBasedOptionsType
rates.spouse.ageBasedRates.options.spouseRatedOnEmployeeAgebooleanWhen rates are based on age, this determines when spouse rates are calculated based on the employee age.
rates.spouse.ageBasedRates.ratesarray of AgeBandedRateProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.spouse.ageBasedRates.rates.fromAgeinteger✓
rates.spouse.ageBasedRates.rates.toAgeinteger✓
rates.spouse.ageBasedRates.rates.ratenumber✓
rates.spouse.ageBasedRates.genderBasedRatesarray of AgeBandedGenderBasedRatesProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.spouse.ageBasedRates.genderBasedRates.fromAgeinteger✓The lowest age in the range.
rates.spouse.ageBasedRates.genderBasedRates.toAgeinteger✓The highest age in the range.
rates.spouse.ageBasedRates.genderBasedRates.rateMalenumber✓The amount of money that must be paid to receive a specific amount of insurance under this plan if a Male.
rates.spouse.ageBasedRates.genderBasedRates.rateFemalenumber✓The amount of money that a must be paid to receive a specific amount of insurance under this plan if a Female.
rates.spouse.ageBasedRates.tobaccoBasedRatesarray of AgeBandedTobaccoBasedRatesProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.spouse.ageBasedRates.tobaccoBasedRates.fromAgeinteger✓
rates.spouse.ageBasedRates.tobaccoBasedRates.toAgeinteger✓
rates.spouse.ageBasedRates.tobaccoBasedRates.rateNonsmokernumber✓
rates.spouse.ageBasedRates.tobaccoBasedRates.rateSmokernumber✓
rates.childVoluntaryLife.ChildRating
rates.child.optionsVoluntaryLife.ChildRateOptionsType
rates.child.options.childRatesBasedOnAllChildrenbooleanThis specifies when the same rate is applied regardless of the number of covered children. When each child is assessed their own rates, the plan does not use All Children rates.
rates.child.flatRateVoluntaryLife.ChildFlatRating
rates.child.flatRate.ratenumber
rates.child.benefitBasedRatesVoluntaryLife.ChildBenefitBasedRating
rates.child.benefitBasedRates.ratesarray of VoluntaryLife.ChildBenefitRateType
rates.child.benefitBasedRates.rates.benefitIncrementnumber✓
rates.child.benefitBasedRates.rates.ratenumber✓
(root)
contributionsVoluntaryLife.Contribution
contributions
contributions.contributionGroupingsarray of VoluntaryLife.ContributionGrouping✓A list of monthly contributions by a specified contribution grouping (e.g., everyone, by class, by department).
contributions.contributionGroupings.contributionGroupingBasedOnstringThe textual description of what the specified contribution grouping is based on.
contributions.contributionGroupings.monthlyContributionsarray of VoluntaryLife.MonthlyContributions✓A list of the monthly plan contributions.
contributions.contributionGroupings.monthlyContributions.memberTypestring✓Defines the universal level of member types covered by the plan based on the selected plan benefit type. · Unspecified, Employee, Spouse, Child
contributions.contributionGroupings.monthlyContributions.contributionBasisstring✓Defines whether the contribution is based on what the employee or employer will pay to cover the cost of the plan. · Unspecified, Employer, Employee
contributions.contributionGroupings.monthlyContributions.contributionTypestring✓Defines whether the contribution is represented as a percent or a flat dollar amount. · Unspecified, Percentage, BenefitAmount
contributions.contributionGroupings.monthlyContributions.contributionnumber✓The actual amount or percent that an employee or employee will pay to cover the cost of the plan.
EN Voluntary Short Term Disability fields   108 fields   EN schema VoluntaryShortTermDisabilityPlan · POST /Quoting/companies/{companyId}/plans/voluntaryshorttermdisability/notification
— / —
EN field pathTypeReqDescription / enum
(root)
planIdentifierstring✓The unique identifier assigned for the purpose of identifying a plan. This value is the key used to link a plan between the two systems and how we will communicate about the plan. A plan is a set of benefit of rates and should not include billing groups.
configurationPlanConfiguration✓
configuration
configuration.policyNumberstringValue assigned to the plan for the specific company
configuration.carrierNamestring
configuration.planNamestring
configuration.startDatestring✓Effective date representing the most recent plan year start date for the current set of benefits and rates. Our plans couple benefits and rates together.
configuration.endDatestringEffective date representing the plan year end date for the current set of benefits and rates. Typically plans are 12-month plan years, unless policy is Issue Age and rates do not change.
configuration.nextRenewalDatestringEffective date of coverage for next annual open enrollment.
configuration.carrierPlanCodestringSpecifies a plan code assigned by the carrier to identify a plan. This value would be returned with the enrollment record.
configuration.carrierPlanTypeCodestringSpecifies a plan code assigned by the carrier to identify the plan type. This value would be returned with the enrollment record.
configuration.planBillOptionstringUnspecified, SelfBill, ListBill
configuration.isSelfFundedboolean
configuration.situsStatestringThe state in which the legal, organizational entity exists or originated. Send the State Name or the 2-character ISO abbreviation. Either value will be accepted.
configuration.benefitstring✓Medical, Dental, Vision, Life, ADAndD, VoluntaryLife, VoluntaryADAndD, ShortTermDisability, VoluntaryShortTermDisability, LongTermDisability, VoluntaryLongTermDisability, Prescription, CriticalIllness, HospitalIndemnity, PermanentLife, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Cancer, Telemedicine
configuration.originalPlanStartDatestringDate the plan initially began between the carrier and group.
configuration.carrierPlanTypeDescriptionstringA carrier-defined standardized description that categorizes plans based on common characteristics. For example, medical plans may be categorized as HMO, PPO, etc.; dental plans as DHMO, etc. Note that this description is limited to 150 characters.
(root)
eligibilityOptionsarray of PlanEligibilityOptions
eligibilityOptions
eligibilityOptions.groupStructurePlanEligibilityGroupStructure
eligibilityOptions.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.eligibilityRulesPlanEligibilityRules
eligibilityOptions.eligibilityRules.waitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.waitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.waitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.entryDateRulestringUsed in conjunction with Waiting Period to define when the coverage is effective after the waiting period for a new employee. Use First of the Month Coinciding With or After rule when waiting period ending on the first of the month has entry on that day. Use First of the Month After when waiting period ending on the first of the month has entry on the first of the next month. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.terminationRulestringUsed to define the last day of coverage on loss of eligibility. · Unspecified, EndOfMonthOfTermination, EmploymentTermination, FirstOfMonthAfterEmploymentTermination
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationinteger
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehirePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.rehirePeriod.durationinteger
eligibilityOptions.eligibilityRules.rehirePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehireEntryDateRulestringUsed in conjunction with Rehire Period to define when coverage is effective after rehire date for employees rehired within the rehire period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.eligibilityChangeEntryDateRulestringUsed in conjunction with Eligibility Change Waiting Period to define when the coverage is effective after the employee becomes eligible after a classification change and completes waiting period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
(root)
planCommunicationsPlanCommunications
planCommunications
planCommunications.marketingDescriptionstringCustomizes the employee enrollment experience with marketing information about the benefits of the plan.
planCommunications.benefitSummaryUrlstringCustomizes the employee enrollment experience with a URL hosting the benefit summary.
(root)
optionsVoluntaryShortTermDisability.OptionsType
options
options.employeeOptionsEmployeePlanOptions
options.employeeOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
options.employeeOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
options.employeeOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
options.supplementalOptionsVoluntaryShortTermDisability.SupplementalOptions
options.supplementalOptions.captureBeneficiarybooleanSpecifies that beneficiary designation should be collected upon enrollment.
(root)
benefitsarray of VoluntaryShortTermDisability.Benefit
benefits
benefits.groupStructurePlanEligibilityGroupStructure
benefits.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.optionsVoluntaryShortTermDisability.BenefitOptions
benefits.options.benefitBasisstringIdentifies benefit as a weekly benefit or a monthly benefit. When unspecified, benefit will be a weekly benefit. · Unspecified, WeeklyEarnings, MonthlyEarnings
benefits.options.salaryRedeterminationOnstringSpecifies when salary changes update benefit amount. · Unspecified, FirstOfSpecifiedMonth, FirstOfFollowingMonth, DayOfChange, FirstOfMonthCoincidingWithOrAfter
benefits.options.salaryRedeterminationMonthstringIdentifies the month when salary changes are to be applied when salary redetermination option is specified as FirstOfSpecfiedMonth. If used in conjunction with ageBandChangesMonth, that value will drive both age and salary changes. · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
benefits.benefitClassCodestringCarrier code assigned to the employee benefit class.
benefits.benefitDescriptionstringOptional benefit description assigned by the carrier describing the benefit.
benefits.incrementsBenefitVoluntaryShortTermDisability.IncrementsType
benefits.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.incrementsBenefit.benefitPercentEarningsnumberMaximum benefit limit as a percent of earnings
benefits.incrementsBenefit.roundingTypestringUsed in conjunction with RoundingValue and RoundingIncrement, describes rounding method. · Unspecified, Up, Down, Nearest
benefits.incrementsBenefit.roundingIncrementstringUsed in conjunction with RoundingType to designate rounding specificity. · Unspecified, OneThousandDollars, OneHundredDollars, TenDollars, OneDollar, FiftyDollars, OneCent, FiveHundredDollars, FiveThousandDollars, TenThousandDollars
benefits.incrementsBenefit.maximumIncrementRoundingTypestringDescribes the rounding method applied on the max increment. · Unspecified, Up, Down, Nearest
benefits.percentEarningsBenefitVoluntaryShortTermDisability.PercentEarningsType
benefits.percentEarningsBenefit.benefitPercentEarningsnumberBenefit amount as a percent of earnings.
benefits.percentEarningsBenefit.minimumBenefitnumberMinimum weekly or monthly benefit. If the plan benefit is setup as a weekly amount, then this is a weekly minimum; otherwise, it is a monthly minimum
benefits.percentEarningsBenefit.maximumBenefitnumberMaximum weekly or monthly benefit. If the plan benefit is setup as a weekly amount, then this is a weekly maximum; otherwise, it is a monthly maximum
benefits.percentEarningsBenefit.roundingValuestringSpecifies where rounding occurs when calculating the final benefit offering. Choose salary rounding when salary is rounded prior to calculating benefit. If salary is not rounded, choose Benefit. Used in conjunction with Rounding Type and Rounding Increment. · Unspecified, Salary, Benefit
benefits.percentEarningsBenefit.roundingTypestringUsed in conjunction with RoundingValue and RoundingIncrement, describes rounding method. · Unspecified, Up, Down, Nearest
benefits.percentEarningsBenefit.roundingIncrementstringUsed in conjunction with RoundingType to designate rounding specificity. · Unspecified, OneThousandDollars, OneHundredDollars, TenDollars, OneDollar, FiftyDollars, OneCent, FiveHundredDollars, FiveThousandDollars, TenThousandDollars
benefits.detailsVoluntaryShortTermDisability.BenefitDetails
benefits.details.benefitDurationWeeksintegerIdentifies the length of time in weeks for which the benefit will be paid during disability.
benefits.details.accidentWaitingPeriodDaysintegerIdentifies the length of time in days before the benefit payment begins when the cause of disability is an accidental injury.
benefits.details.sicknessWaitingPeriodDaysintegerIdentifies the length of time in days before the benefit payment begins when the cause of disability is a physical disease, pregnancy, or sickness.
benefits.details.conditionsOrExclusionsstringDescribes the details and definition of any pre-existing condition exclusions which may impose limitations on benefit payment.
(root)
guaranteedIssueVolXtdGuaranteedIssueOptionsType
guaranteedIssue
guaranteedIssue.requiresEvidenceOfInsurabilitybooleanPlan has a guaranteed issue benefit and offers additional coverage upon meeting evidence of insurability underwriting requirements.
guaranteedIssue.employeeVolXtdGuaranteedIssueEmployeeOptions
guaranteedIssue.employee.initialAmountVolXtdGuaranteedIssueAmount
guaranteedIssue.employee.initialAmount.amountnumber
guaranteedIssue.employee.lateEntrantAmountVolXtdGuaranteedIssueAmount
guaranteedIssue.employee.lateEntrantAmount.amountnumber
guaranteedIssue.employee.existingAmountVolXtdGuaranteedIssueIncreaseAmountType
guaranteedIssue.employee.existingAmount.increaseAmountVolXtdGuaranteedIssueIncreaseAmount
guaranteedIssue.employee.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
(root)
ratesVoluntaryShortTermDisability.Rating
rates
rates.optionsVoluntaryShortTermDisability.RateOptions
rates.options.annualPolicyFeenumberAn annual fee added to the total cost for each policy. Annual fee is applied to both the employee and the spouse policy.
rates.compositeRateVoluntaryShortTermDisability.CompositeRating
rates.compositeRate.ratenumber✓
rates.ageBasedRatesVoluntaryShortTermDisability.AgeBasedRating
rates.ageBasedRates.optionsVoluntaryShortTermDisability.AgeBasedOptionsType
rates.ageBasedRates.options.isIssueAgebooleanAn issue age policy is one in which premium is based on the age at the time the policy is issued and does not change as member ages unless a change in coverage occurs.
rates.ageBasedRates.options.issueAgeChangeRulestringRerated updates all coverage based on the age at the time of coverage change. Stacked retains the cost for the original coverage, and only calculates a new rate for the additional portion of the coverage based on the age at the time of the change. Original Issue Rated will always use the original issue age for original coverage and coverage changes. · Unspecified, ReRated, Stacked, OriginalIssueRated
rates.ageBasedRates.options.rateInitialEntrantAgeOnstringRate initial entrant according to age on selected option. · Unspecified, CalculatedEligibilityDate, PriorPolicyAnniversary
rates.ageBasedRates.options.ageBandChangeUpdateOnstringSpecifies when to update rate upon age band change. · Unspecified, FirstOfMonthFollowing, FirstOfSpecifiedMonth, Birthday
rates.ageBasedRates.options.ageBandChangesMonthstringIdentifies the month when rate changes are to be applied when the age band change option is specified as FirstOfSpecifiedMonth. · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
rates.ageBasedRates.ratesarray of AgeBandedRateProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.ageBasedRates.rates.fromAgeinteger✓
rates.ageBasedRates.rates.toAgeinteger✓
rates.ageBasedRates.rates.ratenumber✓
(root)
contributionsVolXtdContribution
contributions
contributions.contributionGroupingsarray of VolXtdContributionGrouping✓A list of monthly contributions by a specified contribution grouping (e.g., everyone, by class, by department).
contributions.contributionGroupings.contributionGroupingBasedOnstringThe textual description of what the specified contribution grouping is based on.
contributions.contributionGroupings.monthlyContributionsVolXtdMonthlyContribution✓
contributions.contributionGroupings.monthlyContributions.contributionBasisstring✓Defines whether the contribution is based on what the employee or employer will pay to cover the cost of the plan. · Unspecified, Employer, Employee
contributions.contributionGroupings.monthlyContributions.contributionTypestring✓Defines whether the contribution is represented as a percent or a flat dollar amount. · Unspecified, Percentage, BenefitAmount
contributions.contributionGroupings.monthlyContributions.contributionnumber✓The actual amount or percent that an employee or employee will pay to cover the cost of the plan.
EN Voluntary Long Term Disability fields   105 fields   EN schema VoluntaryLongTermDisabilityPlan · POST /Quoting/companies/{companyId}/plans/voluntarylongtermdisability/notification
— / —
EN field pathTypeReqDescription / enum
(root)
planIdentifierstring✓The unique identifier assigned for the purpose of identifying a plan. This value is the key used to link a plan between the two systems and how we will communicate about the plan. A plan is a set of benefit of rates and should not include billing groups.
configurationPlanConfiguration✓
configuration
configuration.policyNumberstringValue assigned to the plan for the specific company
configuration.carrierNamestring
configuration.planNamestring
configuration.startDatestring✓Effective date representing the most recent plan year start date for the current set of benefits and rates. Our plans couple benefits and rates together.
configuration.endDatestringEffective date representing the plan year end date for the current set of benefits and rates. Typically plans are 12-month plan years, unless policy is Issue Age and rates do not change.
configuration.nextRenewalDatestringEffective date of coverage for next annual open enrollment.
configuration.carrierPlanCodestringSpecifies a plan code assigned by the carrier to identify a plan. This value would be returned with the enrollment record.
configuration.carrierPlanTypeCodestringSpecifies a plan code assigned by the carrier to identify the plan type. This value would be returned with the enrollment record.
configuration.planBillOptionstringUnspecified, SelfBill, ListBill
configuration.isSelfFundedboolean
configuration.situsStatestringThe state in which the legal, organizational entity exists or originated. Send the State Name or the 2-character ISO abbreviation. Either value will be accepted.
configuration.benefitstring✓Medical, Dental, Vision, Life, ADAndD, VoluntaryLife, VoluntaryADAndD, ShortTermDisability, VoluntaryShortTermDisability, LongTermDisability, VoluntaryLongTermDisability, Prescription, CriticalIllness, HospitalIndemnity, PermanentLife, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Cancer, Telemedicine
configuration.originalPlanStartDatestringDate the plan initially began between the carrier and group.
configuration.carrierPlanTypeDescriptionstringA carrier-defined standardized description that categorizes plans based on common characteristics. For example, medical plans may be categorized as HMO, PPO, etc.; dental plans as DHMO, etc. Note that this description is limited to 150 characters.
(root)
eligibilityOptionsarray of PlanEligibilityOptions
eligibilityOptions
eligibilityOptions.groupStructurePlanEligibilityGroupStructure
eligibilityOptions.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.eligibilityRulesPlanEligibilityRules
eligibilityOptions.eligibilityRules.waitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.waitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.waitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.entryDateRulestringUsed in conjunction with Waiting Period to define when the coverage is effective after the waiting period for a new employee. Use First of the Month Coinciding With or After rule when waiting period ending on the first of the month has entry on that day. Use First of the Month After when waiting period ending on the first of the month has entry on the first of the next month. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.terminationRulestringUsed to define the last day of coverage on loss of eligibility. · Unspecified, EndOfMonthOfTermination, EmploymentTermination, FirstOfMonthAfterEmploymentTermination
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationinteger
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehirePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.rehirePeriod.durationinteger
eligibilityOptions.eligibilityRules.rehirePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehireEntryDateRulestringUsed in conjunction with Rehire Period to define when coverage is effective after rehire date for employees rehired within the rehire period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.eligibilityChangeEntryDateRulestringUsed in conjunction with Eligibility Change Waiting Period to define when the coverage is effective after the employee becomes eligible after a classification change and completes waiting period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
(root)
planCommunicationsPlanCommunications
planCommunications
planCommunications.marketingDescriptionstringCustomizes the employee enrollment experience with marketing information about the benefits of the plan.
planCommunications.benefitSummaryUrlstringCustomizes the employee enrollment experience with a URL hosting the benefit summary.
(root)
optionsVoluntaryLongTermDisability.OptionsType
options
options.employeeOptionsEmployeePlanOptions
options.employeeOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
options.employeeOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
options.employeeOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
options.supplementalOptionsVoluntaryLongTermDisability.SupplementalOptions
options.supplementalOptions.captureBeneficiarybooleanSpecifies that beneficiary designation should be collected upon enrollment.
(root)
benefitsarray of VoluntaryLongTermDisability.Benefit
benefits
benefits.groupStructurePlanEligibilityGroupStructure
benefits.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.optionsVoluntaryLongTermDisability.BenefitOptions
benefits.options.salaryRedeterminationOnstringSpecifies when salary changes update benefit amount. · Unspecified, FirstOfSpecifiedMonth, FirstOfFollowingMonth, DayOfChange, FirstOfMonthCoincidingWithOrAfter
benefits.options.salaryRedeterminationMonthstringIdentifies the month when salary changes are to be applied when salary redetermination option is specified as FirstOfSpecfiedMonth. If used in conjunction with ageBandChangesMonth, that value will drive both age and salary changes. · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
benefits.benefitClassCodestringCarrier code assigned to the employee benefit class.
benefits.benefitDescriptionstringOptional benefit description assigned by the carrier describing the benefit.
benefits.incrementsBenefitVoluntaryLongTermDisability.IncrementsType
benefits.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.incrementsBenefit.benefitPercentEarningsnumberMaximum benefit limit as a percent of earnings
benefits.incrementsBenefit.roundingTypestringUsed in conjunction with RoundingValue and RoundingIncrement, describes rounding method. · Unspecified, Up, Down, Nearest
benefits.incrementsBenefit.roundingIncrementstringUsed in conjunction with RoundingType to designate rounding specificity. · Unspecified, OneThousandDollars, OneHundredDollars, TenDollars, OneDollar, FiftyDollars, OneCent, FiveHundredDollars, FiveThousandDollars, TenThousandDollars
benefits.incrementsBenefit.maximumIncrementRoundingTypestringDescribes the rounding method applied on the max increment. · Unspecified, Up, Down, Nearest
benefits.percentEarningsBenefitVoluntaryLongTermDisability.PercentEarningsType
benefits.percentEarningsBenefit.benefitPercentEarningsnumberBenefit amount as a percent of earnings.
benefits.percentEarningsBenefit.minimumBenefitnumberMinimum benefit amount
benefits.percentEarningsBenefit.maximumBenefitnumberMaximum benefit amount
benefits.percentEarningsBenefit.roundingValuestringSpecifies where rounding occurs when calculating the final benefit offering. Choose salary rounding when salary is rounded prior to calculating benefit. If salary is not rounded, choose Benefit. Used in conjunction with Rounding Type and Rounding Increment. · Unspecified, Salary, Benefit
benefits.percentEarningsBenefit.roundingTypestringUsed in conjunction with RoundingValue and RoundingIncrement, describes rounding method. · Unspecified, Up, Down, Nearest
benefits.percentEarningsBenefit.roundingIncrementstringUsed in conjunction with RoundingType to designate rounding specificity. · Unspecified, OneThousandDollars, OneHundredDollars, TenDollars, OneDollar, FiftyDollars, OneCent, FiveHundredDollars, FiveThousandDollars, TenThousandDollars
benefits.detailsVoluntaryLongTermDisability.BenefitDetails
benefits.details.benefitDurationstringIdentifies the length of time for which the benefit will be paid during disability. This duration period is usually in weeks, months, or up to a specific age (e.g. Age 65).
benefits.details.waitingPeriodDaysintegerIdentifies the length of time the employee must be disabled before benefit payment begins.
benefits.details.conditionsOrExclusionsstringDescribes the details and definition of any pre-existing condition exclusions which may impose limitations on benefit payment.
benefits.details.occupationDescriptionstringIdentifies the occupation contingencies for which the policy will cover. Any-occupation policy provides coverage when the employee is unable to perform duties for any job within their occupation based on education, experience, and training. Own-occupation provides coverage if the employee is unable to perform the majority of the duties for their specific job.
(root)
guaranteedIssueVolXtdGuaranteedIssueOptionsType
guaranteedIssue
guaranteedIssue.requiresEvidenceOfInsurabilitybooleanPlan has a guaranteed issue benefit and offers additional coverage upon meeting evidence of insurability underwriting requirements.
guaranteedIssue.employeeVolXtdGuaranteedIssueEmployeeOptions
guaranteedIssue.employee.initialAmountVolXtdGuaranteedIssueAmount
guaranteedIssue.employee.initialAmount.amountnumber
guaranteedIssue.employee.lateEntrantAmountVolXtdGuaranteedIssueAmount
guaranteedIssue.employee.lateEntrantAmount.amountnumber
guaranteedIssue.employee.existingAmountVolXtdGuaranteedIssueIncreaseAmountType
guaranteedIssue.employee.existingAmount.increaseAmountVolXtdGuaranteedIssueIncreaseAmount
guaranteedIssue.employee.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
(root)
ratesVoluntaryLongTermDisability.Rating
rates
rates.compositeRateVoluntaryLongTermDisability.CompositeRating
rates.compositeRate.ratenumber✓
rates.ageBasedRatesVoluntaryLongTermDisability.AgeBasedRating
rates.ageBasedRates.optionsVoluntaryLongTermDisability.AgeBasedOptionsType
rates.ageBasedRates.options.isIssueAgebooleanAn issue age policy is one in which premium is based on the age at the time the policy is issued and does not change as member ages unless a change in coverage occurs.
rates.ageBasedRates.options.issueAgeChangeRulestringRerated updates all coverage based on the age at the time of coverage change. Stacked retains the cost for the original coverage, and only calculates a new rate for the additional portion of the coverage based on the age at the time of the change. Original Issue Rated will always use the original issue age for original coverage and coverage changes. · Unspecified, ReRated, Stacked, OriginalIssueRated
rates.ageBasedRates.options.rateInitialEntrantAgeOnstringRate initial entrant according to age on selected option. · Unspecified, CalculatedEligibilityDate, PriorPolicyAnniversary
rates.ageBasedRates.options.ageBandChangeUpdateOnstringSpecifies when to update rate upon age band change. · Unspecified, FirstOfMonthFollowing, FirstOfSpecifiedMonth, Birthday
rates.ageBasedRates.options.ageBandChangesMonthstringIdentifies the month when rate changes are to be applied when the age band change option is specified as FirstOfSpecifiedMonth. · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
rates.ageBasedRates.ratesarray of AgeBandedRateProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.ageBasedRates.rates.fromAgeinteger✓
rates.ageBasedRates.rates.toAgeinteger✓
rates.ageBasedRates.rates.ratenumber✓
(root)
contributionsVolXtdContribution
contributions
contributions.contributionGroupingsarray of VolXtdContributionGrouping✓A list of monthly contributions by a specified contribution grouping (e.g., everyone, by class, by department).
contributions.contributionGroupings.contributionGroupingBasedOnstringThe textual description of what the specified contribution grouping is based on.
contributions.contributionGroupings.monthlyContributionsVolXtdMonthlyContribution✓
contributions.contributionGroupings.monthlyContributions.contributionBasisstring✓Defines whether the contribution is based on what the employee or employer will pay to cover the cost of the plan. · Unspecified, Employer, Employee
contributions.contributionGroupings.monthlyContributions.contributionTypestring✓Defines whether the contribution is represented as a percent or a flat dollar amount. · Unspecified, Percentage, BenefitAmount
contributions.contributionGroupings.monthlyContributions.contributionnumber✓The actual amount or percent that an employee or employee will pay to cover the cost of the plan.
EN Critical Illness fields   269 fields   EN schema CriticalIllnessPlan · POST /Quoting/companies/{companyId}/plans/criticalillness/notification
— / —
EN field pathTypeReqDescription / enum
(root)
planIdentifierstring✓The unique identifier assigned for the purpose of identifying a plan. This value is the key used to link a plan between the two systems and how we will communicate about the plan. A plan is a set of benefit of rates and should not include billing groups.
configurationPlanConfiguration✓
configuration
configuration.policyNumberstringValue assigned to the plan for the specific company
configuration.carrierNamestring
configuration.planNamestring
configuration.startDatestring✓Effective date representing the most recent plan year start date for the current set of benefits and rates. Our plans couple benefits and rates together.
configuration.endDatestringEffective date representing the plan year end date for the current set of benefits and rates. Typically plans are 12-month plan years, unless policy is Issue Age and rates do not change.
configuration.nextRenewalDatestringEffective date of coverage for next annual open enrollment.
configuration.carrierPlanCodestringSpecifies a plan code assigned by the carrier to identify a plan. This value would be returned with the enrollment record.
configuration.carrierPlanTypeCodestringSpecifies a plan code assigned by the carrier to identify the plan type. This value would be returned with the enrollment record.
configuration.planBillOptionstringUnspecified, SelfBill, ListBill
configuration.isSelfFundedboolean
configuration.situsStatestringThe state in which the legal, organizational entity exists or originated. Send the State Name or the 2-character ISO abbreviation. Either value will be accepted.
configuration.benefitstring✓Medical, Dental, Vision, Life, ADAndD, VoluntaryLife, VoluntaryADAndD, ShortTermDisability, VoluntaryShortTermDisability, LongTermDisability, VoluntaryLongTermDisability, Prescription, CriticalIllness, HospitalIndemnity, PermanentLife, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Cancer, Telemedicine
configuration.originalPlanStartDatestringDate the plan initially began between the carrier and group.
configuration.carrierPlanTypeDescriptionstringA carrier-defined standardized description that categorizes plans based on common characteristics. For example, medical plans may be categorized as HMO, PPO, etc.; dental plans as DHMO, etc. Note that this description is limited to 150 characters.
(root)
planDependenciesCriticalIllness.CriticalIllnessPlanDependencies
planDependencies
planDependencies.benefitEnrollmentDependencyCriticalIllness.CriticalIllnessPlanBenefitEnrollmentDependency
planDependencies.benefitEnrollmentDependency.enrollmentBenefitstring✓The pre-defined benefit category a plan may be dependent upon. · Medical, SupplementalMedical
(root)
eligibilityOptionsarray of PlanEligibilityOptions
eligibilityOptions
eligibilityOptions.groupStructurePlanEligibilityGroupStructure
eligibilityOptions.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.eligibilityRulesPlanEligibilityRules
eligibilityOptions.eligibilityRules.waitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.waitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.waitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.entryDateRulestringUsed in conjunction with Waiting Period to define when the coverage is effective after the waiting period for a new employee. Use First of the Month Coinciding With or After rule when waiting period ending on the first of the month has entry on that day. Use First of the Month After when waiting period ending on the first of the month has entry on the first of the next month. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.terminationRulestringUsed to define the last day of coverage on loss of eligibility. · Unspecified, EndOfMonthOfTermination, EmploymentTermination, FirstOfMonthAfterEmploymentTermination
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationinteger
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehirePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.rehirePeriod.durationinteger
eligibilityOptions.eligibilityRules.rehirePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehireEntryDateRulestringUsed in conjunction with Rehire Period to define when coverage is effective after rehire date for employees rehired within the rehire period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.eligibilityChangeEntryDateRulestringUsed in conjunction with Eligibility Change Waiting Period to define when the coverage is effective after the employee becomes eligible after a classification change and completes waiting period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
(root)
planCommunicationsPlanCommunications
planCommunications
planCommunications.marketingDescriptionstringCustomizes the employee enrollment experience with marketing information about the benefits of the plan.
planCommunications.benefitSummaryUrlstringCustomizes the employee enrollment experience with a URL hosting the benefit summary.
(root)
optionsVoluntaryLife.OptionsType
options
options.employeeOptionsVoluntaryLife.EmployeePlanOptions
options.employeeOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
options.employeeOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
options.employeeOptions.initialEntrantGracePeriodintegerThe length of time an employee has to enroll after their eligibility date for their original eligible entry date to be honored. E.g. If an employee is eligible on 10/1 and enrolls on 10/13, a 30-day grace period would honor 10/1 as their coverage start date. If no grace period is specified, the employee’s coverage will begin on the date of enrollment, 10/13.
options.employeeOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
options.supplementalOptionsVoluntaryLife.SupplementalOptions
options.supplementalOptions.captureBeneficiarybooleanSpecifies that beneficiary designation should be collected upon enrollment.
(root)
dependentOptionsVoluntaryLife.DependentOptionsType
dependentOptions
dependentOptions.spouseOptionsVoluntaryLife.DependentSpouseOptionsType
dependentOptions.spouseOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
dependentOptions.spouseOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
dependentOptions.spouseOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
dependentOptions.childOptionsVoluntaryLife.DependentChildOptionsType
dependentOptions.childOptions.ageIneligibleintegerAge non-student dependent child is no longer eligible.
dependentOptions.childOptions.studentAgeIneligibleintegerAge student child is no longer eligible to be covered under the plan.
dependentOptions.childOptions.dropOverageChildOnstringUsed in conjunction with AgeIneligible and StudentAgeIneligible, specifies the last day of coverage when a child becomes ineligible due to age. · Unspecified, EndOfMonth, Birthday, EndOfPlan, EndOfCalendarYear
dependentOptions.childOptions.minimumAgeintegerAge dependent child is too young to be covered under benefit.
dependentOptions.childOptions.minimumAgeTypestringUsed in conjunction with minimumAge, specifies how minimumAge is measured. · Unspecified, Days, Months, Years
(root)
benefitsarray of VoluntaryLife.Benefit
benefits
benefits.groupStructurePlanEligibilityGroupStructure
benefits.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
benefits.optionsVoluntaryLife.BenefitOptions
benefits.options.ageReductionOptionsVoluntaryLife.AgeReductionOptions
benefits.options.ageReductionOptions.ageReductionsBasedOnPreviousBenefitbooleanChoose this when the percent of reduction is based on the latest benefit, which may have already been reduced. Do not choose this when the percent of reduction is based on the original benefit amount.
benefits.options.ageReductionOptions.ageReductionReduceOnstringSpecifies when to apply reduction age band changes · Unspecified, FirstOfMonthFollowing, FirstOfSpecifiedMonth, Birthday
benefits.options.ageReductionOptions.ageReductionChangeMonthstringIdentifies the month when to apply reductions when the AgeReductionReduceOn option is specified as FirstOfSpecifiedMonth · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
benefits.options.ageReductionOptions.roundingTypestringUsed in conjunction with roundingIncrement, rounding method used for age-reduced benefit. · Unspecified, Up, Down, Nearest
benefits.options.ageReductionOptions.roundingIncrementstringUsed in conjunction with roundingType, specifies to what closest increment the reduced benefit amount should be rounded. · Unspecified, OneThousandDollars, OneHundredDollars, TenDollars, OneDollar, FiftyDollars, OneCent, FiveHundredDollars, FiveThousandDollars, TenThousandDollars
benefits.employeeVoluntaryLife.EmployeeBenefit
benefits.employee.benefitClassCodestringCarrier code assigned to the employee benefit class. Commonly used when carrier assigns different codes for employee, spouse, and child benefits.
benefits.employee.benefitDescriptionstringOptional benefit description assigned by the carrier describing the benefit.
benefits.employee.multiplesOfEarningsBenefitVoluntaryLife.MultiplesOfEarningsType
benefits.employee.multiplesOfEarningsBenefit.multiplesOfEarningsnumberThe highest multiplier to be applied to an employee's earnings. For example, if the plan supports 1X, 2X, or 3X earnings, then set the multipleOfEarnings field value to 3.
benefits.employee.multiplesOfEarningsBenefit.minimumBenefitnumberMinimum benefit amount
benefits.employee.multiplesOfEarningsBenefit.maximumBenefitnumberMaximum benefit amount
benefits.employee.multiplesOfEarningsBenefit.roundingTypestringRounding method for multiple of earnings in thousands. · Unspecified, Up, Down, Nearest
benefits.employee.incrementsBenefitVoluntaryLife.IncrementsMultipleEarningsMaximumType
benefits.employee.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.employee.incrementsBenefit.maximumMultipleOfEarningsnumberMaximum benefit amount as a multiple of earnings
benefits.employee.incrementsBenefit.roundingTypestringRounding method for maximum multiple of earnings in thousands. · Unspecified, Up, Down
benefits.employee.ageReductionsVoluntaryLife.AgeReductions
benefits.employee.ageReductions.reductionsarray of BenefitReductionSchedule of reductions as a percent of benefit which occur upon attaining a specific age.
benefits.employee.ageReductions.reductions.atAgeinteger✓Age benefit is reduced.
benefits.employee.ageReductions.reductions.reducedByPercentnumber✓Amount benefit is reduced by as a percent. Not an amount reduced to.
benefits.spouseVoluntaryLife.SpouseBenefit
benefits.spouse.benefitClassCodestringCarrier code assigned to the spouse benefit class. Commonly used when carrier assigns different codes for employee, spouse, and child benefits
benefits.spouse.benefitDescriptionstringOptional benefit description assigned by the carrier describing the spouse benefit.
benefits.spouse.incrementsBenefitVoluntaryLife.IncrementsMaxPercentEmployeeType
benefits.spouse.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.spouse.incrementsBenefit.maximumPercentOfEmployeeElectionintegerMaximum benefit as a percent of employee benefit amount.
benefits.spouse.percentBenefitVoluntaryLife.PercentOfEmployeeBenefitType
benefits.spouse.percentBenefit.percentOfEmployeeElectionnumberBenefit as a percent of employee election.
benefits.spouse.percentBenefit.minimumBenefitnumberMinimum benefit amount
benefits.spouse.percentBenefit.maximumBenefitnumberMaximum benefit amount
benefits.spouse.ageReductionsVoluntaryLife.AgeReductions
benefits.spouse.ageReductions.reductionsarray of BenefitReductionSchedule of reductions as a percent of benefit which occur upon attaining a specific age.
benefits.spouse.ageReductions.reductions.atAgeinteger✓Age benefit is reduced.
benefits.spouse.ageReductions.reductions.reducedByPercentnumber✓Amount benefit is reduced by as a percent. Not an amount reduced to.
benefits.spouse.optionsVoluntaryLife.SpouseBenefitOptions
benefits.spouse.options.spouseReductionsBasedOnEmployeeAgebooleanWhen benefits are reduced based on age, this determines when spouse benefit reductions are calculated based on the employee age.
benefits.childVoluntaryLife.ChildBenefit
benefits.child.benefitClassCodestringCarrier code assigned to the child benefit class. Commonly used when carrier assigns different codes for employee, spouse, and child benefits.
benefits.child.benefitDescriptionstringOptional benefit description assigned by the carrier describing the child benefit.
benefits.child.incrementsBenefitVoluntaryLife.IncrementsMaxPercentEmployeeType
benefits.child.incrementsBenefit.incrementsarrayBenefit amount as a list of available increments. Minimum and maximum benefit do not need to be provided. Minimum will be calculated to the lowest increment. Maximum benefit will be calculated to the highest increment.
benefits.child.incrementsBenefit.maximumPercentOfEmployeeElectionintegerMaximum benefit as a percent of employee benefit amount.
benefits.child.percentBenefitVoluntaryLife.PercentOfEmployeeBenefitType
benefits.child.percentBenefit.percentOfEmployeeElectionnumberBenefit as a percent of employee election.
benefits.child.percentBenefit.minimumBenefitnumberMinimum benefit amount
benefits.child.percentBenefit.maximumBenefitnumberMaximum benefit amount
benefits.child.flatBenefitVoluntaryLife.FlatAmountType
benefits.child.flatBenefit.amountnumberBenefit amount
benefits.detailsVoluntaryLife.BenefitDetails
benefits.details.conditionsOrExclusionsstringDescribes the details and definition of any pre-existing condition exclusions which may impose limitations on benefit payment.
(root)
guaranteedIssueCriticalIllness.CriticalIllnessGuaranteedIssueType
guaranteedIssue
guaranteedIssue.requiresEvidenceOfInsurabilityboolean
guaranteedIssue.employeeVoluntaryLife.GuaranteedIssueEmployeeOptions
guaranteedIssue.employee.initialAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.employee.initialAmount.amountnumberFlat amount
guaranteedIssue.employee.initialAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.lateEntrantAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.employee.lateEntrantAmount.amountnumberFlat amount
guaranteedIssue.employee.lateEntrantAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.existingAmountVoluntaryLife.GuaranteedIssueExistingType
guaranteedIssue.employee.existingAmount.flatAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.employee.existingAmount.flatAmount.amountnumberFlat amount
guaranteedIssue.employee.existingAmount.flatAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.employee.existingAmount.increaseAmountVoluntaryLife.GuaranteedIssueIncreaseAmountType
guaranteedIssue.employee.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
guaranteedIssue.employee.existingAmount.increaseAmount.maximumAmountnumberUsed in conjunction with IncreaseBy amount, an optional maximum flat amount serving as a guaranteed issue limit.
guaranteedIssue.employee.reductionsVoluntaryLife.GuaranteedIssueReductions
guaranteedIssue.employee.reductions.reductionAmountsarray of VoluntaryLife.GuaranteedIssueReduction
guaranteedIssue.employee.reductions.reductionAmounts.atAgeinteger✓Age benefit is reduced.
guaranteedIssue.employee.reductions.reductionAmounts.amountnumber✓Amount guaranteed issue is reduced to.
guaranteedIssue.spouseVoluntaryLife.GuaranteedIssueSpouseOptions
guaranteedIssue.spouse.initialAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.spouse.initialAmount.amountnumberFlat amount
guaranteedIssue.spouse.initialAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.spouse.lateEntrantAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.spouse.lateEntrantAmount.amountnumberFlat amount
guaranteedIssue.spouse.lateEntrantAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.spouse.existingAmountVoluntaryLife.GuaranteedIssueExistingType
guaranteedIssue.spouse.existingAmount.flatAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.spouse.existingAmount.flatAmount.amountnumberFlat amount
guaranteedIssue.spouse.existingAmount.flatAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.spouse.existingAmount.increaseAmountVoluntaryLife.GuaranteedIssueIncreaseAmountType
guaranteedIssue.spouse.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
guaranteedIssue.spouse.existingAmount.increaseAmount.maximumAmountnumberUsed in conjunction with IncreaseBy amount, an optional maximum flat amount serving as a guaranteed issue limit.
guaranteedIssue.spouse.reductionsVoluntaryLife.GuaranteedIssueReductions
guaranteedIssue.spouse.reductions.reductionAmountsarray of VoluntaryLife.GuaranteedIssueReduction
guaranteedIssue.spouse.reductions.reductionAmounts.atAgeinteger✓Age benefit is reduced.
guaranteedIssue.spouse.reductions.reductionAmounts.amountnumber✓Amount guaranteed issue is reduced to.
guaranteedIssue.childVoluntaryLife.GuaranteedIssueChildOptions
guaranteedIssue.child.initialAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.child.initialAmount.amountnumberFlat amount
guaranteedIssue.child.initialAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.child.lateEntrantAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.child.lateEntrantAmount.amountnumberFlat amount
guaranteedIssue.child.lateEntrantAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.child.existingAmountVoluntaryLife.GuaranteedIssueExistingType
guaranteedIssue.child.existingAmount.flatAmountVoluntaryLife.GuaranteedIssueAmountType
guaranteedIssue.child.existingAmount.flatAmount.amountnumberFlat amount
guaranteedIssue.child.existingAmount.flatAmount.multipleOfEarningsLimitnumberUsed in conjunction with Amount, an optional limit on guaranteed issue expressed as a maximum multiple of employee earnings. When specified, the guaranteed benefit amount is the lesser of Amount and MultipleOfEarningsLimit.
guaranteedIssue.child.existingAmount.increaseAmountVoluntaryLife.GuaranteedIssueIncreaseAmountType
guaranteedIssue.child.existingAmount.increaseAmount.increaseBynumberAmount an existing benefit can be increased by without requiring additional underwriting.
guaranteedIssue.child.existingAmount.increaseAmount.maximumAmountnumberUsed in conjunction with IncreaseBy amount, an optional maximum flat amount serving as a guaranteed issue limit.
(root)
ratesVoluntaryLife.CriticalIllnessRating
rates
rates.optionsVoluntaryLife.IssueAgeChangeRuleOptionsRateInitialEntrantAgeOptionsRateOptionsType
rates.options.isIssueAgebooleanAn issue age policy is one in which premium is based on the age at the time the policy is issued and does not change as member ages unless a change in coverage occurs.
rates.options.issueAgeChangeRulestringRerated updates all coverage based on the age at the time of coverage change. Stacked retains the cost for the original coverage, and only calculates a new rate for the additional portion of the coverage based on the age at the time of the change. Original Issue Rated will always use the original issue age for original coverage and coverage changes. · Unspecified, ReRated, Stacked, OriginalIssueRated
rates.options.annualPolicyFeenumberAn annual fee added to the total cost for each policy. Annual fee is applied to both the employee and the spouse policy.
rates.options.rateInitialEntrantAgeOnstringRate initial entrant according to age on selected option. When isIssueAge = true and issueAgeChangeRule = Stacked then all four enumerations are applicable; else only three enumerations are applicable for all other configurations (Unspecified, CalculatedEligibilityDate, PriorPolicyAnniversary). · Unspecified, CalculatedEligibilityDate, PriorPolicyAnniversary
rates.options.ageBandChangeUpdateOnstringSpecifies when to update rate upon age band change. · Unspecified, FirstOfMonthFollowing, FirstOfSpecifiedMonth, Birthday
rates.options.ageBandChangesMonthstringIdentifies the month when rate changes are to be applied when the age band change option is specified as FirstOfSpecifiedMonth. · Unspecified, January, February, March, April, May, June, July, August, September, October, November, December
rates.options.tobaccoRateBasedOnstringWhen rates are based on tobacco usage, this determines how tobacco rates are applied to each covered member. CoveredMember will apply the applicable tobacco rate to each covered member based on their own designated tobacco usage status. Employee will apply the rate based on the Employee’s tobacco usage status to both Employee and Spouse. EmployeeOrSpouse will apply the tobacco rates if either Employee or Spouse are designated as a tobacco user. · Unspecified, CoveredMember, Employee, EmployeeOrSpouse
rates.employeeVoluntaryLife.CriticalIllnessEmployeeRating
rates.employee.ageBasedRatesVoluntaryLife.AgeBasedRating
rates.employee.ageBasedRates.ratesarray of AgeBandedRateProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.employee.ageBasedRates.rates.fromAgeinteger✓
rates.employee.ageBasedRates.rates.toAgeinteger✓
rates.employee.ageBasedRates.rates.ratenumber✓
rates.employee.ageBasedRates.genderBasedRatesarray of AgeBandedGenderBasedRatesProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.employee.ageBasedRates.genderBasedRates.fromAgeinteger✓The lowest age in the range.
rates.employee.ageBasedRates.genderBasedRates.toAgeinteger✓The highest age in the range.
rates.employee.ageBasedRates.genderBasedRates.rateMalenumber✓The amount of money that must be paid to receive a specific amount of insurance under this plan if a Male.
rates.employee.ageBasedRates.genderBasedRates.rateFemalenumber✓The amount of money that a must be paid to receive a specific amount of insurance under this plan if a Female.
rates.employee.ageBasedRates.tobaccoBasedRatesarray of AgeBandedTobaccoBasedRatesProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.employee.ageBasedRates.tobaccoBasedRates.fromAgeinteger✓
rates.employee.ageBasedRates.tobaccoBasedRates.toAgeinteger✓
rates.employee.ageBasedRates.tobaccoBasedRates.rateNonsmokernumber✓
rates.employee.ageBasedRates.tobaccoBasedRates.rateSmokernumber✓
rates.employee.compositeAgeBasedRatesCriticalIllness.CompositeAgeBasedRating
rates.employee.compositeAgeBasedRates.benefitBasedRatesarray of CriticalIllness.BenefitBasedRatesList of rates by benefit amount (e.g., per 10,000, per 20,000).
rates.employee.compositeAgeBasedRates.benefitBasedRates.benefitAmountnumberThe benefit amount the list of rates is based on (e.g., 10000, 20000).
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierRatesarray of CoverageTierAgeBandedTieredRateProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusChildren, EmployeePlusFamily
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierRates.fromAgeinteger✓
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierRates.toAgeinteger✓
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierRates.ratenumber✓
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierGenderBasedRatesarray of CoverageTierAgeBandedTieredGenderBasedRatesProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierGenderBasedRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusChildren, EmployeePlusFamily
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierGenderBasedRates.fromAgeinteger✓
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierGenderBasedRates.toAgeinteger✓
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierGenderBasedRates.rateMalenumber✓
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierGenderBasedRates.rateFemalenumber✓
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierTobaccoBasedRatesarray of CoverageTierAgeBandedTieredTobaccoBasedRatesProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierTobaccoBasedRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusChildren, EmployeePlusFamily
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierTobaccoBasedRates.fromAgeinteger✓
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierTobaccoBasedRates.toAgeinteger✓
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierTobaccoBasedRates.rateNonsmokernumber✓
rates.employee.compositeAgeBasedRates.benefitBasedRates.tierTobaccoBasedRates.rateSmokernumber✓
rates.employee.compositeAgeBasedRates.perThousandBasedRatesCriticalIllness.PerThousandBasedRates
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierRatesarray of CoverageTierAgeBandedTieredRate
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusChildren, EmployeePlusFamily
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierRates.fromAgeinteger✓
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierRates.toAgeinteger✓
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierRates.ratenumber✓
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierGenderBasedRatesarray of CoverageTierAgeBandedTieredGenderBasedRates
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierGenderBasedRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusChildren, EmployeePlusFamily
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierGenderBasedRates.fromAgeinteger✓
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierGenderBasedRates.toAgeinteger✓
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierGenderBasedRates.rateMalenumber✓
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierGenderBasedRates.rateFemalenumber✓
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierTobaccoBasedRatesarray of CoverageTierAgeBandedTieredTobaccoBasedRates
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierTobaccoBasedRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusChildren, EmployeePlusFamily
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierTobaccoBasedRates.fromAgeinteger✓
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierTobaccoBasedRates.toAgeinteger✓
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierTobaccoBasedRates.rateNonsmokernumber✓
rates.employee.compositeAgeBasedRates.perThousandBasedRates.tierTobaccoBasedRates.rateSmokernumber✓
rates.spouseVoluntaryLife.SpouseRating
rates.spouse.ageBasedRatesVoluntaryLife.SpouseAgeBasedRating
rates.spouse.ageBasedRates.optionsVoluntaryLife.SpouseAgeBasedOptionsType
rates.spouse.ageBasedRates.options.spouseRatedOnEmployeeAgebooleanWhen rates are based on age, this determines when spouse rates are calculated based on the employee age.
rates.spouse.ageBasedRates.ratesarray of AgeBandedRateProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.spouse.ageBasedRates.rates.fromAgeinteger✓
rates.spouse.ageBasedRates.rates.toAgeinteger✓
rates.spouse.ageBasedRates.rates.ratenumber✓
rates.spouse.ageBasedRates.genderBasedRatesarray of AgeBandedGenderBasedRatesProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.spouse.ageBasedRates.genderBasedRates.fromAgeinteger✓The lowest age in the range.
rates.spouse.ageBasedRates.genderBasedRates.toAgeinteger✓The highest age in the range.
rates.spouse.ageBasedRates.genderBasedRates.rateMalenumber✓The amount of money that must be paid to receive a specific amount of insurance under this plan if a Male.
rates.spouse.ageBasedRates.genderBasedRates.rateFemalenumber✓The amount of money that a must be paid to receive a specific amount of insurance under this plan if a Female.
rates.spouse.ageBasedRates.tobaccoBasedRatesarray of AgeBandedTobaccoBasedRatesProvide age ranges with no overlap in ages or gaps between ages (e.g. Single year age range would be fromAge: 25 toAge: 25, fromAge: 26 toAge: 26. Multi-year range would be fromAge: 20 toAge:29 and fromAge:30 toAge: 39).
rates.spouse.ageBasedRates.tobaccoBasedRates.fromAgeinteger✓
rates.spouse.ageBasedRates.tobaccoBasedRates.toAgeinteger✓
rates.spouse.ageBasedRates.tobaccoBasedRates.rateNonsmokernumber✓
rates.spouse.ageBasedRates.tobaccoBasedRates.rateSmokernumber✓
rates.childVoluntaryLife.ChildRating
rates.child.optionsVoluntaryLife.ChildRateOptionsType
rates.child.options.childRatesBasedOnAllChildrenbooleanThis specifies when the same rate is applied regardless of the number of covered children. When each child is assessed their own rates, the plan does not use All Children rates.
rates.child.flatRateVoluntaryLife.ChildFlatRating
rates.child.flatRate.ratenumber
rates.child.benefitBasedRatesVoluntaryLife.ChildBenefitBasedRating
rates.child.benefitBasedRates.ratesarray of VoluntaryLife.ChildBenefitRateType
rates.child.benefitBasedRates.rates.benefitIncrementnumber✓
rates.child.benefitBasedRates.rates.ratenumber✓
(root)
contributionsVoluntaryLife.Contribution
contributions
contributions.contributionGroupingsarray of VoluntaryLife.ContributionGrouping✓A list of monthly contributions by a specified contribution grouping (e.g., everyone, by class, by department).
contributions.contributionGroupings.contributionGroupingBasedOnstringThe textual description of what the specified contribution grouping is based on.
contributions.contributionGroupings.monthlyContributionsarray of VoluntaryLife.MonthlyContributions✓A list of the monthly plan contributions.
contributions.contributionGroupings.monthlyContributions.memberTypestring✓Defines the universal level of member types covered by the plan based on the selected plan benefit type. · Unspecified, Employee, Spouse, Child
contributions.contributionGroupings.monthlyContributions.contributionBasisstring✓Defines whether the contribution is based on what the employee or employer will pay to cover the cost of the plan. · Unspecified, Employer, Employee
contributions.contributionGroupings.monthlyContributions.contributionTypestring✓Defines whether the contribution is represented as a percent or a flat dollar amount. · Unspecified, Percentage, BenefitAmount
contributions.contributionGroupings.monthlyContributions.contributionnumber✓The actual amount or percent that an employee or employee will pay to cover the cost of the plan.
EN Hospital Indemnity fields   82 fields   EN schema HospitalIndemnityPlan · POST /Quoting/companies/{companyId}/plans/hospitalindemnity/notification
— / —
EN field pathTypeReqDescription / enum
(root)
planIdentifierstring✓The unique identifier assigned for the purpose of identifying a plan. This value is the key used to link a plan between the two systems and how we will communicate about the plan. A plan is a set of benefit of rates and should not include billing groups.
configurationPlanConfiguration✓
configuration
configuration.policyNumberstringValue assigned to the plan for the specific company
configuration.carrierNamestring
configuration.planNamestring
configuration.startDatestring✓Effective date representing the most recent plan year start date for the current set of benefits and rates. Our plans couple benefits and rates together.
configuration.endDatestringEffective date representing the plan year end date for the current set of benefits and rates. Typically plans are 12-month plan years, unless policy is Issue Age and rates do not change.
configuration.nextRenewalDatestringEffective date of coverage for next annual open enrollment.
configuration.carrierPlanCodestringSpecifies a plan code assigned by the carrier to identify a plan. This value would be returned with the enrollment record.
configuration.carrierPlanTypeCodestringSpecifies a plan code assigned by the carrier to identify the plan type. This value would be returned with the enrollment record.
configuration.planBillOptionstringUnspecified, SelfBill, ListBill
configuration.isSelfFundedboolean
configuration.situsStatestringThe state in which the legal, organizational entity exists or originated. Send the State Name or the 2-character ISO abbreviation. Either value will be accepted.
configuration.benefitstring✓Medical, Dental, Vision, Life, ADAndD, VoluntaryLife, VoluntaryADAndD, ShortTermDisability, VoluntaryShortTermDisability, LongTermDisability, VoluntaryLongTermDisability, Prescription, CriticalIllness, HospitalIndemnity, PermanentLife, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Cancer, Telemedicine
configuration.originalPlanStartDatestringDate the plan initially began between the carrier and group.
configuration.carrierPlanTypeDescriptionstringA carrier-defined standardized description that categorizes plans based on common characteristics. For example, medical plans may be categorized as HMO, PPO, etc.; dental plans as DHMO, etc. Note that this description is limited to 150 characters.
(root)
planDependenciesHospitalIndemnity.HospitalIndemnityPlanDependencies
planDependencies
planDependencies.benefitEnrollmentDependencyHospitalIndemnity.HospitalIndemnityPlanBenefitEnrollmentDependency
planDependencies.benefitEnrollmentDependency.enrollmentBenefitstring✓The pre-defined benefit category a plan may be dependent upon. · Medical, Dental, Vision, Prescription, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Cancer, Telemedicine
(root)
eligibilityOptionsarray of PlanEligibilityOptions
eligibilityOptions
eligibilityOptions.groupStructurePlanEligibilityGroupStructure
eligibilityOptions.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.eligibilityRulesPlanEligibilityRules
eligibilityOptions.eligibilityRules.waitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.waitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.waitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.entryDateRulestringUsed in conjunction with Waiting Period to define when the coverage is effective after the waiting period for a new employee. Use First of the Month Coinciding With or After rule when waiting period ending on the first of the month has entry on that day. Use First of the Month After when waiting period ending on the first of the month has entry on the first of the next month. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.terminationRulestringUsed to define the last day of coverage on loss of eligibility. · Unspecified, EndOfMonthOfTermination, EmploymentTermination, FirstOfMonthAfterEmploymentTermination
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationinteger
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehirePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.rehirePeriod.durationinteger
eligibilityOptions.eligibilityRules.rehirePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehireEntryDateRulestringUsed in conjunction with Rehire Period to define when coverage is effective after rehire date for employees rehired within the rehire period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.eligibilityChangeEntryDateRulestringUsed in conjunction with Eligibility Change Waiting Period to define when the coverage is effective after the employee becomes eligible after a classification change and completes waiting period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
(root)
planCommunicationsPlanCommunications
planCommunications
planCommunications.marketingDescriptionstringCustomizes the employee enrollment experience with marketing information about the benefits of the plan.
planCommunications.benefitSummaryUrlstringCustomizes the employee enrollment experience with a URL hosting the benefit summary.
(root)
optionsSharedOptionsType
options
options.employeeOptionsEmployeePlanOptions
options.employeeOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
options.employeeOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
options.employeeOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
(root)
dependentOptionsMedical.MedicalDependentOptionsType
dependentOptions
dependentOptions.spouseOptionsMedical.MedicalDependentSpouseOptionsType
dependentOptions.spouseOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
dependentOptions.spouseOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
dependentOptions.spouseOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
dependentOptions.childOptionsMedical.MedicalDependentChildOptionsType
dependentOptions.childOptions.ageIneligibleintegerAge non-student dependent child is no longer eligible.
dependentOptions.childOptions.studentAgeIneligibleintegerAge student child is no longer eligible to be covered under the plan.
dependentOptions.childOptions.dropOverageChildOnstringUsed in conjunction with AgeIneligible and StudentAgeIneligible, specifies the last day of coverage when a child becomes ineligible due to age. · Unspecified, EndOfMonth, Birthday, EndOfPlan, EndOfCalendarYear
(root)
benefitHospitalIndemnity.Benefit
benefit
benefit.annualBenefitAmountnumber
(root)
ratesMedical.WorksiteRating
rates
rates.compositeRatesMedical.CompositeRating
rates.compositeRates.tierRatesarray of Medical.CompositeRateType
rates.compositeRates.tierRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusOne, EmployeePlusChild, EmployeePlusChildren, EmployeePlusFamily, EmployeePlusDomesticPartner, EmployeePlusSpousePlusChild, EmployeePlusTwo, EmployeePlusTwoChildren, EmployeePlusThreeChildren, EmployeePlusThree, EmployeePlusFour, EmployeePlusSpousePlusTwoChildren, EmployeePlusSpousePlusThreeChildren
rates.compositeRates.tierRates.ratenumber✓Monthly rate
rates.ageBasedRatesMedical.WorksiteAgeBasedRating
rates.ageBasedRates.optionsMedical.WorksiteAgeBasedOptionsType
rates.ageBasedRates.options.isIssueAgebooleanAn issue age policy is one in which premium is based on the age at the time the policy is issued and does not change as member ages unless a change in coverage occurs.
rates.ageBasedRates.options.issueAgeChangeRulestringRerated updates all coverage based on the age at the time of coverage change. Stacked retains the cost for the original coverage, and only calculates a new rate for the additional portion of the coverage based on the age at the time of the change. Original Issue Rated will always use the original issue age for original coverage and coverage changes. · Unspecified, ReRated, Stacked
rates.ageBasedRates.tierRatesarray of MedicalAgeBandedTieredRate
rates.ageBasedRates.tierRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusOne, EmployeePlusChild, EmployeePlusChildren, EmployeePlusFamily, EmployeePlusDomesticPartner, EmployeePlusSpousePlusChild, EmployeePlusTwo, EmployeePlusTwoChildren, EmployeePlusThreeChildren, EmployeePlusThree, EmployeePlusFour, EmployeePlusSpousePlusTwoChildren, EmployeePlusSpousePlusThreeChildren
rates.ageBasedRates.tierRates.fromAgeinteger✓
rates.ageBasedRates.tierRates.toAgeinteger✓
rates.ageBasedRates.tierRates.ratenumber✓
(root)
contributionsMedical.Contribution
contributions
contributions.contributionGroupingsarray of Medical.ContributionGrouping✓A list of monthly contributions by a specified contribution grouping (e.g., everyone, by class, by department).
contributions.contributionGroupings.contributionGroupingBasedOnstringThe textual description of what the specified contribution grouping is based on.
contributions.contributionGroupings.tierMonthlyContributionsarray of Medical.MonthlyContribution✓A list of the monthly plan contributions.
contributions.contributionGroupings.tierMonthlyContributions.contributionTierstring✓Defines the universal level of contribution tiers by the employee (including dependents) covered by the plan based on the selected plan benefit type. · Unspecified, Employee, EmployeePlusSpouse, EmployeePlusOne, EmployeePlusChild, EmployeePlusChildren, EmployeePlusFamily, EmployeePlusDomesticPartner, EmployeePlusSpousePlusChild, EmployeePlusTwo, EmployeePlusTwoChildren, EmployeePlusThreeChildren, EmployeePlusThree, EmployeePlusFour, EmployeePlusSpousePlusTwoChildren, EmployeePlusSpousePlusThreeChildren
contributions.contributionGroupings.tierMonthlyContributions.contributionBasisstring✓Defines whether the contribution is based on what the employee or employer will pay to cover the cost of the plan. · Unspecified, Employer, Employee
contributions.contributionGroupings.tierMonthlyContributions.contributionTypestring✓Defines whether the contribution is represented as a percent or a flat dollar amount. · Unspecified, Percentage, FlatDollarAmount
contributions.contributionGroupings.tierMonthlyContributions.contributionnumber✓The actual amount or percent that an employee or employee will pay to cover the cost of the plan.
contributions.contributionGroupings.tierMonthlyContributions.upToContributionAmountnumberA dollar amount that limits the overall contribution when the contributionType is percent.
EN Accident fields   80 fields   EN schema AccidentPlan · POST /Quoting/companies/{companyId}/plans/accident/notification
— / —
EN field pathTypeReqDescription / enum
(root)
planIdentifierstring✓The unique identifier assigned for the purpose of identifying a plan. This value is the key used to link a plan between the two systems and how we will communicate about the plan. A plan is a set of benefit of rates and should not include billing groups.
configurationPlanConfiguration✓
configuration
configuration.policyNumberstringValue assigned to the plan for the specific company
configuration.carrierNamestring
configuration.planNamestring
configuration.startDatestring✓Effective date representing the most recent plan year start date for the current set of benefits and rates. Our plans couple benefits and rates together.
configuration.endDatestringEffective date representing the plan year end date for the current set of benefits and rates. Typically plans are 12-month plan years, unless policy is Issue Age and rates do not change.
configuration.nextRenewalDatestringEffective date of coverage for next annual open enrollment.
configuration.carrierPlanCodestringSpecifies a plan code assigned by the carrier to identify a plan. This value would be returned with the enrollment record.
configuration.carrierPlanTypeCodestringSpecifies a plan code assigned by the carrier to identify the plan type. This value would be returned with the enrollment record.
configuration.planBillOptionstringUnspecified, SelfBill, ListBill
configuration.isSelfFundedboolean
configuration.situsStatestringThe state in which the legal, organizational entity exists or originated. Send the State Name or the 2-character ISO abbreviation. Either value will be accepted.
configuration.benefitstring✓Medical, Dental, Vision, Life, ADAndD, VoluntaryLife, VoluntaryADAndD, ShortTermDisability, VoluntaryShortTermDisability, LongTermDisability, VoluntaryLongTermDisability, Prescription, CriticalIllness, HospitalIndemnity, PermanentLife, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Cancer, Telemedicine
configuration.originalPlanStartDatestringDate the plan initially began between the carrier and group.
configuration.carrierPlanTypeDescriptionstringA carrier-defined standardized description that categorizes plans based on common characteristics. For example, medical plans may be categorized as HMO, PPO, etc.; dental plans as DHMO, etc. Note that this description is limited to 150 characters.
(root)
planDependenciesAccident.AccidentPlanDependencies
planDependencies
planDependencies.benefitEnrollmentDependencyAccident.AccidentPlanBenefitEnrollmentDependency
planDependencies.benefitEnrollmentDependency.enrollmentBenefitstring✓The pre-defined benefit category a plan may be dependent upon. · Medical, Dental, Vision, Prescription, HospitalIndemnity, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Cancer, Telemedicine
(root)
eligibilityOptionsarray of PlanEligibilityOptions
eligibilityOptions
eligibilityOptions.groupStructurePlanEligibilityGroupStructure
eligibilityOptions.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.eligibilityRulesPlanEligibilityRules
eligibilityOptions.eligibilityRules.waitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.waitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.waitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.entryDateRulestringUsed in conjunction with Waiting Period to define when the coverage is effective after the waiting period for a new employee. Use First of the Month Coinciding With or After rule when waiting period ending on the first of the month has entry on that day. Use First of the Month After when waiting period ending on the first of the month has entry on the first of the next month. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.terminationRulestringUsed to define the last day of coverage on loss of eligibility. · Unspecified, EndOfMonthOfTermination, EmploymentTermination, FirstOfMonthAfterEmploymentTermination
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationinteger
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehirePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.rehirePeriod.durationinteger
eligibilityOptions.eligibilityRules.rehirePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehireEntryDateRulestringUsed in conjunction with Rehire Period to define when coverage is effective after rehire date for employees rehired within the rehire period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.eligibilityChangeEntryDateRulestringUsed in conjunction with Eligibility Change Waiting Period to define when the coverage is effective after the employee becomes eligible after a classification change and completes waiting period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
(root)
planCommunicationsPlanCommunications
planCommunications
planCommunications.marketingDescriptionstringCustomizes the employee enrollment experience with marketing information about the benefits of the plan.
planCommunications.benefitSummaryUrlstringCustomizes the employee enrollment experience with a URL hosting the benefit summary.
(root)
optionsSharedOptionsType
options
options.employeeOptionsEmployeePlanOptions
options.employeeOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
options.employeeOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
options.employeeOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
(root)
dependentOptionsMedical.MedicalDependentOptionsType
dependentOptions
dependentOptions.spouseOptionsMedical.MedicalDependentSpouseOptionsType
dependentOptions.spouseOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
dependentOptions.spouseOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
dependentOptions.spouseOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
dependentOptions.childOptionsMedical.MedicalDependentChildOptionsType
dependentOptions.childOptions.ageIneligibleintegerAge non-student dependent child is no longer eligible.
dependentOptions.childOptions.studentAgeIneligibleintegerAge student child is no longer eligible to be covered under the plan.
dependentOptions.childOptions.dropOverageChildOnstringUsed in conjunction with AgeIneligible and StudentAgeIneligible, specifies the last day of coverage when a child becomes ineligible due to age. · Unspecified, EndOfMonth, Birthday, EndOfPlan, EndOfCalendarYear
(root)
ratesMedical.WorksiteRating
rates
rates.compositeRatesMedical.CompositeRating
rates.compositeRates.tierRatesarray of Medical.CompositeRateType
rates.compositeRates.tierRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusOne, EmployeePlusChild, EmployeePlusChildren, EmployeePlusFamily, EmployeePlusDomesticPartner, EmployeePlusSpousePlusChild, EmployeePlusTwo, EmployeePlusTwoChildren, EmployeePlusThreeChildren, EmployeePlusThree, EmployeePlusFour, EmployeePlusSpousePlusTwoChildren, EmployeePlusSpousePlusThreeChildren
rates.compositeRates.tierRates.ratenumber✓Monthly rate
rates.ageBasedRatesMedical.WorksiteAgeBasedRating
rates.ageBasedRates.optionsMedical.WorksiteAgeBasedOptionsType
rates.ageBasedRates.options.isIssueAgebooleanAn issue age policy is one in which premium is based on the age at the time the policy is issued and does not change as member ages unless a change in coverage occurs.
rates.ageBasedRates.options.issueAgeChangeRulestringRerated updates all coverage based on the age at the time of coverage change. Stacked retains the cost for the original coverage, and only calculates a new rate for the additional portion of the coverage based on the age at the time of the change. Original Issue Rated will always use the original issue age for original coverage and coverage changes. · Unspecified, ReRated, Stacked
rates.ageBasedRates.tierRatesarray of MedicalAgeBandedTieredRate
rates.ageBasedRates.tierRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusOne, EmployeePlusChild, EmployeePlusChildren, EmployeePlusFamily, EmployeePlusDomesticPartner, EmployeePlusSpousePlusChild, EmployeePlusTwo, EmployeePlusTwoChildren, EmployeePlusThreeChildren, EmployeePlusThree, EmployeePlusFour, EmployeePlusSpousePlusTwoChildren, EmployeePlusSpousePlusThreeChildren
rates.ageBasedRates.tierRates.fromAgeinteger✓
rates.ageBasedRates.tierRates.toAgeinteger✓
rates.ageBasedRates.tierRates.ratenumber✓
(root)
contributionsMedical.Contribution
contributions
contributions.contributionGroupingsarray of Medical.ContributionGrouping✓A list of monthly contributions by a specified contribution grouping (e.g., everyone, by class, by department).
contributions.contributionGroupings.contributionGroupingBasedOnstringThe textual description of what the specified contribution grouping is based on.
contributions.contributionGroupings.tierMonthlyContributionsarray of Medical.MonthlyContribution✓A list of the monthly plan contributions.
contributions.contributionGroupings.tierMonthlyContributions.contributionTierstring✓Defines the universal level of contribution tiers by the employee (including dependents) covered by the plan based on the selected plan benefit type. · Unspecified, Employee, EmployeePlusSpouse, EmployeePlusOne, EmployeePlusChild, EmployeePlusChildren, EmployeePlusFamily, EmployeePlusDomesticPartner, EmployeePlusSpousePlusChild, EmployeePlusTwo, EmployeePlusTwoChildren, EmployeePlusThreeChildren, EmployeePlusThree, EmployeePlusFour, EmployeePlusSpousePlusTwoChildren, EmployeePlusSpousePlusThreeChildren
contributions.contributionGroupings.tierMonthlyContributions.contributionBasisstring✓Defines whether the contribution is based on what the employee or employer will pay to cover the cost of the plan. · Unspecified, Employer, Employee
contributions.contributionGroupings.tierMonthlyContributions.contributionTypestring✓Defines whether the contribution is represented as a percent or a flat dollar amount. · Unspecified, Percentage, FlatDollarAmount
contributions.contributionGroupings.tierMonthlyContributions.contributionnumber✓The actual amount or percent that an employee or employee will pay to cover the cost of the plan.
contributions.contributionGroupings.tierMonthlyContributions.upToContributionAmountnumberA dollar amount that limits the overall contribution when the contributionType is percent.
EN Cancer fields   80 fields   EN schema CancerPlan · POST /Quoting/companies/{companyId}/plans/cancer/notification
— / —
EN field pathTypeReqDescription / enum
(root)
planIdentifierstring✓The unique identifier assigned for the purpose of identifying a plan. This value is the key used to link a plan between the two systems and how we will communicate about the plan. A plan is a set of benefit of rates and should not include billing groups.
configurationPlanConfiguration✓
configuration
configuration.policyNumberstringValue assigned to the plan for the specific company
configuration.carrierNamestring
configuration.planNamestring
configuration.startDatestring✓Effective date representing the most recent plan year start date for the current set of benefits and rates. Our plans couple benefits and rates together.
configuration.endDatestringEffective date representing the plan year end date for the current set of benefits and rates. Typically plans are 12-month plan years, unless policy is Issue Age and rates do not change.
configuration.nextRenewalDatestringEffective date of coverage for next annual open enrollment.
configuration.carrierPlanCodestringSpecifies a plan code assigned by the carrier to identify a plan. This value would be returned with the enrollment record.
configuration.carrierPlanTypeCodestringSpecifies a plan code assigned by the carrier to identify the plan type. This value would be returned with the enrollment record.
configuration.planBillOptionstringUnspecified, SelfBill, ListBill
configuration.isSelfFundedboolean
configuration.situsStatestringThe state in which the legal, organizational entity exists or originated. Send the State Name or the 2-character ISO abbreviation. Either value will be accepted.
configuration.benefitstring✓Medical, Dental, Vision, Life, ADAndD, VoluntaryLife, VoluntaryADAndD, ShortTermDisability, VoluntaryShortTermDisability, LongTermDisability, VoluntaryLongTermDisability, Prescription, CriticalIllness, HospitalIndemnity, PermanentLife, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Cancer, Telemedicine
configuration.originalPlanStartDatestringDate the plan initially began between the carrier and group.
configuration.carrierPlanTypeDescriptionstringA carrier-defined standardized description that categorizes plans based on common characteristics. For example, medical plans may be categorized as HMO, PPO, etc.; dental plans as DHMO, etc. Note that this description is limited to 150 characters.
(root)
planDependenciesCancer.CancerPlanDependencies
planDependencies
planDependencies.benefitEnrollmentDependencyCancer.CancerPlanBenefitEnrollmentDependency
planDependencies.benefitEnrollmentDependency.enrollmentBenefitstring✓The pre-defined benefit category a plan may be dependent upon. · Medical, Dental, Vision, Prescription, HospitalIndemnity, Tricare, IdentityProtection, LaboratoryServices, Legal, SupplementalMedical, Accident, Telemedicine
(root)
eligibilityOptionsarray of PlanEligibilityOptions
eligibilityOptions
eligibilityOptions.groupStructurePlanEligibilityGroupStructure
eligibilityOptions.groupStructure.eligibilityGroupsarray of PlanEligibilityGroupA list of employee categorizations mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.groupStructure.eligibilityGroups.eligibilityGroupCodestringA carrier-assigned, unique identifier for an employee categorization mutually agreed upon between the insurance carrier and the group with similar employment information that are all offered the same insurance plan benefit.
eligibilityOptions.eligibilityRulesPlanEligibilityRules
eligibilityOptions.eligibilityRules.waitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.waitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.waitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.entryDateRulestringUsed in conjunction with Waiting Period to define when the coverage is effective after the waiting period for a new employee. Use First of the Month Coinciding With or After rule when waiting period ending on the first of the month has entry on that day. Use First of the Month After when waiting period ending on the first of the month has entry on the first of the next month. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.terminationRulestringUsed to define the last day of coverage on loss of eligibility. · Unspecified, EndOfMonthOfTermination, EmploymentTermination, FirstOfMonthAfterEmploymentTermination
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationinteger
eligibilityOptions.eligibilityRules.reinstateCoverageGracePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehirePeriodPlanEligibilityRehirePeriod
eligibilityOptions.eligibilityRules.rehirePeriod.durationinteger
eligibilityOptions.eligibilityRules.rehirePeriod.durationTypestringUnspecified, Days, Months, Weeks
eligibilityOptions.eligibilityRules.rehireEntryDateRulestringUsed in conjunction with Rehire Period to define when coverage is effective after rehire date for employees rehired within the rehire period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriodPlanEligibilityCoverageWaitingPeriod
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationinteger
eligibilityOptions.eligibilityRules.eligibilityChangeWaitingPeriod.durationTypestringUnspecified, Days, Months, Quarters
eligibilityOptions.eligibilityRules.eligibilityChangeEntryDateRulestringUsed in conjunction with Eligibility Change Waiting Period to define when the coverage is effective after the employee becomes eligible after a classification change and completes waiting period. · Unspecified, HireDate, FirstOfMonthAfter, FirstOfMonthCoincidingWithOrAfter, FifteenthOfMonthAfter, FifteenthOfMonthCoincidingWithOrAfter
(root)
planCommunicationsPlanCommunications
planCommunications
planCommunications.marketingDescriptionstringCustomizes the employee enrollment experience with marketing information about the benefits of the plan.
planCommunications.benefitSummaryUrlstringCustomizes the employee enrollment experience with a URL hosting the benefit summary.
(root)
optionsSharedOptionsType
options
options.employeeOptionsEmployeePlanOptions
options.employeeOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
options.employeeOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
options.employeeOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
(root)
dependentOptionsMedical.MedicalDependentOptionsType
dependentOptions
dependentOptions.spouseOptionsMedical.MedicalDependentSpouseOptionsType
dependentOptions.spouseOptions.ageIneligibleintegerAge member is no longer eligible to be covered under plan.
dependentOptions.spouseOptions.allowOverageContinuationbooleanProvision enabling member to remain enrolled in plan when reaching ageIneligible.
dependentOptions.spouseOptions.requiresAgeRestrictionbooleanIndicates whether the plan requires member level age rules to be configured placing limitations on when a member would be eligible for coverage.
dependentOptions.childOptionsMedical.MedicalDependentChildOptionsType
dependentOptions.childOptions.ageIneligibleintegerAge non-student dependent child is no longer eligible.
dependentOptions.childOptions.studentAgeIneligibleintegerAge student child is no longer eligible to be covered under the plan.
dependentOptions.childOptions.dropOverageChildOnstringUsed in conjunction with AgeIneligible and StudentAgeIneligible, specifies the last day of coverage when a child becomes ineligible due to age. · Unspecified, EndOfMonth, Birthday, EndOfPlan, EndOfCalendarYear
(root)
ratesMedical.WorksiteRating
rates
rates.compositeRatesMedical.CompositeRating
rates.compositeRates.tierRatesarray of Medical.CompositeRateType
rates.compositeRates.tierRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusOne, EmployeePlusChild, EmployeePlusChildren, EmployeePlusFamily, EmployeePlusDomesticPartner, EmployeePlusSpousePlusChild, EmployeePlusTwo, EmployeePlusTwoChildren, EmployeePlusThreeChildren, EmployeePlusThree, EmployeePlusFour, EmployeePlusSpousePlusTwoChildren, EmployeePlusSpousePlusThreeChildren
rates.compositeRates.tierRates.ratenumber✓Monthly rate
rates.ageBasedRatesMedical.WorksiteAgeBasedRating
rates.ageBasedRates.optionsMedical.WorksiteAgeBasedOptionsType
rates.ageBasedRates.options.isIssueAgebooleanAn issue age policy is one in which premium is based on the age at the time the policy is issued and does not change as member ages unless a change in coverage occurs.
rates.ageBasedRates.options.issueAgeChangeRulestringRerated updates all coverage based on the age at the time of coverage change. Stacked retains the cost for the original coverage, and only calculates a new rate for the additional portion of the coverage based on the age at the time of the change. Original Issue Rated will always use the original issue age for original coverage and coverage changes. · Unspecified, ReRated, Stacked
rates.ageBasedRates.tierRatesarray of MedicalAgeBandedTieredRate
rates.ageBasedRates.tierRates.tierstring✓Unspecified, Employee, EmployeePlusSpouse, EmployeePlusOne, EmployeePlusChild, EmployeePlusChildren, EmployeePlusFamily, EmployeePlusDomesticPartner, EmployeePlusSpousePlusChild, EmployeePlusTwo, EmployeePlusTwoChildren, EmployeePlusThreeChildren, EmployeePlusThree, EmployeePlusFour, EmployeePlusSpousePlusTwoChildren, EmployeePlusSpousePlusThreeChildren
rates.ageBasedRates.tierRates.fromAgeinteger✓
rates.ageBasedRates.tierRates.toAgeinteger✓
rates.ageBasedRates.tierRates.ratenumber✓
(root)
contributionsMedical.Contribution
contributions
contributions.contributionGroupingsarray of Medical.ContributionGrouping✓A list of monthly contributions by a specified contribution grouping (e.g., everyone, by class, by department).
contributions.contributionGroupings.contributionGroupingBasedOnstringThe textual description of what the specified contribution grouping is based on.
contributions.contributionGroupings.tierMonthlyContributionsarray of Medical.MonthlyContribution✓A list of the monthly plan contributions.
contributions.contributionGroupings.tierMonthlyContributions.contributionTierstring✓Defines the universal level of contribution tiers by the employee (including dependents) covered by the plan based on the selected plan benefit type. · Unspecified, Employee, EmployeePlusSpouse, EmployeePlusOne, EmployeePlusChild, EmployeePlusChildren, EmployeePlusFamily, EmployeePlusDomesticPartner, EmployeePlusSpousePlusChild, EmployeePlusTwo, EmployeePlusTwoChildren, EmployeePlusThreeChildren, EmployeePlusThree, EmployeePlusFour, EmployeePlusSpousePlusTwoChildren, EmployeePlusSpousePlusThreeChildren
contributions.contributionGroupings.tierMonthlyContributions.contributionBasisstring✓Defines whether the contribution is based on what the employee or employer will pay to cover the cost of the plan. · Unspecified, Employer, Employee
contributions.contributionGroupings.tierMonthlyContributions.contributionTypestring✓Defines whether the contribution is represented as a percent or a flat dollar amount. · Unspecified, Percentage, FlatDollarAmount
contributions.contributionGroupings.tierMonthlyContributions.contributionnumber✓The actual amount or percent that an employee or employee will pay to cover the cost of the plan.
contributions.contributionGroupings.tierMonthlyContributions.upToContributionAmountnumberA dollar amount that limits the overall contribution when the contributionType is percent.