Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Check Eligibility and Claims Submission Workflow

You have patient’s demographics information and patient’s insurance information.

You want to check if the patient is eligible for the procedure / visit.

...

Steps

...

Example Request

...

Example Response

...

Contact the VSee team to configure which insurers you want to support. Once configured, use https://vsee.atlassian.net/wiki/spaces/VD/pages/55083127/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'

...

languagejson

...

Create / update delete / retrieve insurance detail

Info

The following APIs can be called using patient’s token or Clinic Admin token

GET api_v3/users/:user_id/insurances
Status
colourYellow
titleV3

This returns a list of insurance cards associated with this user

Expand
titleResponse (200)
Code Block
languagejson
{
    "data": [
        {
        

...

    "card_type": 

...

"primary",
            

...

"insurer_code": "(sandbox) HUMANA",
            

...

"

...

subscriber_number": "

...

11000022",

...


            "

...

group_number": "

...

GN00022",
            

...

"responsible_party": "self",
            

...

"guarantor_first_name": "VSee",
            "

...

guarantor_middle_name": "

...

Edward",
            

...

"guarantor_last_name": "

...

Patient 11000022",
            

...

"guarantor_dob": "1986-01-01",
          

...

  

...

"guarantor_gender": 1,
            "

...

guarantor_address": "

...

54 Rainbow St",
            

...

"guarantor_address_2": "

...

#12-22",

...

 

...

           

...

"guarantor_city": "Sunnyvale",
            

...

"guarantor_zip": "10001",
            "

...

guarantor_state": "

...

CA",

...


            

...

"

...

consent": 

...

true
        

...

},
        

...

{

...


            

...

"

...

card_type": "

...

secondary",
            

...

"insurer_code": "

...

(sandbox) 

...

CALIFORNIA 

...

MEDICAL",
           

...

 "subscriber_num": "11000023",
            

...

"responsible_party": "child",
            

...

"guarantor_first_name": "

...

VSee",
            "guarantor_last_name": "Patient 11000023",
            "guarantor_middle_name": "Edward"

...

,

...

 

...

           "guarantor_dob": 

...

"1944-01-01",
         

...

   "guarantor_gender": 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.

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

languagejson

...

 "guarantor_address": "52 Rainbow St",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        }
    ],
    "version": "2.0"
}

POST api_v3/users/{user_id}/insurances/import
Status
colourYellow
titleV3

  • Payload should include array of up to 2 insurance detail, one is primary and the other is secondary

  • If insurance type already exists, it will be overwritten

