Create Service

Deprecated

POST

/api/services

POST

/api/services

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

Try it

200Successful

1 {
2   "id": "id",
3   "organizationId": "organizationId",
4   "status": "PENDING",
5   "createdAt": "2024-01-15T09:30:00Z",
6   "serviceType": {
7     "id": "id",
8     "name": "name",
9     "placeOfService": "TELEHEALTH_HOME",
10     "providerType": "MD",
11     "providerTypes": [
12       "MD",
13       "MD"
14     ],
15     "cost": 1,
16     "noteFields": [
17       "noteFields",
18       "noteFields"
19     ],
20     "conditionalPatientResponsibility": true,
21     "selfPayCost": 1
22   },
23   "dateOfService": "2024-01-15T09:30:00Z",
24   "patientId": "patientId",
25   "location": {
26     "state": "AL",
27     "line1": "line1",
28     "line2": "line2",
29     "city": "city",
30     "postalCode": "postalCode",
31     "country": "US"
32   },
33   "serviceEligibility": {
34     "id": "id",
35     "organizationId": "organizationId",
36     "serviceTypeId": "serviceTypeId",
37     "dateOfService": "2024-01-15T09:30:00Z",
38     "status": "PENDING",
39     "providers": [
40       {
41         "id": "id",
42         "name": "name",
43         "type": "MD",
44         "providerEligibilityEnabled": true,
45         "serviceEligibilityEnabled": true,
46         "npi": "npi",
47         "externalId": "externalId"
48       },
49       {
50         "id": "id",
51         "name": "name",
52         "type": "MD",
53         "providerEligibilityEnabled": true,
54         "serviceEligibilityEnabled": true,
55         "npi": "npi",
56         "externalId": "externalId"
57       }
58     ],
59     "policyIds": [
60       "policyIds",
61       "policyIds"
62     ],
63     "state": "AL",
64     "validatedAt": "2024-01-15T09:30:00Z",
65     "patientResponsibility": {
66       "total": 1,
67       "fallback": 1,
68       "deductible": 1,
69       "coinsurance": 1,
70       "coinsurancePercent": 1,
71       "copayment": 1,
72       "oopFallback": 1,
73       "oopCopayment": 1,
74       "oopCoinsurance": 1,
75       "oopDeductible": 1,
76       "deductibleType": "INDIVIDUAL"
77     },
78     "messages": [
79       "messages",
80       "messages"
81     ],
82     "clinicalInfo": {
83       "diagnoses": [
84         "diagnoses",
85         "diagnoses"
86       ]
87     },
88     "conditionalPatientResponsibilities": [
89       {
90         "conditions": [
91           {
92             "diagnoses": [
93               "diagnoses",
94               "diagnoses"
95             ]
96           },
97           {
98             "diagnoses": [
99               "diagnoses",
100               "diagnoses"
101             ]
102           }
103         ],
104         "limit": {
105           "type": "UNKNOWN",
106           "value": 1,
107           "metric": "VISIT",
108           "period": "ANNUAL",
109           "units": {
110             "minutes": 1,
111             "min": 1,
112             "max": 1
113           }
114         },
115         "patientResponsibility": {
116           "total": 1,
117           "fallback": 1,
118           "deductible": 1,
119           "coinsurance": 1,
120           "coinsurancePercent": 1,
121           "copayment": 1,
122           "oopFallback": 1,
123           "oopCopayment": 1,
124           "oopCoinsurance": 1,
125           "oopDeductible": 1,
126           "deductibleType": "INDIVIDUAL"
127         }
128       },
129       {
130         "conditions": [
131           {
132             "diagnoses": [
133               "diagnoses",
134               "diagnoses"
135             ]
136           },
137           {
138             "diagnoses": [
139               "diagnoses",
140               "diagnoses"
141             ]
142           }
143         ],
144         "limit": {
145           "type": "UNKNOWN",
146           "value": 1,
147           "metric": "VISIT",
148           "period": "ANNUAL",
149           "units": {
150             "minutes": 1,
151             "min": 1,
152             "max": 1
153           }
154         },
155         "patientResponsibility": {
156           "total": 1,
157           "fallback": 1,
158           "deductible": 1,
159           "coinsurance": 1,
160           "coinsurancePercent": 1,
161           "copayment": 1,
162           "oopFallback": 1,
163           "oopCopayment": 1,
164           "oopCoinsurance": 1,
165           "oopDeductible": 1,
166           "deductibleType": "INDIVIDUAL"
167         }
168       }
169     ]
170   },
171   "coverageStatus": "PENDING",
172   "provider": {
173     "id": "id",
174     "name": "name",
175     "type": "MD",
176     "providerEligibilityEnabled": true,
177     "serviceEligibilityEnabled": true,
178     "npi": "npi",
179     "externalId": "externalId"
180   },
181   "payments": [
182     {
183       "id": "id",
184       "createdAt": "2024-01-15T09:30:00Z",
185       "serviceId": "serviceId",
186       "paidAt": "2024-01-15T09:30:00Z",
187       "transactionId": "transactionId",
188       "type": "PATIENT",
189       "amount": 1,
190       "externalId": "externalId",
191       "memo": "memo"
192     },
193     {
194       "id": "id",
195       "createdAt": "2024-01-15T09:30:00Z",
196       "serviceId": "serviceId",
197       "paidAt": "2024-01-15T09:30:00Z",
198       "transactionId": "transactionId",
199       "type": "PATIENT",
200       "amount": 1,
201       "externalId": "externalId",
202       "memo": "memo"
203     }
204   ],
205   "responsibleParty": "PATIENT",
206   "patientResponsibility": {
207     "amount": {
208       "total": 1,
209       "fallback": 1,
210       "deductible": 1,
211       "coinsurance": 1,
212       "coinsurancePercent": 1,
213       "copayment": 1,
214       "oopFallback": 1,
215       "oopCopayment": 1,
216       "oopCoinsurance": 1,
217       "oopDeductible": 1,
218       "deductibleType": "INDIVIDUAL"
219     },
220     "status": "UNKNOWN",
221     "paid": 1
222   },
223   "tasks": [
224     {
225       "type": "PATIENT_CONSENT",
226       "memo": "memo"
227     },
228     {
229       "type": "PATIENT_CONSENT",
230       "memo": "memo"
231     }
232   ],
233   "externalId": "externalId",
234   "noteId": "noteId",
235   "claimStatus": "CREATED",
236   "priorAuthorizationNumber": "priorAuthorizationNumber",
237   "cancellationReason": "NO_SHOW",
238   "metadata": {
239     "exampleKey": "exampleKey"
240   }
241 }

