Page Comparison

...

Steps

Example Request

Example Response

1

Contact the VSee team to configure which insurers you want to support. Once configured, use https://vsee.atlassian.net/wiki/spaces/VD/pages/55083127#GET55083127/Insurance+API#GET-%2Finsurance%2F to pull the list which will also contain insurer_id.

Code Block
curl --location --request GET 'https://api-vclinic.vseepreview.com/vc/dev/api_v3/insurances/' \ --header 'X-ApiToken: xxxx'

Code Block

language	json

{
    "data": {
        "insurers": [
            {
                "id": "car7551",
                "name": "AETNA"
            },
            {
                "id": "car7414",
                "name": "AETNA BETTER HEALTH OF ILLINOIS"
            },
            {
                "id": "car11406",
                "name": "ANTHEM BLUE SHIELD"
            },
            {
                "id": "car7147",
                "name": "CIGNA HEALTH CARE"
            },
            {
                "id": "car7580",
                "name": "MONTGOMERY HEALTH INSURANCE"
            },
            {
                "id": "car7556",
                "name": "HEALTH CHOICE ARIZONA"
            }
        ]
    }
}

2

Create a VSee Clinic user via https://vsee.atlassian.net/wiki/spaces/VD/pages/14942243/User+API#POST-%2Fusers%2Fsso

As a response you will receive patient data on VSee side.

Code Block

curl --location --request POST 'https://api-vclinic.vseepreview.com/vc/dev/api_v3/users/sso' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiKey: xxx' \
--header 'X-ApiSecret: xxx' \
--header 'X-ApiToken: xxx' \
--form 'first_name="Edward"' \
--form 'last_name="VSee"' \
--form 'type="200"' \
--form 'code="edward+001.vclinic@vseelab.com"' \
--form 'email="edward+001.vclinic@vseelab.com"' \
--form 'dob="1986-01-01"' \
--form 'gender="1"' \
--form 'street_addr="2868 Tully Street"' \
--form 'state="Detroit"' \
--form 'city="MI"' \
--form 'zip="48226"'

Code Block

language	json