Expand
titleRequest payload
Code Block
languagejson
{
    "insurances": [
        {
            "card_type": "primary",
            "insurer_code": "(sandbox) HUMANA",
            "subscriber_number": "11000022",
            "

...

group_number": "

...

GN00022",
            "

...

responsible_party": "

...

self",
            "guarantor_first_name": "

...

VSee",
            "guarantor_last_name": "

...

Patient 11000022",
            "

...

guarantor_middle_name": "Edward

...

",
            "

...

guarantor_dob": "

...

1986-01-01",
        

...

    "guarantor_gender": 

...

1,
        

...

    "guarantor_address": "

...

54 Rainbow St",
            "

...

guarantor_address_2": "

...

#12-22",
        

...

    "guarantor_city": 

...

"Sunnyvale",
         

...

   "guarantor_zip": 

...

"10001",
        

...

    "guarantor_state": 

...

"CA",
            "

...

consent": 

...

true
        

...

},
        {

...

 

...

 

...

 

...

         "

...

card_type": "

...

secondary",
            "

...

insurer_code": "

...

(sandbox) CALIFORNIA MEDICAL",
            "

...

subscriber_number": "

...

11000023",
         

...

   "responsible_party": "

...

child",

...


    

...

 

...

       

...

"guarantor_first_name": 

...

"VSee",
            "

...

guarantor_last_name": 

...

"Patient 11000023",
            "

...

guarantor_middle_

...

name": "

...

Edward",

...


            

...

"

...

guarantor_

...

dob": "

...

1944-01-01",

...


            

...

"

...

guarantor_

...

gender": 

...

2,
            

...

"guarantor_address": 

...

"52 Rainbow 

...

St",
            

...

"

...

guarantor_city": "

...

Sunnyvale",

...


            "guarantor_

...

zip": "

...

10001",
            

...

"guarantor_

...

state": "

...

CA",
            "consent": 

...

true
 

...

 

...

      }
    ]
}
Expand
titleResponse (200)
Code Block
languagejson
{
    "

...

data": 

...

[
        {
   

...

         

...

"

...

card_

...

type": "

...

primary",
   

...

         "

...

insurer_code": "

...

(sandbox) HUMANA",
         

...

   "subscriber_number": 

...

"11000022",
            "

...

group_number": "GN00022",
       

...

     "responsible_party": "self",
  

...

 

...

         "

...

guarantor_first_name": 

...

"VSee",
            "

...

guarantor_middle_

...

name": "

...

Edward",
            "

...

guarantor_last_name": "

...

Patient 11000022",
            "

...

guarantor_dob": 

...

"1986-01-01",
            "

...

guarantor_gender": 

...

1,
            "

...

guarantor_

...

address": "

...

54 Rainbow St",
            "

...

guarantor_address_

...

2":

...

 "#12-22",
            "guarantor_city": "Sunnyvale",
    

...

        "guarantor_zip": "

...

10001",
            

...

"guarantor_state": "

...

CA",
            "consent": true
       

...

 

...

},
        {
            "

...

card_type": 

...

"secondary",
            

...

"insurer_code": "(sandbox) CALIFORNIA MEDICAL",
      

...

     

...

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
languagejson
{
    "data": {
        "eligibility_id": "2505465",
        "carrier_code": "car7556"
    }
}

...

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
languagejson
{
  "id": "62583ab3-8cfc-4a47-b6c9-272850e631f8",
  "type": "eligibility.checked",
  "created": 1649949363,
  "account_code": "vclinic",
  "data": {
    "eligibility_id": "2505464",
    "member_id": "132407",
    "eligibility_response": "No response received by clearinghouse",
    "external_member_id": "5991794"
  }
}

...

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

...

Code Block
curl --location --request POST 'https://api-vclinic.vseepreview.com/vc/devapi_v3/insurances/claims' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiKey: xxx' \
--header 'X-ApiSecret: xxx' \
--header 'X-ApiToken: xxx' \
--data-raw '{
    "member_id": "2186945",
    "date_of_service": "08/19/2022",
    "location": "41",
    "charge_list": [
        {
            "procedure_code": "10022",
            "units": 1,
            "diagnosis_code": "Z20.822 R05.9"
        },
         {
            "procedure_code": "10022",
            "units": 1,
            "diagnosis_code": "Z20.822"
        }
    ]
}'

...

Code Block
languagejson
{
  "data": {
    "id": "82828",
  }
}

...

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

...

TBD

...

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 'first_name="Edward"' \
--form 'last_name="VSee"' \
--form 'dob="1986-01-01"' \
--form 'gender="1"' \
--form 'street_addr="2868 Tully Street"' \
--form 'state="Detroit"' \
--form 'city="MI"' \
--form 'zip="48226"' \
--form 'insurance__primary__carrier_code="car11400"' \
--form 'insurance__primary__subscriber_num="10000022"' \
--form 'insurance__primary__group_number="test"' \
--form 'insurance__primary__card_front="card_front_url"' \
--form 'insurance__primary__card_back="card_back_url"' \
--form 'insurance__secondary__carrier_code="car11406"' \
--form 'insurance__secondary__group_number="XX1243"' \
--form 'insurance__secondary__subscriber_num="5678"' \
--form 'insurance__secondary__card_front="card_front_url"' \
--form 'insurance__secondary__card_back="card_back_url"' \
--form 'insurance__patient__respparty="self"' \
--form 'insurance__patient__guarantor_name="Edward VSee"' \
--form 'insurance__patient__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
languagejson
{
    "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": "XX1243",
                "subscriber_num": "5678",
                "insurance_order": 2
            },
            "patient": {
                "respparty": "self"
            }
        },
        "account_code": "vclinic",
        "clinics": [
            "vclinic"
        ],
        "created": 1649934637
    }
}

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="XX1243"' \
--form 'insurance.secondary_subscriber_num="5678"'

