Create ServiceEligibility

Deprecated

POST

/api/service-eligibility

POST

/api/service-eligibility

1 curl -X POST https://app.usebridge.com/api/service-eligibility \
2      -H "X-API-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "serviceTypeId": "serviceTypeId",
6   "dateOfService": "2024-01-15T09:30:00Z",
7   "policyIds": [
8     "policyIds",
9     "policyIds"
10   ],
11   "state": "AL"
12 }'

Try it

200Successful

1 {
2   "id": "id",
3   "organizationId": "organizationId",
4   "serviceTypeId": "serviceTypeId",
5   "dateOfService": "2024-01-15T09:30:00Z",
6   "status": "PENDING",
7   "providers": [
8     {
9       "id": "id",
10       "name": "name",
11       "type": "MD",
12       "providerEligibilityEnabled": true,
13       "serviceEligibilityEnabled": true,
14       "npi": "npi",
15       "externalId": "externalId"
16     },
17     {
18       "id": "id",
19       "name": "name",
20       "type": "MD",
21       "providerEligibilityEnabled": true,
22       "serviceEligibilityEnabled": true,
23       "npi": "npi",
24       "externalId": "externalId"
25     }
26   ],
27   "policyIds": [
28     "policyIds",
29     "policyIds"
30   ],
31   "state": "AL",
32   "validatedAt": "2024-01-15T09:30:00Z",
33   "patientResponsibility": {
34     "total": 1,
35     "fallback": 1,
36     "deductible": 1,
37     "coinsurance": 1,
38     "coinsurancePercent": 1,
39     "copayment": 1,
40     "oopFallback": 1,
41     "oopCopayment": 1,
42     "oopCoinsurance": 1,
43     "oopDeductible": 1,
44     "deductibleType": "INDIVIDUAL"
45   },
46   "messages": [
47     "messages",
48     "messages"
49   ],
50   "clinicalInfo": {
51     "diagnoses": [
52       "diagnoses",
53       "diagnoses"
54     ]
55   },
56   "conditionalPatientResponsibilities": [
57     {
58       "conditions": [
59         {
60           "diagnoses": [
61             "diagnoses",
62             "diagnoses"
63           ]
64         },
65         {
66           "diagnoses": [
67             "diagnoses",
68             "diagnoses"
69           ]
70         }
71       ],
72       "limit": {
73         "type": "UNKNOWN",
74         "value": 1,
75         "metric": "VISIT",
76         "period": "ANNUAL",
77         "units": {
78           "minutes": 1,
79           "min": 1,
80           "max": 1
81         }
82       },
83       "patientResponsibility": {
84         "total": 1,
85         "fallback": 1,
86         "deductible": 1,
87         "coinsurance": 1,
88         "coinsurancePercent": 1,
89         "copayment": 1,
90         "oopFallback": 1,
91         "oopCopayment": 1,
92         "oopCoinsurance": 1,
93         "oopDeductible": 1,
94         "deductibleType": "INDIVIDUAL"
95       }
96     },
97     {
98       "conditions": [
99         {
100           "diagnoses": [
101             "diagnoses",
102             "diagnoses"
103           ]
104         },
105         {
106           "diagnoses": [
107             "diagnoses",
108             "diagnoses"
109           ]
110         }
111       ],
112       "limit": {
113         "type": "UNKNOWN",
114         "value": 1,
115         "metric": "VISIT",
116         "period": "ANNUAL",
117         "units": {
118           "minutes": 1,
119           "min": 1,
120           "max": 1
121         }
122       },
123       "patientResponsibility": {
124         "total": 1,
125         "fallback": 1,
126         "deductible": 1,
127         "coinsurance": 1,
128         "coinsurancePercent": 1,
129         "copayment": 1,
130         "oopFallback": 1,
131         "oopCopayment": 1,
132         "oopCoinsurance": 1,
133         "oopDeductible": 1,
134         "deductibleType": "INDIVIDUAL"
135       }
136     }
137   ]
138 }

Runs a synchronous "Hard Eligibility" check, returning when complete. Deprecated in favor of async V2 API

Request

This endpoint expects an object.

serviceTypeIdstringRequired

dateOfServicedatetimeRequired

Full ISO8601 timestamp, including timezone

policyIdslist of stringsRequired

stateenumRequired

clinicalInfoobjectOptional

Response

This endpoint returns an object.

idstring

organizationIdstring

serviceTypeIdstring

dateOfServicedatetime

statusenum

Allowed values:

providerslist of objects

policyIdslist of strings

stateenum

validatedAtdatetime or null

Timestamp this was executed

patientResponsibilityobject or null

messageslist of strings or null

clinicalInfoobject or null

conditionalPatientResponsibilitieslist of objects or null

Headers

Request

Response