Get all encounters

1
curl -G https://api.joincandidhealth.com/api/encounters/v4 \
2
     -H "Authorization: Bearer <token>" \
3
     -d limit=100 \
4
     -d claim_status=biller_received \
5
     --data-urlencode sort=created_at:asc \
6
     -d page_token=eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9 \
7
     -d date_of_service_min=2019-08-24 \
8
     -d date_of_service_max=2019-08-25 \
9
     --data-urlencode primary_payer_names=Medicare,Medicaid \
10
     -d search_term=doe \
11
     -d external_id=123456 \
12
     --data-urlencode diagnoses_updated_since=2019-08-24T14:15:22Z

1
{
2
  "items": [
3
    {
4
      "benefits_assigned_to_provider": true,
5
      "billable_status": "BILLABLE",
6
      "billing_provider": {
7
        "address": {
8
          "address1": "123 Main St",
9
          "city": "New York",
10
          "state": "NY",
11
          "zip_code": "10001",
12
          "zip_plus_four_code": "1234",
13
          "address2": "Apt 1"
14
        },
15
        "npi": "1234567890",
16
        "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17
        "first_name": "John",
18
        "last_name": "Doe",
19
        "organization_name": "Organization Name",
20
        "tax_id": "123456789",
21
        "taxonomy_code": "207Q00000X"
22
      },
23
      "claims": [
24
        {
25
          "claim_id": "DD9D7F82-37B5-449D-AA63-26925398335B",
26
          "status": "biller_received",
27
          "service_lines": [
28
            {
29
              "service_line_id": "CED00F23-6E68-4678-9DBC-F5AA2969A565",
30
              "procedure_code": "99213",
31
              "quantity": "1",
32
              "units": "MJ",
33
              "claim_id": "026A1FB8-748E-4859-A2D7-3EA9E07D25AE",
34
              "date_of_service_range": {
35
                "start_date": "2023-01-01",
36
                "end_date": "2023-01-03"
37
              },
38
              "date_of_service": "2023-01-01",
39
              "modifiers": [
40
                "22"
41
              ],
42
              "charge_amount_cents": 10000,
43
              "allowed_amount_cents": 8000,
44
              "insurance_balance_cents": 0,
45
              "patient_balance_cents": 2000,
46
              "paid_amount_cents": 8000,
47
              "patient_responsibility_cents": 2000,
48
              "diagnosis_id_zero": "4AC84BCD-12F5-4F86-A57B-E06749127C98",
49
              "diagnosis_id_one": "EEA5CA5A-8B43-45FD-8CBD-C6CC1103E759",
50
              "diagnosis_id_two": "5C4AA029-2DB9-4202-916E-E93C708F65FF",
51
              "diagnosis_id_three": "81795126-A3AC-443C-B47E-7259A16AB4A2",
52
              "service_line_era_data": {
53
                "service_line_adjustments": [
54
                  {
55
                    "created_at": "2023-01-01T00:00:00Z",
56
                    "adjustment_group_code": "CO",
57
                    "adjustment_reason_code": "CO",
58
                    "adjustment_amount_cents": 1000,
59
                    "adjustment_note": "test_note"
60
                  }
61
                ],
62
                "remittance_advice_remark_codes": [
63
                  "N362"
64
                ]
65
              },
66
              "service_line_manual_adjustments": [
67
                {
68
                  "created_at": "2023-01-01T00:00:00Z",
69
                  "adjustment_group_code": "CO",
70
                  "adjustment_reason_code": "CO",
71
                  "adjustment_amount_cents": 1000,
72
                  "adjustment_note": "test_note"
73
                }
74
              ],
75
              "related_invoices": [
76
                {
77
                  "id": "901BE2F1-41BC-456E-9987-4FE2F84F9D75",
78
                  "created_at": "2023-01-01T00:00:00Z",
79
                  "updated_at": "2023-01-01T00:00:00Z",
80
                  "organzation_id": "F13F73D4-4344-46EA-9D93-33BCFFBB9F36",
81
                  "source_id": "9B626577-8808-4F28-9ED1-F0DFF0D49BBC",
82
                  "source_customer_id": "624D1972-8C69-4C2F-AEFA-10856F734DB3",
83
                  "patient_external_id": "10FED4D6-4C5A-48DF-838A-EEF45A74788D",
84
                  "due_date": "2023-10-10",
85
                  "status": "draft",
86
                  "items": [
87
                    {
88
                      "service_line_id": "CED00F23-6E68-4678-9DBC-F5AA2969A565",
89
                      "amount_cents": 500
90
                    }
91
                  ],
92
                  "note": "test_note",
93
                  "url": "https://example.com",
94
                  "customer_invoice_url": "https://example.com"
95
                }
96
              ],
97
              "denial_reason": {
98
                "reason": "Authorization Required"
99
              },
100
              "place_of_service_code": "01",
101
              "end_date_of_service": "2023-01-03"
102
            }
103
          ],
104
          "eras": [
105
            {
106
              "check_date": "2023-10-12",
107
              "check_number": "CHK12345",
108
              "era_id": "4D844EF1-2253-43CD-A4F1-6DB7E65CB54B"
109
            }
110
          ],
111
          "clearinghouse": "Change Healthcare",
112
          "clearinghouse_claim_id": "5BA7C3AB-2BC2-496C-8B10-6CAC73D0729D",
113
          "payer_claim_id": "9BB9F259-9756-4F16-8F53-9DBB9F7EB1BB"
114
        }
115
      ],
116
      "clinical_notes": [
117
        {
118
          "category": "clinical",
119
          "notes": [
120
            "Patient complained of mild chest pain."
121
          ],
122
          "notes_structured": [
123
            {
124
              "text": "Mild chest pain since morning.",
125
              "author_name": "John Doe",
126
              "timestamp": "2023-01-01T00:00:00Z",
127
              "author_npi": "1234567890"
128
            }
129
          ]
130
        }
131
      ],
132
      "date_of_service": "2023-01-01",
133
      "diagnoses": [
134
        {
135
          "code": "I10",
136
          "code_type": "ABF",
137
          "created_at": "2023-01-01T00:00:00Z",
138
          "diagnosis_id": "5C770E00-4BBF-42AF-A73F-99C5E91FC0DB",
139
          "encounter_id": "3F63985B-51A4-4DD4-9418-7D50B2520792",
140
          "updated_at": "2023-01-01T00:00:00Z",
141
          "name": "John Doe"
142
        }
143
      ],
144
      "encounter_id": "B2506E84-4470-4CBA-8A68-6883367739E1",
145
      "external_id": "5C21490F-A9C0-45F4-B5DB-136E3AEC617A",
146
      "owner_of_next_action": "CANDID",
147
      "patient": {
148
        "address": {
149
          "address1": "123 Main St",
150
          "city": "New York",
151
          "state": "NY",
152
          "zip_code": "10001",
153
          "address2": "Apt 1",
154
          "zip_plus_four_code": "1234"
155
        },
156
        "date_of_birth": "2000-01-01",
157
        "email_consent": true,
158
        "external_id": "49460F77-6456-41F1-AC6D-0AED08614D39",
159
        "first_name": "John",
160
        "gender": "male",
161
        "individual_id": "93DDBEBF-4956-4482-9A6C-21499B7E4E5D",
162
        "last_name": "Doe",
163
        "phone_consent": true,
164
        "phone_numbers": [
165
          {
166
            "number": "1234567890",
167
            "type": "Home"
168
          }
169
        ],
170
        "email": "johndoe@joincandidhealth.com"
171
      },
172
      "patient_authorized_release": true,
173
      "patient_histories": [
174
        {
175
          "category": "present_illness",
176
          "questions": [
177
            {
178
              "id": "6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176",
179
              "text": "Do you have any allergies?",
180
              "responses": [
181
                {
182
                  "response": "No allergies",
183
                  "follow_ups": [
184
                    {
185
                      "id": "4F3D57F9-AC94-49D6-87E4-E804B709917A",
186
                      "text": "Do you have any allergies?",
187
                      "response": "No allergies"
188
                    }
189
                  ]
190
                }
191
              ]
192
            }
193
          ]
194
        }
195
      ],
196
      "patient_payments": [
197
        {
198
          "patient_payment_id": "CF237BE1-E793-4BBF-8958-61D5179D1D0D",
199
          "organization_id": "0788CA2A-B20D-4B8E-B8D4-07FA0B3B4907",
200
          "source_internal_id": "D1A76039-D5C5-4323-A2FC-B7C8B6AEF6A4",
201
          "source": "MANUAL_ENTRY",
202
          "amount_cents": 2000,
203
          "payment_timestamp": "2023-01-01T00:00:00Z",
204
          "status": "PENDING",
205
          "payment_name": "John Doe",
206
          "payment_note": "test payment note",
207
          "patient_external_id": "B7437260-D6B4-48CF-B9D7-753C09F34E76",
208
          "encounter_external_id": "0F26B9C3-199F-4CBB-A166-B87EA7C631BB",
209
          "service_line_id": "B557DC86-C629-478C-850A-02D45AC11783"
210
        }
211
      ],
212
      "provider_accepts_assignment": true,
213
      "rendering_provider": {
214
        "address": {
215
          "address1": "123 Main St",
216
          "city": "New York",
217
          "state": "NY",
218
          "zip_code": "10001",
219
          "zip_plus_four_code": "1234",
220
          "address2": "Apt 1"
221
        },
222
        "npi": "1234567890",
223
        "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
224
        "first_name": "John",
225
        "last_name": "Doe",
226
        "organization_name": "Organization Name",
227
        "tax_id": "123456789",
228
        "taxonomy_code": "207Q00000X"
229
      },
230
      "responsible_party": "INSURANCE_PAY",
231
      "service_facility": {
232
        "service_facility_id": "2861487B-232C-4DED-A874-616A5DB0688F",
233
        "organization_name": "Test Organization",
234
        "address": {
235
          "address1": "123 Main St",
236
          "city": "New York",
237
          "state": "NY",
238
          "zip_code": "10001",
239
          "zip_plus_four_code": "1234",
240
          "address2": "Apt 1"
241
        }
242
      },
243
      "submission_origin": "CANDID",
244
      "tags": [
245
        {
246
          "color": "black",
247
          "creator_id": "00EB5A46-35C6-441B-9751-AF307AEF5888",
248
          "description": "to indicate claims where a void claim has been submitted",
249
          "tag_id": "void-claim-submitted"
250
        }
251
      ],
252
      "url": "https://example.com",
253
      "admission_date": "2023-01-01",
254
      "appointment_type": "Routine Checkup",
255
      "billing_notes": [
256
        {
257
          "billing_note_id": "99882EEA-936F-4E71-BC4F-520E4D14E3E2",
258
          "created_at": "2023-01-01T00:00:00Z",
259
          "encounter_id": "8BCFB6A8-2876-4111-9E3F-602B541FCF62",
260
          "text": "Patient was billed for an MRI.",
261
          "author_auth0_id": "F0DE3BF9-F9A1-4FA7-BF6B-28C0B46BADD8",
262
          "author_name": "John Doe"
263
        }
264
      ],
265
      "coding_attribution": "CANDID",
266
      "discharge_date": "2023-01-05",
267
      "end_date_of_service": "2023-01-05",
268
      "existing_medications": [
269
        {
270
          "name": "Lisinopril",
271
          "rx_cui": "860975",
272
          "dosage": "10mg",
273
          "dosage_form": "Tablet",
274
          "frequency": "Once Daily",
275
          "as_needed": true
276
        }
277
      ],
278
      "guarantor": {
279
        "email_consent": true,
280
        "external_id": "49460F77-6456-41F1-AC6D-0AED08614D39",
281
        "first_name": "John",
282
        "guarantor_id": "8BBDBE63-58D3-4D40-98C9-40403C050977",
283
        "last_name": "Doe",
284
        "phone_consent": true,
285
        "phone_numbers": [
286
          {
287
            "number": "1234567890",
288
            "type": "Home"
289
          }
290
        ],
291
        "address": {
292
          "address1": "123 Main St",
293
          "city": "New York",
294
          "state": "NY",
295
          "zip_code": "10001",
296
          "address2": "Apt 1",
297
          "zip_plus_four_code": "1234"
298
        },
299
        "date_of_birth": "2000-01-01",
300
        "email": "johndoe@joincandidhealth.com"
301
      },
302
      "interventions": [
303
        {
304
          "name": "Physical Therapy Session",
305
          "category": "lifestyle",
306
          "description": "A session focused on improving muscular strength, flexibility, and range of motion post-injury.",
307
          "medication": {
308
            "name": "Lisinopril",
309
            "rx_cui": "860975",
310
            "dosage": "10mg",
311
            "dosage_form": "Tablet",
312
            "frequency": "Once Daily",
313
            "as_needed": true
314
          },
315
          "labs": [
316
            {
317
              "name": "Genetic Health Labs",
318
              "code": "GH12345",
319
              "code_type": "quest"
320
            }
321
          ]
322
        }
323
      ],
324
      "onset_of_current_illness_or_symptom_date": "2023-01-01",
325
      "pay_to_address": {
326
        "address1": "123 Main St",
327
        "city": "New York",
328
        "state": "NY",
329
        "zip_code": "10001",
330
        "zip_plus_four_code": "1234",
331
        "address2": "Apt 1"
332
      },
333
      "place_of_service_code": "01",
334
      "place_of_service_code_as_submitted": "01",
335
      "prior_authorization_number": "PA1234567",
336
      "referring_provider": {
337
        "address": {
338
          "address1": "123 Main St",
339
          "city": "New York",
340
          "state": "NY",
341
          "zip_code": "10001",
342
          "zip_plus_four_code": "1234",
343
          "address2": "Apt 1"
344
        },
345
        "npi": "1234567890",
346
        "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
347
        "first_name": "John",
348
        "last_name": "Doe",
349
        "organization_name": "Organization Name",
350
        "tax_id": "123456789",
351
        "taxonomy_code": "207Q00000X"
352
      },
353
      "service_authorization_exception_code": "1",
354
      "subscriber_primary": {
355
        "first_name": "John",
356
        "gender": "male",
357
        "individual_id": "797348A9-E7E8-4E59-8628-95390D079C0B",
358
        "insurance_card": {
359
          "insurance_card_id": "CA5B7711-4419-4161-9B7C-3494AC40C8D4",
360
          "member_id": "E85313B4-0FFC-4119-8042-8161A4ECFF0A",
361
          "payer_id": "836DDAA6-863F-4020-ACCA-205A689F0002",
362
          "payer_name": "John Doe",
363
          "group_number": "ABC12345",
364
          "image_url_back": "https://s3.amazonaws.com/back.jpg",
365
          "image_url_front": "https://s3.amazonaws.com/front.jpg",
366
          "insurance_type": "12",
367
          "plan_name": "Silver PPO Plan",
368
          "plan_type": "09",
369
          "rx_bin": "610014",
370
          "rx_pcn": "MEDDPRIME"
371
        },
372
        "last_name": "Doe",
373
        "patient_relationship_to_subscriber_code": "01",
374
        "address": {
375
          "address1": "123 Main St",
376
          "city": "New York",
377
          "state": "NY",
378
          "zip_code": "10001",
379
          "address2": "Apt 1",
380
          "zip_plus_four_code": "1234"
381
        },
382
        "date_of_birth": "2000-01-01"
383
      },
384
      "subscriber_secondary": {
385
        "first_name": "John",
386
        "gender": "male",
387
        "individual_id": "797348A9-E7E8-4E59-8628-95390D079C0B",
388
        "insurance_card": {
389
          "insurance_card_id": "CA5B7711-4419-4161-9B7C-3494AC40C8D4",
390
          "member_id": "E85313B4-0FFC-4119-8042-8161A4ECFF0A",
391
          "payer_id": "836DDAA6-863F-4020-ACCA-205A689F0002",
392
          "payer_name": "John Doe",
393
          "group_number": "ABC12345",
394
          "image_url_back": "https://s3.amazonaws.com/back.jpg",
395
          "image_url_front": "https://s3.amazonaws.com/front.jpg",
396
          "insurance_type": "12",
397
          "plan_name": "Silver PPO Plan",
398
          "plan_type": "09",
399
          "rx_bin": "610014",
400
          "rx_pcn": "MEDDPRIME"
401
        },
402
        "last_name": "Doe",
403
        "patient_relationship_to_subscriber_code": "01",
404
        "address": {
405
          "address1": "123 Main St",
406
          "city": "New York",
407
          "state": "NY",
408
          "zip_code": "10001",
409
          "address2": "Apt 1",
410
          "zip_plus_four_code": "1234"
411
        },
412
        "date_of_birth": "2000-01-01"
413
      },
414
      "synchronicity": "Synchronous",
415
      "vitals": {
416
        "height_in": 70,
417
        "weight_lbs": 165,
418
        "blood_pressure_systolic_mmhg": 115,
419
        "blood_pressure_diastolic_mmhg": 85,
420
        "body_temperature_f": 98
421
      },
422
      "work_queue_id": "000856FE-1024-418F-BF96-2E7347AB4520",
423
      "work_queue_membership_activated_at": "2023-01-01T00:00:00Z"
424
    }
425
  ]
426
}