event
parameter in the body which provides information about the type of the event as well as the date of its occurance. The schema for the event
must follow this structure:
event_type * | string | Qualifying life event type. One of: adoption , change_to_full_time , change_to_part_time , classifications_change , court_order , death , dependent_open_enrollment , divorce , foster_care , immigration_status_change , legal_guardian , lost_coverage , marriage , medicare , moved , newborn , offline_change , rate_changed , rehire , reinstatement |
event_date * | string | ISO-8601 date string for qualifying life event date |
Value | Description |
---|---|
adoption | This applies in the event that a member is looking to either add or remove coverage as a result of an adoption. |
change_to_full_time | This is often tied to benefit class or time status changes. |
change_to_part_time | This is often tied to a reduction of hours or a benefit class change. |
court_order | This is also sometimes known as QMCSO (qualified medical child support orders). |
death | This is applicable to employee, child, or spouse deaths and can be passed when adding or removing coverage due to death. Sending this is useful clarification in survivorship scenarios. |
dependent_open_enrollment | This refers to a case in which the dependent is removing themselves from another member’s coverage and going through their own open enrollment. |
divorce | This applies in the event that a member is looking to either add or remove coverage as a result of a divorce. |
foster_care | This refers to a member adding a foster child to coverage. |
immigration_status_change | This can refer to a case in which the spouse obtains a green card and is then added to member’s coverage. |
legal_guardian | This is applicable when a member becomes a legal guardian for a child and adds the child to coverage. |
lost_coverage | This is a catch-all for when a member is losing coverage not due to any other QLEs mentioned above. This is applicable when adding someone to coverage due to lost coverage elsewhere and also when removing them from coverage. |
marriage | This applies in the event that a member is looking to either add or remove coverage as a result of a marriage. |
medicare | This is applicable when a member gains medicare coverage or when member loses medicare coverage. |
moved | In this scenario, an address change makes someone either eligible or ineligible for coverage. |
newborn | This applies in the event that a member is looking to either add or remove coverage as a result of the birth of a child. |
offline_change | A change made outside of conventional open enrollment or special enrollment periods. |
rate_changed | This refers to a specific case in which a rate changes after the employee elects coverage. Some benefits administration platforms allow the employee to reselect coverage if they are dissatisfied with the new rates in these cases. |
rehire | Noyo currently makes no distinction between rehire and reinstatement cases. This code is applicable in both cases. |
reinstatement | Coverage is being resumed after a gap. |
coverages
array contains one entry for each carrier with which you would like to make changes to coverage. The carrier_id
along with the schema of the carrier_config
object will be provided by the Noyo team. You can reference the Get carrier configuration by group list to get additional carrier-specific data. The lines_of_coverage
object allows the following keys:
Key | Description |
---|---|
accident | Accident |
add | Accidental Death & Dismemberment |
cancer | Cancer |
critical_illness | Critical Illness |
dental | Dental |
hospital_indemnity | Hospital Indemnity |
life | Life |
ltd | Long Term Disability |
medical | Medical |
std | Short Term Disability |
vision | Vision |
coverages
array you can optionally specify a signature_date
. The signature_date
is the date when the employee or employer signed for the change to be made. If a signature_date
is not provided we will communicate the date the member request was received by the Noyo system as the signature_date
to the carrier.
signature_date | string | ISO-8601 date string for signature date |
lines_of_coverage
you may provide three different actions: adding_coverage
, removing_coverage
, and modifying_coverage
. More information about each of these is below.
adding_coverage
action is used to add new coverage for a member with a carrier. You must provide an adding_coverage
entry for each employee or dependent that is enrolling in coverage with the carrier. The plan_id
field is optional in each action. If you do not specify a plan_id
, we will try to automatically select an available plan for the member based on the current group plans. When the group has more than one eligible plan for a member, you will need to specify the plan_id
in the request. Plan IDs can be retrieved using the Get group plan list endpoint.
medical
, dental
, vision
, accident
, cancer
or hospital_indemnity
coveragelife
, add
, std
, ltd
or critical_illness
coveragevolume
parameter in dollars (e.g. $50,000 should be sent as 50000
).
Field | Type | Description |
---|---|---|
id | uuid | Unique identifier for the coverage |
member_type | string | Type of member adding coverage. One of: dependent , employee |
plan_id | uuid | Unique identifier of the group plan in Noyo |
volume | integer | Elected volume for the type of coverage being selected |
prior_coverage | object |
|
removing_coverage
action is used to remove coverage from a member with a carrier. The structure of the removing_coverage
action is below:
id * | uuid | Unique identifier of the employee or dependent in Noyo |
member_type * | string | Type of member removing coverage. One of: dependent , employee |
plan_id | uuid | Unique identifier of the group plan in Noyo |
reason * | string | Reason the member is removing or canceling coverage. One of: medi-cal , medicaid , no-coverage , other-cobra , other-employee-group , other-ind-off-exchange , other-ind-on-exchange , other-medicare , other-parent-group , other-spouse-group , retiree-coverage , tricare-coverage , va-coverage , voluntary-withdrawal |
modifying_coverage
action is used to make changes to an existing coverage for a member / plan combination, given that the member already has coverage on that plan with the carrier. For example, you can use the modifying_coverage
action to change the volume of coverage for a member’s existing life or disability plan, or provide a new carrier_config
to remain on the same plan but move the member into a new subgroup or benefit class.
medical
, dental
, vision
, accident
, cancer
or hospital_indemnity
coveragehospital_indemnity
coverage do not require any information beyond the member information and the selected plan.
id * | uuid | Unique identifier of the employee or dependent in Noyo |
member_type * | string | Type of member modifying coverage. One of: dependent , employee |
plan_id | uuid | Unique identifier of the group plan in Noyo |
life
, add
, std
, ltd
and critical_illness
coveragevolume
parameter in dollars (e.g. $50,000 should be sent as 50000
).
id * | uuid | Unique identifier of the employee or dependent in Noyo |
member_type * | string | Type of member modifying coverage. One of: dependent , employee |
plan_id | uuid | Unique identifier of the group plan in Noyo |
volume ˢ | integer | Elected volume for the type of coverage being selected |
Sample Request Result
status
of the member request will be updated to completed
and the result
of the member request will be an object with a key for each coverage (e.g. dental
, vision
) and an array with the following:
member_id * | uuid | Unique identifier of the employee or dependent in Noyo |
member_type * | string | Type of member for the member enrollment result. One of: dependent , employee |
individual_enrollment_id * | uuid | Unique identifier of the individual enrollment in Noyo created by the member request |
coverages
array. For some carriers, there may be a single transaction including all of the requested changes, while other carriers may require separate transactions for each action type (i.e. one transaction per action per carrier).
completed
Resultstatus
of the member transaction will be updated and the result
of the member transaction will be in the same format as the member request result.