{
    "data": {
        "id": "132407",
        "code": "edward+001.vclinic@vseelab.com",
        "first_name": "Edward",
        "last_name": "VSee", \
--form 'insurance__primary__carrier_code="car11400"' \
--form 'insurance__primary__subscriber_num="10000022"' \
--form 'insurance__primary__group_number="test"' \
--form 'insurance__patient__respparty="self"' \
--form 'insurance__patient__guarantor_name="Edward VSee"' \
--form 'insurance__guarantor_dob="1986-01-01"' \
--form 'insurance__patient__guarantor_city="NY"' \
--form 'insurance__patient__guarantor_zip="10001"' \
--form 'insurance__patient__guarantor_address="test"' \
--form 'extra__th_id="123456"'

Code Block

language	json

{
    "data": {
        "full_nameid": "Edward VSee132407",
        "usernamecode": "edward+001.vclinic@vseelab.com",
        "vseeidfirst_name": "Edward",
        "last_name": "VSee",
        "full_name": "Edward VSee",
        "username": "edward+001.vclinic@vseelab.com",
        "vseeid": "ccpreview+6258012d656449b8b5e73ad964457b1f",
        "dob": "1986-01-01",
        "email": "edward+001.vclinic@vseelab.com",
        "gender": 1,
        "active": true,
        "tos": false,
        "status": 20,
        "subtype": "",
        "street_addr": "2868 Tully Street",
        "state": "Detroit",
        "city": "MI",
        "zip": "48226",
        "timezone": "America/Los_Angeles",
        "email_verified": true,
        "account_codeinsurance": "vclinic", {
            "clinicsprimary": {
   [             "vcliniccarrier_code": "car11400",
       ],         "createdsubscriber_num": 1649934637"10000022",
        "token": {             "user_id"group_number": "132407test",
            "token": "xxxx"},
            "expirypatient": {
   1650021037,             "createdrespparty": 1649934637,"self",
                "userguarantor_typename": "200Edward VSee",
                "refreshguarantor_tokencity": {"NY",
                "userguarantor_idzip": "13240710001",
                "tokenguarantor_address": "xxxx",test"
            },
            "expiryguarantor_dob": 1652526637,"1986-01-01"
        },
        "createdaccount_code": 1649934637 "vclinic",
        "clinics": [
      }      "vclinic"
  }     }
}

3

Some user fields are required if you want to use the insurance API. Use https://vsee.atlassian.net/wiki/spaces/VD/pages/14942243/User+API#POST-%2Fme to update the user’s insurance information based on patient data. Use the data.token.token from SSO response in Step 2 for the X-ApiToken header.

Code Block

curl --location --request POST 'https://api-vclinic.vseepreview.com/vc/dev/api_v3/me.json' \
--header 'X-ApiToken: xxxx' \
--form 'insurance.primary_carrier_code="car7556"' \
--form 'insurance.respparty="self"' \
--form 'insurance.primary_subscriber_num="10000022"' \
--form 'insurance.primary_group_number="10000022"' \
--form 'insurance.secondary_carrier_code="car11406"' \
--form 'insurance.secondary_group_number="10000022"' \
--form 'insurance.secondary_subscriber_num="10000022"'

Code Block

language	json

{
    "data": { ],
        "created": 1649934637,
        "token": {
            "user_id": "132407",
              "idtoken": "132407xxxx",
            "codeexpiry": "edward+001.vclinic@vseelab.com",1650021037,
            "first_namecreated": "Edward",1649934637,
            "lastuser_nametype": "VSee200",
            "fullrefresh_nametoken": "Edward VSee",
{
       "username": "edward+001.vclinic@vseelab.com",
        "vseeiduser_id": "ccpreview+6258012d656449b8b5e73ad964457b1f132407",
        "dob": "1986-01-01",
        "emailtoken": "edward+001.vclinic@vseelab.comxxxx",
 
      "gender": 1,         "activeexpiry": true1652526637,
        "tos": false,         "statuscreated": 20,1649934637
        "subtype": "",   }
     "street_addr": "2868 Tully Street",}
        "state": "Detroit",
        "city": "MI",
        "zip": "48226",
        "timezone": "America/Los_Angeles",
        "email_verified": true,
        "insurance": {
   }
}

3

Run Insurance API (Draft) | POST-/users/:id/:carrier_code/eligibility to trigger the eligibility check for the given user_id. The eligibility check may take some time. A cron job will be created. The cron job will run after 10 seconds and the response will be saved in the user_data.insurance.{primary/secondary}.eligibility_response

Use the Token provided with your API Credentials for the X-ApiToken header.

Code Block
curl --location --request POST 'https://api-vclinic.vseepreview.com/vc/dev/api_v3/users/132407/car7556/eligibility' \ --header 'X-AccountCode: vclinic' \ --header 'X-ApiToken: xxxx'

Code Block

language	json

{
    "data": {
        "primaryeligibility_id": {
       "2505465",
        "carrier_code": "car7556",
    }
}

4

Receive a webhook request with eligibility_response message which will contain the result of the eligibility check. Skip this step if the clinic doesn’t have webhook.

Code Block

language	json

{
       "id": "62583ab3-8cfc-4a47-b6c9-272850e631f8",
  "subscriber_numtype": "234234eligibility.checked",
  "created": 1649949363,
  "account_code": "vclinic",
  "data": {
    "insuranceeligibility_orderid": 1
            }"2505464",
            "secondary": {
                "carrier_code"member_id": "car11406132407",
           
    "groupeligibility_numberresponse": "asdasd",No response received by   clearinghouse",
          "subscriber_num"external_member_id": "aaaaa5991794",
                "insurance_order": 2}
}

5

If the user is eligible, trigger a claim submission process for the user_id https://vsee.atlassian.net/wiki/spaces/VD/pages/55083127/Insurance+API#POST-%2Finsurance%2Fclaims

TDB

TBD

6

Receive a webhook request which will contain the result of the claim.

TBD

POST /users/:id/edit

https://api-vclinic.vseepreview.com/vc/dev/api_v3/users/:id/edit

Update patient insurance information.

Request

Response

Code Block

curl --location --request POST 'https://api-vclinic.vseepreview.com/vc/dev/api_v3/users/123407/edit' \
--header 'X-ApiToken: xxxx' \
--form 'insurance.primary_carrier_code="car7556"' \
--form 'insurance.respparty="self"' \
--form 'insurance.primary_subscriber_num="234234"' \
--form 'insurance.group_number="test 3"' \
--form 'insurance.secondary_carrier_code="car11406"' \
--form 'insurance.secondary_group_number="asdasd"' \
--form 'insurance.secondary_subscriber_num="aaaaa"'

Code Block

language	json

{
    "data": {
        "id": "132407",
        "code": "edward+001.vclinic@vseelab.com",
        "first_name": "Edward",
        "last_name": "VSee",
        "full_name": "Edward VSee",
        "username": "edward+001.vclinic@vseelab.com",
        "vseeid": "ccpreview+6258012d656449b8b5e73ad964457b1f",
        "dob": "1986-01-01",
        "email": "edward+001.vclinic@vseelab.com",
        "gender": 1,
        "active": true,
        "tos": false,
        "status": 20,
        "subtype": "",
        "street_addr": "2868 Tully Street",
        "state": "Detroit",
        "city": "MI",
        "zip": "48226",
        "timezone": "America/Los_Angeles",
        "email_verified": true,
        "insurance": {
            "primary": {

},

patient

carrier_code":

{

"car7556",
                "

respparty

subscriber_num": "

self

234234",

}

 "insurance_order": 1

},

},

"account_code":

"vclinic",

clinics

secondary": {

[

vclinic

carrier_code": "car11406",

],

created

group_number":

1649934637

"asdasd",

} }4

Run Insurance API (Draft) | POST-/users/:id/:carrier_code/eligibility to trigger the eligibility check for the given user_id. The eligibility check may take some time. A cron job will be created. The cron job will run after 10 seconds and the response will be saved in the user_data.insurance.{primary/secondary}.eligibility_response

Use the data.token.token from SSO response in Step 2 for the X-ApiToken header.

Code Block
curl --location --request POST 'https://api-vclinic.vseepreview.com/vc/dev/api_v3/users/132407/car7556/eligibility' \ --header 'X-AccountCode: vclinic' \ --header 'X-ApiToken: xxxx'

Code Block

language	json

{

           "subscriber_num": "aaaaa",
                "insurance_order": 2
            },
            "

data

patient": {
                "

eligibility_id

respparty": "

2505465

self"

,

"carrier_code":

"car7556"

}

}5

Receive a webhook request with eligibility_response message which will contain the result of the eligibility check. Skip this step if the clinic doesn’t have webhook

Code Block

language	json

{

"id":

"62583ab3-8cfc-4a47-b6c9-272850e631f8",

},

"type":

"eligibility.checked",

"created":

1649949363,

   "account_code": "vclinic",

"data":

{

eligibility_id

clinics":

"2505464",

"member_id":

"132407",

eligibility_response": "No response received by clearinghouse",

vclinic"
        ],
        "

external_member_id

created": 1649934637

"5991794"

}
}

