Employment Classifications

Create Employment Classifications for a Group

Using the id of the Group you've loaded in, you can define Employment Classifications. Employment Classifications are used to categorize members with codes that help with billing.

In many cases, a carrier's policy will not require the platform to maintain classifications, and instead, these values can be configured by Ideon's operations team.

n select cases, a Partner will need to map values from their system to classifications that are created, either by Ideon or that they themselves created.

The type of Employment Classifications that can be created and configured are: class, subgroup, division, region and department.

In order to create an Employment Classification:

1. Formulate the Request

2. Send Request / Receive Response

Formulate the Request

When loading each classification, you can optionally provide a carrier_identifier, which Ideon will ensure is represented accurately based on the account structure before communicating it to the carrier.

The external_identifier can be used as a link to an identifier in your system to help you manage the resource across systems.

If a corresponding type is not found in your system, or you are unsure which to use, the Ideon team can assist in mapping, and our configuration can later override any type used to ensure we accurately transmit data to the carrier.

Request Body:

POST /groups/:id/employment_classifications

{
  "employment_classification": {
    "external_identifier": "Class1",
    "carrier_identifier": "A001",
    "description": "All Eligible Employees in California",
    "start_date": "2020-01-01",
    "end_date": "2020-12-31",
    "type": "class"
  }
}

Ideon will ensure employment classifications are represented based on the account structure before communicating it to the carrier.

Send Request / Receive Response

The request is sent to Ideon using a POST /groups/:id/employment_classifications endpoint.

Ideon will provide one of two responses to the requestor.

• The first option is that the request was received successfully and the coverage period was created on our system: 201 - Resource Created Successfully.

• The second option is that syntax and semantic errors exist: 422 - Unprocessable Entity. This includes the violation of carrier specific business rules.

Success

If the request passes validation, the requestor will be informed of the successful receipt and provided a copy of the Employment Classification. In the response body the requestor will find the UUID associated with resource, which is used to assign to subscribers: employment_classification.id. Typically, Groups have several Employment Classifications, so you can create as many as are required.

Response Body:

{
  "employment_classification": {
    "external_identifier": "Class1",
    "carrier_identifier": "A001",
    "description": "All Eligible Employees in California",
    "start_date": "2023-01-01",
    "end_date": "2023-12-31",
    "id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
    "type": "class"
  }
}