Get

Beta

GET

/appointments/v1/:id

GET

/appointments/v1/:id

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

1 {
2   "deactivated": true,
3   "id": "id",
4   "organization_id": "organization_id",
5   "patient_id": "patient_id",
6   "service_duration": 1,
7   "services": [
8     {
9       "universal_service_identifier": "MD_Visit",
10       "start_timestamp": "2024-01-15T09:30:00Z"
11     },
12     {
13       "universal_service_identifier": "MD_Visit",
14       "start_timestamp": "2024-01-15T09:30:00Z"
15     }
16   ],
17   "start_timestamp": "2024-01-15T09:30:00Z",
18   "updated_at": "2024-01-15T09:30:00Z",
19   "updating_user_id": "updating_user_id",
20   "version": 1,
21   "appointment_details": "appointment_details",
22   "attending_doctor": {
23     "name": {
24       "family": "family",
25       "given": [
26         "given",
27         "given"
28       ],
29       "use": "USUAL",
30       "period": {
31         "start": "2023-01-15",
32         "end": "2023-01-15"
33       },
34       "suffix": "suffix"
35     },
36     "telecoms": [
37       {
38         "value": "value",
39         "use": "HOME",
40         "period": {
41           "start": "2023-01-15",
42           "end": "2023-01-15"
43         }
44       },
45       {
46         "value": "value",
47         "use": "HOME",
48         "period": {
49           "start": "2023-01-15",
50           "end": "2023-01-15"
51         }
52       }
53     ],
54     "type": "PRIMARY",
55     "npi": "npi",
56     "addresses": [
57       {
58         "use": "HOME",
59         "line": [
60           "line",
61           "line"
62         ],
63         "city": "city",
64         "state": "state",
65         "postal_code": "postal_code",
66         "country": "country",
67         "county": "county",
68         "period": {
69           "start": "2023-01-15",
70           "end": "2023-01-15"
71         }
72       },
73       {
74         "use": "HOME",
75         "line": [
76           "line",
77           "line"
78         ],
79         "city": "city",
80         "state": "state",
81         "postal_code": "postal_code",
82         "country": "country",
83         "county": "county",
84         "period": {
85           "start": "2023-01-15",
86           "end": "2023-01-15"
87         }
88       }
89     ],
90     "period": {
91       "start": "2023-01-15",
92       "end": "2023-01-15"
93     },
94     "canonical_id": "canonical_id",
95     "fax": "fax",
96     "other_fax_numbers": [
97       "other_fax_numbers",
98       "other_fax_numbers"
99     ],
100     "emails": [
101       "emails",
102       "emails"
103     ],
104     "service_facilities": [
105       {
106         "service_facility_id": "service_facility_id"
107       },
108       {
109         "service_facility_id": "service_facility_id"
110       }
111     ]
112   },
113   "automated_eligibility_check_complete": true,
114   "checked_in_timestamp": "2024-01-15T09:30:00Z",
115   "estimated_copay_cents": 1,
116   "estimated_patient_responsibility_cents": 1,
117   "location_resource_id": "location_resource_id",
118   "not_ready_reason": "INACTIVE_PRIMARY",
119   "notes": "notes",
120   "patient_deposit_cents": 1,
121   "placer_appointment_id": "placer_appointment_id",
122   "ready_source": "MANUAL",
123   "status": "PENDING",
124   "work_queue": "EMERGENT_ISSUE"
125 }

Gets an appointment.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idstringRequired

The unique identifier for an Appointment.

Response

This endpoint returns an object.

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

idstring

The unique identifier for an Appointment.

organization_idstring

The organization that owns this object.

patient_idstring

The Candid-defined patient identifier.

service_durationinteger

The requested length of time allotted for the appointment. The units are in minutes.

serviceslist of objects

start_timestampdatetime

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

appointment_detailsstring

attending_doctorobject

Attending physician information. The attending physician will be stored as the Current MD for the patient.

automated_eligibility_check_completeboolean

True if the automated eligibility check has been completed. It is not recommended to change this value manually via API. This refers explicitly to the automated eligibility check that occurs a specific number of days before the appointment.

checked_in_timestampdatetime

The timestamp when the patient checked in for their appointment. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN.

estimated_copay_centsinteger

estimated_patient_responsibility_centsinteger

location_resource_idstring

Contains the coded identification of the location being scheduled. Components: <Identifier (ST)>^<Text (ST)>

not_ready_reasonenum

The reason the appointment is NOT_READY. Must only be set when status is NOT_READY; it is cleared otherwise. It is not recommended to change this value manually via API.

notesstring

patient_deposit_centsinteger

placer_appointment_idstring

ID for the appointment/order for the event.

ready_sourceenum

The method that set the appointment status to READY. It is not recommended to change this value manually via API. Must only be set when the status is READY or CHECKED_IN, it is cleared otherwise.

statusenum

Defaults to PENDING. If status is NOT_READY, work_queue must be set. If status is READY or CHECKED_IN, work_queue must be null. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN.

work_queueenum

The work queue that the appointment belongs to. It is not recommended to change this value manually via API. If status is NOT_READY, work_queue must be set. If status is READY, work_queue must be null.

Errors

404

Not Found Error