...

Code Block
languagejson
{
    "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": "XX1243",
                "subscriber_num": "5678",
                "insurance_order": 2
            },
            "patient": {
                "respparty": "self"
            }
        },
        "account_code": "vclinic",
        "clinics": [
            "vclinic"
        ],
        "created": 1649934637
    }
}

Required Insurance Information

Code Block
FirstName - first_name
LastName - last_name
DOB - dob
Gender - gender
Address - street_addr
City - city
State - state
ZipCode - zip

Relationship to Insured - insurance.respparty (e.g self, child, spouse, other)

// Primary Insurance Fields
Primary Insurance - insurance.primary_carrier_code (insurer_id)
Primary Insurance Group Number - insurance.primary_group_number
Primary Insurance Subscriber Number - insurance.primary_subscriber_num
Primary Insurance Card Front - insurance.primary_card_front
Primary Insurance Card Back - insurance.primary_card_back

// Secondary Insurance Fields
Secondary Insurance - insurance.secondary_carrier_code (insurer_id)
Secondary Insurance Group Number - insurance.secondary_group_number
Secondary Insurance Subscriber Number - insurance.secondary_subscriber_num
Secondary Insurance Card Front - insurance.secondary_card_front
Secondary Insurance Card Back - insurance.secondary_card_back

If Relationship to Insured is child, spouse, other:
Guarantor Name - insurance.guarantor_name
Guarantor DOB  - insurance.guarantor_dob
Guarantor Address1 - insurance.guarantor_address
Guarantor City - insurance.guarantor_city
Guarantor State - insurance.guarantor_state
Guarantor Zip -  - insurance.guarantor_zip

POST /users/:id/:carrier_code/eligibility

https://api-vclinic.vseepreview.com/vc/next/api_v3/users/:id/:carrier_code/eligibility

Check insurance eligibility for the given patient. This assumes all required insurance data is saved for this user.

Set insurance data with https://vsee.atlassian.net/wiki/spaces/VD/pages/14942243/User+API#POST-%2Fme

VSee will create a patient record in AdvancedMD as needed if it’s not existing yet.

Result

Since the check may take up to 5 seconds to 1 minute, a webhook eligibility.checked is triggered when it is ready.

Response

Code Block
languagejson
{
    "data": {
        "eligibility_id": "2505465",
        "carrier_code": "car7556"
    }
}

In case of error / missing data we should display a proper error message.

Raw Data in user_datas

It will populate the user’s primary insurance or secondary insurance eligibility response fields when response received from the 3rd party.