6

If the user is eligible, trigger a claim submission process for the user_id https://vsee.atlassian.net/wiki/spaces/VD/pages/55083127#POST-%2Finsurance%2Fclaims

TDB

TBD

7

Receive a webhook request which will contain the result of the claim.

TBD

POST /me

https://api-vclinic.vseepreview.com/vc/dev/api_v3/me.json

Setup the required patient insurance information for eligibility check.

Request

Response

Code Block

curl --location --request POST 'https://api-vclinic.vseepreview.com/vc/dev/api_v3/me.json' \
--header 'X-ApiToken: xxxx' \
--form 'insurance.primary_carrier_code="car7556"' \
--form 'insurance.respparty="self"' \
--form 'insurance.primary_subscriber_num="234234"' \
--form 'insurance.group_number="test 3"' \
--form 'insurance.secondary_carrier_code="car11406"' \
--form 'insurance.secondary_group_number="asdasd"' \
--form 'insurance.secondary_subscriber_num="aaaaa"'

Code Block

language	json

{
    "data": {
        "id": "132407",
        "code": "edward+001.vclinic@vseelab.com",
        "first_name": "Edward",
        "last_name": "VSee",
        "full_name": "Edward VSee",
        "username": "edward+001.vclinic@vseelab.com",
        "vseeid": "ccpreview+6258012d656449b8b5e73ad964457b1f",
        "dob": "1986-01-01",
        "email": "edward+001.vclinic@vseelab.com",
        "gender": 1,
        "active": true,
        "tos": false,
        "status": 20,
        "subtype": "",
        "street_addr": "2868 Tully Street",
        "state": "Detroit",
        "city": "MI",
        "zip": "48226",
        "timezone": "America/Los_Angeles",
        "email_verified": true,
        "insurance": {
            "primary": {
                "carrier_code": "car7556",
                "subscriber_num": "234234",
                "insurance_order": 1
            },
            "secondary": {
                "carrier_code": "car11406",
                "group_number": "asdasd",
                "subscriber_num": "aaaaa",
                "insurance_order": 2
            },
            "patient": {
                "respparty": "self"
            }
        },
        "account_code": "vclinic",
        "clinics": [
            "vclinic"
        ],
        "created": 1649934637
    }
}

Required Insurance Information

...

Versions Compared

Old Version 40

New Version 41

Key

POST /users/:id/edit

POST /me

Required Insurance Information