Get Eligibility Timeline

Beta

GET

/patients/v1/:id/eligibility-timeline

GET

/patients/v1/:id/eligibility-timeline

$ curl https://pre-api.joincandidhealth.com/patients/v1/id/eligibility-timeline \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "items": [
3     {
4       "id": "id",
5       "event_type": "APPOINTMENT_STATUS_CHANGED",
6       "patient_id": "patient_id",
7       "timestamp": "2024-01-15T09:30:00Z",
8       "user_id": "user_id",
9       "user_name": "user_name",
10       "payload": {
11         "payload": {
12           "key": "value"
13         }
14       },
15       "coverage_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16       "appointment_id": "appointment_id"
17     },
18     {
19       "id": "id",
20       "event_type": "APPOINTMENT_STATUS_CHANGED",
21       "patient_id": "patient_id",
22       "timestamp": "2024-01-15T09:30:00Z",
23       "user_id": "user_id",
24       "user_name": "user_name",
25       "payload": {
26         "payload": {
27           "key": "value"
28         }
29       },
30       "coverage_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
31       "appointment_id": "appointment_id"
32     }
33   ],
34   "total": 1,
35   "next_page_token": "next_page_token",
36   "prev_page_token": "prev_page_token"
37 }

Gets a patient’s eligibility audit timeline, newest-first. Org-scoped and keyset-paginated.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idstringRequired

The unique identifier for a Patient

Query parameters

event_typesenumOptional

coverage_idUUIDOptional

The unique identifier for a Coverage in the database

appointment_idstringOptional

The unique identifier for an Appointment.

page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

limitintegerOptional

Response

This endpoint returns an object.

itemslist of objects

totalinteger

next_page_tokenstring

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstring

A token that can be used to retrieve the next or previous page of results