Code Block
languagejson
{ "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, "insurance_coverage_id": "3708039", "eligibility_id": "2505465", "last_checked": 1649950742, "eligibility_response": "No response received by clearinghouse", "eligibility_text": "The payer response contains invalid or non compliant data.(70002)", "raw_response": { "?xml": { "@version": "1.0", "@encoding": "ISO-8859-1" }, "PPMDResults": { "@s": "PRDAPI1WFEYU1PO", "@lst": "4/14/2022 8:39:02 AM", "Results": { "@eligibilityid": "2505465", "@eligibilitystatusid": "1", "@eligibilitycreatedat": "04/14/2022 8:38AM", "@eligibilitychangedat": "04/14/2022 8:38AM", "@eligibilityresponsedate": "04/14/2022 8:38AM", "@patientname": "VSEE,EDWARD", "@address2": "2868 TULLY STREET", "@city": "MI", "@state": "DET", "@zipcode": "48226 ", "@dob": "1986-01-01T00:00:00", "@subscriberid": "234234", "@eligibilitystc": "30", "Edi271": { "@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", "@xmlns:xsd": "http://www.w3.org/2001/XMLSchema", "InterchangeControlHeader": { "@ISA01_AuthorizationInformationQualifier": "00", "@ISA02_AuthorizationInformation": " ", "@ISA03_SecurityInformationQualifier": "00", "@ISA04_SecurityInformation": " ", "@ISA05_SenderInterchangeIdQualifier": "ZZ", "@ISA06_SendersInterchangeId": "MCKESSON_TSH ", "@ISA07_ReceiverInterchangeIdQualifier": "ZZ", "@ISA08_ReceiversInterchangeId": "007454 ", "@ISA09_Date": "220414", "@ISA10_Time": "1038", "@ISA11_InterchangeStandardsIdentifier": "|", "@ISA12_InterchangeVersionId": "00501", "@ISA13_InterchangeControlNumber": "000000001", "@ISA14_AcknowledgementRequested": "0", "@ISA15_TestIndicator": "P", "@ISA16_SubElementDelimeter": ":" }, "FunctionalGroupHeader": { "@GS01_FunctionalIdentifierCode": "HB", "@GS02_ApplicationSendersCode": "ZZDEMO", "@GS03_ApplicationReceiversCode": "025924AMD", "@GS04_Date": "20220414", "@GS05_Time": "103848", "@GS06_GroupControlNumber": "314159265", "@GS07_ResponsibleAgencyCode": "X", "@GS08_VersionIdentificationCode": "005010X279A1" }, "TransactionSets": { "TransactionSet": { "Header": { "STSegment": { "@ST01_TransactionSetIdentifierCode": "271", "@ST02_TransactionSetControlNumber": "000000001", "@ST03_ImplementationConventionReference": "005010X279A1" }, "BHTSegment": { "@BHT01_HierarchicalStructuralCode": "0022", "@BHT02_TransactionSetPurposeCode": "11", "@BHT03_ReferenceIdentification": "Prod9917412505465", "@BHT04_Date": "20220414", "@BHT05_Time": "103848" } }, "InformationSourceDetail": { "InformationSourceLevel": { "InformationSourceLevel": { "@HL01_HierarchicalIdNumber": "1", "@HL03_HierarchicalLevelCode": "20", "@HL04_HierarchicaChildCode": "1" } }, "InformationSourceName": { "InformationSourceName": { "@NM101_EntityIdentifierCode": "PR", "@NM102_EntityTypeQualifier": "2", "@NM103_LastOrOrganizationalName": "HEALTH CHOICE ARIZONA", "@NM108_IdentificationCodeQualifier": "PI", "@NM109_IdentificationCode": "ZZDEMO" }, "RequestValidations": { "AAASegment": { "@AAA01_ConditionOrResponseCode": "N", "@AAA03_RejectReasonCode": "80", "@AAA04_FollowUpActionCode": "R" } } } }, "InformationReceiverDetail": { "InformationReceiverLevel": { "ReceiverLevel": { "@HL01_HierarchicalIdNumber": "2", "@HL02_HierarchicalParentIdNumber": "1", "@HL03_HierarchicalLevelCode": "21", "@HL04_HierarchicaChildCode": "1" } }, "InformationReceiverName": { "ReceiverName": { "@NM101_EntityIdentifierCode": "1P", "@NM102_EntityTypeQualifier": "1", "@NM103_LastOrOrganizationalName": "JONES", "@NM104_FirstName": "CAMERON", "@NM108_IdentificationCodeQualifier": "XX", "@NM109_IdentificationCode": "2133321234" } } }, "SubscriberDetail": { "HierarchicalLevel": { "@HL01_HierarchicalIdNumber": "3", "@HL02_HierarchicalParentIdNumber": "2", "@HL03_HierarchicalLevelCode": "22", "@HL04_HierarchicaChildCode": "0" }, "Name": { "Name": { "@NM101_EntityIdentifierCode": "IL", "@NM102_EntityTypeQualifier": "1", "@NM103_LastOrOrganizationalName": "VSEE", "@NM104_FirstName": "EDWARD", "@NM108_IdentificationCodeQualifier": "MI", "@NM109_IdentificationCode": "234234" }, "EligibilityOrBenefitInformation": { "EligibilityOrBenefitInformation": { "EligibilityOrBenefitInformation": { "@EB01_EligibilityOrBenefitInformationCode": "V" }, "MessageTexts": { "MSGSegment": { "@MSG01_FreeFormMessageText": "The payer response contains invalid or non compliant data.(70002)" } } } } } } } }, "FunctionalGroupTrailer": { "@GE01_NumberOfTransactionSets": "1", "@GE02_GroupControlNumber": "314159265" }, "InterchangeControlTrailer": { "@IEA01_NumberOfFunctionalGroups": "1", "@IEA02_InterchangeControlReference": "000000001" } } } } } }, "secondary": { "carrier_code": "car11406", "group_number": "asdasd", "subscriber_num": "aaaaa", "insurance_order": 2 }
 "subscriber_number": "11000023",
            "
patient
responsible_party": 
{
"child",
            
"respparty
"guarantor_first_name": "
self
VSee",

            "
member
guarantor_last_
id
name": "
5991794
Patient 11000023",

            "
response
guarantor_
party
middle_
id
name": "
6858376
Edward",
            
} }, "account_code": "vclinic",
"guarantor_dob": "1944-01-01",
            "
