Insurance Policy

An insurance policy is the contract between the policyholder and an insurance company that provides financial protection in case of sickness or an accident.

The insurance policy model

Properties

Name
id
Type
string
Description
Unique identifier for the insurance policy.
Name
object
Type
string
Description
Always 'insurance_policy'.
Name
patient
Type
string
Description
Patient this insurance policy is associated with.
Name
policyholder
Type
object
Description
Policyholder of the insurance policy.
Name
insurance_card
Type
object
Description
Insurance card for the insurance policy.
Name
type
Type
string
Description
Type of insurance policy. There can only be one primary insurance policy, one secondary insurance policy, and one tertiary insurance policy. There can be unlimited inactive insurance policies.
Possible values:
primary
secondary
tertiary
inactive
Name
created_by
Type
string
Description
Creator of the insurance policy.
Name
created_at
Type
date-time
Description
Timestamp (in ISO 8601 timestamp) of when the insurance policy was created.
Name
last_updated_at
Type
date-time
Description
Timestamp (in ISO 8601 timestamp) of when this insurance policy was last updated.

Response

{
    "id": "iply_GHY5mso3NpQP90bNHhpp",
    "object": "insurance_policy",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "policyholder": {
        "patient_relationship_to_policyholder": "self"
    },
    "insurance_card": {
        "payer_id": "47198",
        "payer_name": "ANTHEM BLUE CROSS",
        "plan_name": "SELECT",
        "plan_type: "12",
        "member_id": "DB9989"
        "group_number": "C019989",
        "rx_bin": "1833",
        "rx_pcn": "1390"
    },
    
    "created_by": "user_Z1zXZKvqrpwxbznuW6lJ",
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
}

POST/v2/insurance_policies

Create an insurance policy

Creates a new insurance policy.

Required attributes

Name
patient
Type
string
Description
Patient this insurance policy is associated with.
Name
type
Type
string
Description
Type of insurance policy. There can only be one primary insurance policy, one secondary insurance policy, and one tertiary insurance policy. There can be unlimited inactive insurance policies.
Possible values:
primary
secondary
tertiary
inactive

Optional attributes

Name
policyholder
Type
object
Description
Policyholder of the insurance policy.
Name
insurance_card
Type
object
Description
Insurance card for the insurance policy.

Response

 {
    "id": "iply_GHY5mso3NpQP90bNHhpp",
    "object": "insurance_policy",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "policyholder": {
        "patient_relationship_to_policyholder": "self"
    },
    "insurance_card": {
        "payer_id": "47198",
        "payer_name": "ANTHEM BLUE CROSS",
        "plan_name": "SELECT",
        "plan_type: "12",
        "member_id": "DB9989"
        "group_number": "C019989",
        "rx_bin": "1833",
        "rx_pcn": "1390"
    },
    
    "created_by": "user_Z1zXZKvqrpwxbznuW6lJ",
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
}

GET/v2/insurance_policies/:id

Retrieve an insurance policy

Retrieves the specified insurance policy.

Response


 {
   "id": "iply_GHY5mso3NpQP90bNHhpp",
   "object": "insurance_policy",
   "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
   "policyholder": {
       "patient_relationship_to_policyholder": "self"
   },
   "insurance_card": {
       "payer_id": "47198",
       "payer_name": "ANTHEM BLUE CROSS",
       "plan_name": "SELECT",
       "plan_type: "12",
       "member_id": "DB9989"
       "group_number": "C019989",
       "rx_bin": "1833",
       "rx_pcn": "1390"
   },

   "created_by": "user_Z1zXZKvqrpwxbznuW6lJ",
   "created_at": "2024-04-10T13:20:21.724Z",
   "last_updated_at": "2024-04-10T13:20:21.724Z"
 }

POST/v2/insurance_policies/:id

Update an insurance policy

Updates the specified insurance policy object by setting the values of the parameters passed. Any other parameters not provided will not be modified.

Required attributes

Optional attributes

Name
type
Type
string
Description
Type of insurance policy. There can only be one primary insurance policy, one secondary insurance policy, and one tertiary insurance policy. There can be unlimited inactive insurance policies.
Possible values:
primary
secondary
tertiary
inactive
Name
policyholder
Type
object
Description
Policyholder of the insurance policy.
Name
insurance_card
Type
object
Description
Insurance card for the insurance policy.

Response


  {
    "id": "iply_GHY5mso3NpQP90bNHhpp",
    "object": "insurance_policy",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "policyholder": {
        "patient_relationship_to_policyholder": "self"
    },
    "insurance_card": {
        "payer_id": "47198",
        "payer_name": "ANTHEM BLUE CROSS",
        "plan_name": "SELECT",
        "plan_type: "12",
        "member_id": "DB9989"
        "group_number": "C019989",
        "rx_bin": "1833",
        "rx_pcn": "1390"
    },

    "created_by": "user_Z1zXZKvqrpwxbznuW6lJ",
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
  }

GET/v2/insurance_policies

List all insurance policies

Returns a list of all insurance policies.

Response

{
  "object": "list",
  "data": [
    {
        "id": "iply_GHY5mso3NpQP90bNHhpp",
        "object": "insurance_policy",
        "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
        "policyholder": {
            "patient_relationship_to_policyholder": "self"
        },
        "insurance_card": {
            "payer_id": "47198",
            "payer_name": "ANTHEM BLUE CROSS",
            "plan_name": "SELECT",
            "plan_type: "12",
            "member_id": "DB9989"
            "group_number": "C019989",
            "rx_bin": "1833",
            "rx_pcn": "1390"
        },

        "created_by": "user_Z1zXZKvqrpwxbznuW6lJ",
        "created_at": "2024-04-10T13:20:21.724Z",
        "last_updated_at": "2024-04-10T13:20:21.724Z"
    },
  ]
}

DELETE/v2/insurance_policies/:id

Delete an insurance policy

Deletes the specified insurance policy.

Required attributes

Optional attributes

Response

{
    "id": "iply_GHY5mso3NpQP90bNHhpp",
    "object": "insurance_policy",
    "delete": true
}