Creates a new Service, waits for the ServiceEligibility to resolve synchronously. Request may timeout after 60 seconds, deprecated in favor of async API.

Request

This endpoint expects an object.

patientIdstringRequired

dateOfServicedatetimeRequired

Full ISO8601 timestamp, including timezone

serviceTypeIdstringRequired

locationobjectRequired

Location of the Patient at the date of service, requires only the state value for telehealth

providerIdstringRequired

externalIdstringOptional

serviceEligibilityobjectOptional

priorAuthorizationNumberstringOptional

metadataobjectOptional

Customizable object of string to string key-value data

responsiblePartyenumOptional

Allowed values:

Response

This endpoint returns an object.

idstring

organizationIdstring

statusenum

createdAtdatetime

serviceTypeobject

dateOfServicedatetime

patientIdstring

locationobject

Location of the Patient at the date of service, requires only the state value for telehealth

serviceEligibilityobject

coverageStatusenum

Allowed values:

providerobject

paymentslist of objects

responsiblePartyenum

Allowed values:

patientResponsibilityobject

taskslist of objects

externalIdstring or null

noteIdstring or null

claimStatusenum or null

Allowed values:

priorAuthorizationNumberstring or null

cancellationReasonenum or null

Allowed values:

metadataobject or null

Customizable object of string to string key-value data

Headers

Request

Response