clinics
guarantor_gender": 
[
2,
            "
vclinic
guarantor_address": "52 Rainbow St",
     
],
       
"guarantor_city": "
created": 1649934637
Sunnyvale",
        
}
 
}

Webhook

Code Block
languagejson
{
   "
id
guarantor_zip": "
62583ab3-8cfc-4a47-b6c9-272850e631f8
10001",
    
"type":
 
"eligibility.checked",
   
"created":
 
1649949363,
   "
account
guarantor_
code
state": "
vclinic
CA",
  
"data":
 
{
   
"eligibility_id": "2505464",
      "
member_id
consent":
"132407",
 true
        
"eligibility_response": "No response received by clearinghouse"
}
    ],
    "
external_member_id
version": "
5991794" } }

Eligibility Responses List

eligibility_response may be one of the following:

Code Block
Success / Reject reason not found
Authorized quantity exceeded
Required application data missing
Input Errors
Out of Network
Authorization/Access restrictions
Unable to respond at current time.
Invalid/Missing provider information
Invalid/Missing provider name
Invalid/Missing provider speciality
Invalid/Missing provider phone number
Invalid/Missing provider state
Invalid/Missing referring provider identification number
Provider is not primary care physician
Provider ineligible for inquiries
Provider not on file
Service dates not within provider plan enrollment
Inquired benefit inconsistent with provider type
Inappropriate date
Invalid/Missing dates of service
Invalid/Missing date of birth
Date of birth follows date of service
Date of death preceeds dates of service
Date of service not within allowable inquiry period
Date of service in future
Invalid/Missing patient ID
Invalid/Missing patient name
Invalid/Missing patient gender code
Patient not found
Inconsistent with patient age.
Inconsistent with patient gender.
Patient birth date does not match that for the patient in the
Invalid/Missing subscriber/insured ID
Invalid/Missing subscriber/insured name
Invalid/Missing subscriber/insured gender code
Subscriber/Insured not found
Duplicate Subscriber/Insured ID number
Subscriber found, patient not found
Subscriber/Insured not in Group/Plan identified
Invalid participant identification
invalid or missing provider address
Payer name or identifier missing
Certification Information Missing
No response received by clearinghouse
Expiremental service or procedure.
Authorization number not found.
Requires primary care physician authorization.
Invalid/Missing diagnosis codes.
Invalid/Missing procedure codes.
Additional patient condition information required.
Certification information does not match patient.
Requires medical review.
Invalid authorization number format.
Missing authorization number.

Rejection reason and codes

