New Hire (NHE)
The Member Request workflow is now deprecated in favor of Member Snapshot
New Hire Enrollment
The new hire member request is used to add an existing employee, and optionally their dependents to multiple coverages at multiple carriers.
Create New Hire Enrollment Member Request
Creating Employees and Dependents
Prior to adding an employee and dependent(s) to coverage, you should ensure they have been created in the Noyo system via the create employee and create dependent endpoints. Note: The hire_date
of the employee will be sent to the carrier and the beginning of the coverage will be computed by the carrier according to the waiting period for the group.
The Coverages Object
The coverages
array contains one entry for each carrier with which you would like to enroll or waive coverage. The carrier_id
along with the schema of the carrier_config
object will be provided by the Noyo team. You can reference the group carrier configuration resource 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 |
Signature Date
Within each entry in the 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 |
Enrolling Members
You must provide an enrolling_members
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 group plans endpoint.
Enrolling in medical
, dental
, vision
, accident
, cancer
or hospital_indemnity
medical
, dental
, vision
, accident
, cancer
or hospital_indemnity
Medical, dental, vision, accident, cancer and hospital 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 adding coverage. One of: dependent , employee |
plan_id | uuid | Unique identifier of the group plan in Noyo |
Enrolling in life
, add
, std
, ltd
or critical_illness
life
, add
, std
, ltd
or critical_illness
Life, AD&D, STD, LTD and critical illness coverage also optionally accept volume
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 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 |
Waiving Members
You can provide a waiving_members
entry for each employee or dependent that is waiving coverage with the carrier along with the reason
for waiving the coverage. This information will be communicated with the carrier where applicable. If you did not capture this information and only have the enrolling_members
information, the API request will still succeed.
id * | uuid | Unique identifier of the employee or dependent in Noyo |
member_type * | string | Type of member waiving coverage. One of: dependent , employee |
plan_id | uuid | Unique identifier of the group plan in Noyo |
reason * | string | Reason the member is waiving 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 |
New Hire Member Request Result
Sample Request Result
{
"dental": [{
"member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
}, {
"member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
}],
"vision": [{
"member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
}, {
"member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
}]
}
Upon the successful completion of all the transactions in the new hire member request, the 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 |
New Hire Transactions
Code Sample
curl -X GET
--header "Authorization: Bearer <ACCESS_TOKEN>"
https://fulfillment.noyo.com/api/v1/member_transactions/a6e30204-87b2-4802-95a4-a156bd0f7435
Example Response
{
"id": "a6e30204-87b2-4802-95a4-a156bd0f7435",
"member_request_id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
"employee_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
"lines_of_coverage": [
"dental",
"vision"
],
"status": "processing",
"type": "carrier_new_hire",
"body": {
"carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
"lines_of_coverage": {
"dental": {
"enrolling_members": [{
"id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
}, {
"id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
}]
},
"vision": {
"enrolling_members": [{
"id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
}, {
"id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
}]
}
}
}
}
A new hire transaction is created for each entry in the coverages
array (i.e. one transaction per carrier) with a type
of carrier_new_hire
.
New Hire Member Transaction completed
Result
completed
ResultUpon the successful completion of the transaction, the status
of the member transaction will be updated to completed
and the result
of the member transaction will be in the same format as the member request result.
Updated 2 months ago