Code Block
'04' => 'Authorized quantity exceeded',
'15' => 'Required application data missing',
'33' => 'Input Errors',
'35' => 'Out of Network',
'41' => 'Authorization/Access restrictions',
'42' => 'Unable to respond at current time.',
'43' => 'Invalid/Missing provider information',
'44' => 'Invalid/Missing provider name',
'45' => 'Invalid/Missing provider speciality',
'46' => 'Invalid/Missing provider phone number',
'47' => 'Invalid/Missing provider state',
'48' => 'Invalid/Missing referring provider identification number',
'49' => 'Provider is not primary care physician',
'50' => 'Provider ineligible for inquiries',
'51' => 'Provider not on file',
'52' => 'Service dates not within provider plan enrollment',
'53' => 'Inquired benefit inconsistent with provider type',
'56' => 'Inappropriate date',
'57' => 'Invalid/Missing dates of service',
'58' => 'Invalid/Missing date of birth',
'60' => 'Date of birth follows date of service',
'61' => 'Date of death preceeds dates of service',
'62' => 'Date of service not within allowable inquiry period',
'63' => 'Date of service in future',
'64' => 'Invalid/Missing patient ID',
'65' => 'Invalid/Missing patient name',
'66' => 'Invalid/Missing patient gender code',
'67' => 'Patient not found',
'69' => 'Inconsistent with patient age.',
'70' => 'Inconsistent with patient gender.',
'71' => 'Patient birth date does not match that for the patient in the database',
'72' => 'Invalid/Missing subscriber/insured ID',
'73' => 'Invalid/Missing subscriber/insured name',
'74' => 'Invalid/Missing subscriber/insured gender code',
'75' => 'Subscriber/Insured not found',
'76' => 'Duplicate Subscriber/Insured ID number',
'77' => 'Subscriber found, patient not found',
'78' => 'Subscriber/Insured not in Group/Plan identified',
'79' => 'Invalid participant identification',
'97' => 'invalid or missing provider address',
'T4' => 'Payer name or identifier missing',
'T5' => 'Certification Information Missing',
'80' => 'No response received by clearinghouse',
'98' => 'Expiremental service or procedure.',
'AA' => 'Authorization number not found.',
'AE' => 'Requires primary care physician authorization.',
'AF' => 'Invalid/Missing diagnosis codes.',
'AG' => 'Invalid/Missing procedure codes.',
'AO' => 'Additional patient condition information required.',
'CI' => 'Certification information does not match patient.',
'E8' => 'Requires medical review.',
'IA' => 'Invalid authorization number format.',
'MA' => 'Missing authorization number.'

GET /insurances/

2.0"
}

POST api_v3/users/{user_id}/insurances/{primary|secondary}
Status
colourYellow
titleV3

Update primary or secondary insurance

Expand
titleRequest payload
Code Block
languagejson
 {
    "card_type": "primary",
    "insurer_code": "(sandbox) HUMANA",
    "subscriber_number": "11000022",
    "group_number": "GN00022",
    "responsible_party": "self",
    "guarantor_first_name": "VSee",
    "guarantor_last_name": "Patient 11000022",
    "guarantor_middle_name": "Edward",
    "guarantor_dob": "1986-01-01",
    "guarantor_gender": 1,
    "guarantor_address": "54 Rainbow St",
    "guarantor_address_2": "#12-22",
    "guarantor_city": "Sunnyvale",
    "guarantor_zip": "10001",
    "guarantor_state": "CA",
    "consent": true
}
Expand
titleResponse (200)
Code Block
languagejson
{
    "data": {
        "card_type": "primary",
        "insurer_code": "(sandbox) HUMANA",
        "subscriber_number": "11000022",
        "group_number": "GN00022",
        "responsible_party": "self",
        "guarantor_first_name": "VSee",
        "guarantor_middle_name": "Edward",
        "guarantor_last_name": "Patient 11000022",
        "guarantor_dob": "1986-01-01",
        "guarantor_gender": 1,
        "guarantor_address": "54 Rainbow St",
        "guarantor_address_2": "#12-22",
        "guarantor_city": "Sunnyvale",
        "guarantor_zip": "10001",
        "guarantor_state": "CA",
        "consent": true
    },
    "version": "2.0"
}

GET api_v3/users/{user_id}/insurances/{primary|secondary}
Status
colourYellow
titleV3

Retrieve primary or secondary insurance

Expand
titleResponse (200)
Code Block
languagejson
{
    "data": {
        "card_type": "primary",
        "insurer_code": "(sandbox) HUMANA",
        "subscriber_number": "11000022",
        "group_number": "GN00022",
        "responsible_party": "self",
        "guarantor_first_name": "VSee",
        "guarantor_middle_name": "Edward",
        "guarantor_last_name": "Patient 11000022",
        "guarantor_dob": "1986-01-01",
        "guarantor_gender": 1,
        "guarantor_address": "54 Rainbow St",
        "guarantor_address_2": "#12-22",
        "guarantor_city": "Sunnyvale",
        "guarantor_zip": "10001",
        "guarantor_state": "CA",
        "consent": true
    },
    "version": "2.0"
}

DELETE api_v3/users/{user_id}/insurances/{primary|secondary}
Status
colourYellow
titleV3

Expand
titleResponse (204)
Code Block
204 No Content

Eligibility check

POST api_v3/users/{user_id}/insurances/primary/eligibility/check
Status
colourYellow
titleV3

  • Check and return queue status and current eligibility status

Expand
titleResponse 1 (200 OK)
Code Block
languagejson
{
    "data": {
        "job_id": "6552fefa-e620-4caa-9990-26940a7d6499",
        "status": "pending"
    }
}
Expand
titleResponse 2 (429 Too Many Requests)
Code Block
languagejson
{
    "code": 429,
    "message": "Started at Tue, 14 Nov 2023 12:05:00 +0700"
}

GET api_v3/users/{user_id}/insurances/primary/eligibility
Status
colourYellow
titleV3

  • Return queue status and current eligibility status

Expand
titleResponse 1
Code Block
languagejson
{
    "data": {
        "job_id": "655300b4-2378-4ec7-98bf-34b50a7d6499",
        "status": "pending"
    }
}
Expand
titleResponse 2
Code Block
languagejson
{
    "data": {
        "status": "active"
    }
}

Claims Center

GET api_v3/reports/claims?from_date=2024-09-02&to_date=2024-09-05
Status
colourYellow
titleV3

  • Return list of visits with other data that is relevant for claim

Retrieve data list

GET api_v3/insurances/list/insurers

Sample request

Code Block
languagebash
curl --location 'https://api-vclinic.vseepreview.com/vc/

...

stable/api_v3/

...

insurances/

...

list

...

Is it stored in clinic Raw settings.

Output

A list of supported insurers.

...

/insurers' \
--header 'X-AccountCode: vclinic'

Sample response

Expand
titleResponse
Code Block
languagejson
{ "data": { "insurers
{
	"data": [
{
		{
			"id": "
car7551
AAND",
"name
			"text": "
AETNA"
A AND I 
}, {
BENEFIT ADMINISTRATORS",
			"description": "A AND I BENEFIT ADMINISTRATORS"
		}, {
			"id": "
car7414
AGADM",
			"text": "A G ADMINISTRATORS 
"name
LLC",
			"description": "
AETNA
A 
BETTER
G 
HEALTH
ADMINISTRATORS 
OF ILLINOIS" }, {
LLC"
		}, {
			"id": "AAGA",
			"text": "AAG AMERICAN ADMINISTRATIVE GRP",
			"description": "AAG AMERICAN ADMINISTRATIVE GRP"
		}, {
			"id": "
car11406
AAGG",
			"text": "AAG GALLAGHER 
"name
BENEFITS",
			"description": "
ANTHEM
AAG 
BLUE
GALLAGHER 
SHIELD
BENEFITS"
		}, {
			"id": "AARP",
{
			"text": "AARP",
			"description": "AARP"
		}
	]
}

GET api_v3/insurances/list/billing_modifiers

Sample request

Code Block
languagebash
curl --location 'https://api-vclinic.vseepreview.com/vc/stable/api_v3/insurances/list/billing_modifiers' \
--header 'X-AccountCode: vclinic'

Sample response

Expand
titleResponse
Code Block
languagejson
{
	"data": [
		{
			"id": "
car7147
20",
			"text": 
"name
"20",
			"description": "
CIGNA HEALTH CARE" }, {
20"
		}, {
			"id": "F8",
			"text": "F8",
			"description": "F8"
		}, {
			"id": "
car7580
LC",
			"text": 
"name
"LC",
			"description": "
MONTGOMERY HEALTH INSURANCE" }, {
LC"
		}, {
			"id": "T5",
			"text": "T5",
			"description": "T5"
		}, {
			"id": "
car7556
XP",
			"text": 
"name
"XP",
			"description": "
HEALTH CHOICE ARIZONA" } ] } }

POST /insurance/claims

...

XP"
		}
	]
}

GET api_v3/

...

Request

...

Response

...

insurances/list/dxs

Sample request

Code Block
languagebash
curl --location

...

 'https://api-vclinic.vseepreview.com/vc/

...

stable/api_v3/insurances/

...

list/dxs' \
--header 'X-AccountCode: vclinic'

...

Sample response

Expand
Code Block
languagejson
{
	"data": [
		{
			"code": "I10",
			"description": "Essential (primary) hypertension",
			"advancedmd": {
				"code": "diag0010"
			}
		},
		{
			"code": "E11.9",
			"description": "Type 2 diabetes mellitus without complications",
			"advancedmd": {
				"code": "diag0021"
			}
		}
	]
}

GET api_v3/insurances/list/procedures

Sample request

Code Block
languagebash
curl --location 'https://api-vclinic.vseepreview.com/vc/stable/api_v3/insurances/list/procedures' \
--header 'X-AccountCode: vclinic'

Sample response

Expand
Code Block
languagejson
{
  "data": [
    {
      

...

"

...

id": "

...

10001",

...


      "

...

text": 

...

"INITIAL CONSULTATION - BASIC 

...

ASSESSMENT",
      "

...

description": "

...

Basic initial consultation to assess patient health status"
 

...

   },
 

...

 

...

languagejson

...

  {

...

 

...

     "id": "

...

10002",
  

...

 

...

Claims collection

Code Block
claims.type
claims.account_code
claims.visit_id //optional
claims.member_id
claims.status
claims.advancedmd.date_of_service // all input fields
claims.advancedmd.visit_id

Input

...

Parameter Name

...

Type

...

Description

...

visit_id

...

String

...

...

date_of_service

...

12/1/2021

...

location

...

41

...

procedure_code

...

U0003;U0005

...

units

...

1

...

diagnosis_code

...

Z20.822;R05.9

Output

Code Block
{ "data":
   "text": "FOLLOW-UP VISIT - CONDITION MONITORING",
      "description": "Routine follow-up to monitor ongoing health conditions"
    },
    {
      "id": 
"82828", } }

Webhook

Code Block
{
"10003",
      "text": "DIAGNOSTIC EVALUATION - LAB TEST REVIEW",
      "description": "Evaluation session for discussing lab test results with the patient"
    },
    {
      "id": "
5c34979c-30dc-496c-8cd3-6eb9925862c1
10004",
      "
type
text": "
claims.updated
TELEHEALTH CONSULT - MINOR ISSUES",
   
"visit_id
   "description": 
1546950556,
"Remote consultation for addressing 
"account_code": "vclinic"
minor health concerns"
    },
   
"data":
 {

      "
claim_
id": "
28540
10005",

      "
member_id
text": "
60610
EXTENDED CONSULTATION - TREATMENT PLANNING",
      
"
status
description": "Extended session for planning and discussing long-term treatment options"
    }
  ]
}