# https://developer.carecloud.com/docs llms-full.txt
## CareCloud Developer Docs
### Developer Docs
Overview
[Your Application](https://developer.carecloud.com/overview#1) [Authentication](https://developer.carecloud.com/overview#2) [Authorization](https://developer.carecloud.com/overview#3) [Integration Testing](https://developer.carecloud.com/overview#IT) [Data Types](https://developer.carecloud.com/overview#4) [Pagnination](https://developer.carecloud.com/overview#5) [Rate Limiting](https://developer.carecloud.com/overview#6) [HTTP Verbs](https://developer.carecloud.com/overview#7) [HTTP Response Codes](https://developer.carecloud.com/overview#8)
[OAuth Guide](https://developer.carecloud.com/oauth) [Endpoints](https://developer.carecloud.com/docs)
Change Log
[2024](https://developer.carecloud.com/changes#2024) [2023](https://developer.carecloud.com/changes#2023) [2022](https://developer.carecloud.com/changes#2022) [2019](https://developer.carecloud.com/changes#2019) [2018](https://developer.carecloud.com/changes#2018) [2017](https://developer.carecloud.com/changes#2017) [2016](https://developer.carecloud.com/changes#2016) [2015](https://developer.carecloud.com/changes#2015)
[HL7 Interface](https://developer.carecloud.com/hl7)
# Endpoints
#### Checkout the [Change Log](https://developer.carecloud.com/changes) for new endpoints and enhancements.
#### Getting started with CareCloud's Interactive Documentation
First you must have a valid access token by completing the [OAuth flow](https://developer.carecloud.com/oauth). Place your access token in the input field (below) to starting making requests. If you recieve an "Invalid Token" error then use then request a new Access Token feature and include your application's Api Key, Secret Key and refresh token.
| | | |
| --- | --- | --- |
| Request a new Access Token → | Request New Access Token → | `...`
← Use This Token |
CareCloud API Endpoints
CareCloud API v2 Interactive Documentation
- ## [Appointment Availability](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Availability)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Appointment_Availability)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Availability/get_appointment_availability)[/appointment\_availability](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Availability/get_appointment_availability)
- [List Available Appointment Time Slots](https://developer.carecloud.com/static/swagger.html#!/Appointment_Availability/get_appointment_availability)
#### Implementation Notes
List Available Appointment Time Slots
| Parameter | Required? | Type | Instruction |
| --- | --- | --- | --- |
| start\_date | Required | String | Format as YYYY-MM-DD |
| visit\_reason\_id | Required | Integer | |
| location\_ids | Required | Integer | Can be a comma-separated list, ex: `location_ids=100,101,105` |
| resource\_ids | Required | Integer | Can be a comma-separated list, ex: `resource_ids=200,201,205` |
| end\_date | Optional | String | Format as YYYY-MM-DD |
| meridian | Optional | String | Pass in 'am' or 'pm', or both as a comma-separated list, ex: `meridian=am,pm`. Defaults to include AM and PM. |
| dow (Days of the Week) | Optional | String | Format as a string of binary numbers, from Sunday to Saturday, ex: `dow=0101100` represents Monday, Wednesday, and Thursday; `dow=0111110` represents all weekdays; `dow=1000000` represents only Sundays. Defaults to "0111110" (weekdays). |
| duration | Optional | Integer | Dictates the length of the returned appointment time slots. Integer represents a number of minutes. Defaults to visit\_reason's default duration. |
- For performance reasons, the result is restricted to 100 time slots. If no end\_date is given, it will return the first 100 available slots.
- Visit Reasons have a default appointment duration attached to them. If no duration is given, that visit reasons's default duration will be used.
- If no end\_date value is set the default date range is one day.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
ListAppointmentAvailabilities\_Response\
\
\]
ListAppointmentAvailabilities\_Response {
location (IdNameHash),
visit\_reason (IdNameHash),
resource (IdNameHash),
slots (Array\[StartEndTimeHash\])
}
IdNameHash {
id (integer),
name (string)
}
StartEndTimeHash {
start\_time (string),
end\_time (string)
}
```json
[\
{\
"location": {\
"id": 0,\
"name": "string"\
},\
"visit_reason": {\
"id": 0,\
"name": "string"\
},\
"resource": {\
"id": 0,\
"name": "string"\
},\
"slots": [\
{\
"start_time": "string",\
"end_time": "string"\
}\
]\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| start\_date | | **Start Date (YYYY-MM-DD)** | query | string |
| visit\_reason\_id | | **Visit Reason ID** | query | string |
| location\_ids | | **Location IDs** | query | string |
| resource\_ids | | **Resource IDs** | query | string |
| end\_date | | **End Date (YYYY-MM-DD)** | query | string |
| meridian | | Meridian (AM or PM) | query | string |
| dow | | Day of the Week | query | string |
| duration | | Appointment Duration | query | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Appointment Blockouts](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Blockouts)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Appointment_Blockouts)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Blockouts/get_appointment_blockouts)[/appointment\_blockouts](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Blockouts/get_appointment_blockouts)
- [List Appointment Blockouts](https://developer.carecloud.com/static/swagger.html#!/Appointment_Blockouts/get_appointment_blockouts)
#### Implementation Notes
List Appointment Blockouts with Filtering
Filtering params are optional.
If date filtering is provided, occurences of each blockout within the given timespan will be included.
Without date filtering, blockouts will be returned for today's date.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
AppointmentBlockouts\_Response\
\
\]
AppointmentBlockouts\_Response {
appointment\_blockout (AppointmentBlockouts\_Response\_appointment\_blockout)
}
AppointmentBlockouts\_Response\_appointment\_blockout {
business\_entity\_id (integer),
created\_at (string),
description (string),
effective\_from (string),
effective\_to (string),
end\_minutes (integer),
id (integer),
name (string),
start\_at (integer),
end\_at (integer),
updated\_at (string),
use\_friday (boolean),
use\_monday (boolean),
use\_saturday (boolean),
use\_sunday (boolean),
use\_thursday (boolean),
use\_tuesday (boolean),
use\_wednesday (boolean),
timezone (string),
recurrence\_id (integer),
occurrences (Array\[AppointmentBlockouts\_Response\_appointment\_blockout\_occurrences\])
}
AppointmentBlockouts\_Response\_appointment\_blockout\_occurrences {
start\_at (string),
end\_at (string)
}
```json
[\
{\
"appointment_blockout": {\
"business_entity_id": 0,\
"created_at": "string",\
"description": "string",\
"effective_from": "string",\
"effective_to": "string",\
"end_minutes": 0,\
"id": 0,\
"name": "string",\
"start_at": 0,\
"end_at": 0,\
"updated_at": "string",\
"use_friday": true,\
"use_monday": true,\
"use_saturday": true,\
"use_sunday": true,\
"use_thursday": true,\
"use_tuesday": true,\
"use_wednesday": true,\
"timezone": "string",\
"recurrence_id": 0,\
"occurrences": [\
{\
"start_at": "string",\
"end_at": "string"\
}\
]\
}\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| location\_id | | Location ID | query | string |
| resource\_id | | Resource ID | query | string |
| start\_date | | Start Date for date filtering (YYYY-MM-DD) | query | string |
| end\_date | | End Date for date filtering (YYYY-MM-DD) | query | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Appointments](https://developer.carecloud.com/static/swagger.html\#!/Appointments)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Appointments)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointments/get_appointment_cancellation_reasons)[/appointment\_cancellation\_reasons](https://developer.carecloud.com/static/swagger.html\#!/Appointments/get_appointment_cancellation_reasons)
- [List Appointment Cancellation Reasons](https://developer.carecloud.com/static/swagger.html#!/Appointments/get_appointment_cancellation_reasons)
#### Implementation Notes
List Appointment Cancellation Reasons. Some are global, while others belong to specific Practices.
By default, all Appointment Cancellation Reasons that could apply to a Practice are listed.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
AppointmentCancellationReason\_Response\
\
\]
AppointmentCancellationReason\_Response {
appointment\_cancellation\_reason (AppointmentCancellationReason\_Response\_appointment\_cancellation\_reason)
}
AppointmentCancellationReason\_Response\_appointment\_cancellation\_reason {
business\_entity\_id (string),
code (string),
created\_at (string),
description (string),
id (integer),
is\_default (boolean),
name (string),
sort\_code (integer),
updated\_at (string)
}
```json
[\
{\
"appointment_cancellation_reason": {\
"business_entity_id": "string",\
"code": "string",\
"created_at": "string",\
"description": "string",\
"id": 0,\
"is_default": true,\
"name": "string",\
"sort_code": 0,\
"updated_at": "string"\
}\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| global\_only | truefalse | Only Show Global Cancellation Reasons | query | boolean |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointments/get_appointment_statuses)[/appointment\_statuses](https://developer.carecloud.com/static/swagger.html\#!/Appointments/get_appointment_statuses)
- [List Appointment Statuses](https://developer.carecloud.com/static/swagger.html#!/Appointments/get_appointment_statuses)
#### Implementation Notes
List Appointment Statuses for a Practice
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
AppointmentStatus\
\
\]
AppointmentStatus {
appointment\_status (AppointmentStatusInner)
}
AppointmentStatusInner {
code (string),
id (string),
name (string)
}
```json
[\
{\
"appointment_status": {\
"code": "string",\
"id": "string",\
"name": "string"\
}\
}\
]
```
Response Content Typeapplication/json
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointments/get_appointments)[/appointments](https://developer.carecloud.com/static/swagger.html\#!/Appointments/get_appointments)
- [List Appointments](https://developer.carecloud.com/static/swagger.html#!/Appointments/get_appointments)
#### Implementation Notes
List Appointments with Filtering
Filtering params are optional.
Without date filtering, Appointments will be returned for today's date. If your request includes a start\_date param then an end\_date must be included too.
Results are paginated to 100 Appointments per page. The `page` parameter sets the page number to return, the default being `1`. Pagination state is indicated by the Link header, in accordance with [RFC5988](https://tools.ietf.org/html/rfc5988#section-5). The `Link` header contains URIs to the first, next, previous, and last pages in the result set. For an example see [Pagination](https://developer.carecloud.com/overview).
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
ListAppointments\_Response\
\
\]
ListAppointments\_Response {
appointment (ListAppointments\_Response\_appointment)
}
ListAppointments\_Response\_appointment {
id (string),
appointment\_status (ListAppointments\_Response\_appointment\_appointment\_status),
patient (ListAppointments\_Response\_appointment\_patient),
location (ListAppointments\_Response\_appointment\_location),
cancellation\_details (ListAppointments\_Response\_appointment\_cancellation\_details),
chief\_complaint (string),
appointment\_cancellation\_reason\_id (string),
arrived\_at (string),
business\_entity\_id (integer),
comments (string),
confirmation\_details (string),
departed\_at (string),
exam\_room\_id (string),
is\_confirmed (string),
is\_force\_overbook (boolean),
patient\_contacted (string),
recurrence\_id (string),
recurrence\_index (string),
referring\_physician\_npi (string),
visit\_reason\_id (integer),
resource\_id (integer),
provider\_id (string),
start\_time (string),
end\_time (string),
created\_at (string),
updated\_at (string)
}
ListAppointments\_Response\_appointment\_appointment\_status {
id (integer),
code (string),
name (string)
}
ListAppointments\_Response\_appointment\_patient {
id (string),
chart\_number (string),
date\_of\_birth (string),
first\_name (string),
last\_name (string),
middle\_initial (string),
gender\_id (string),
email (string),
patient\_status (string),
primary\_phone\_number (string)
}
ListAppointments\_Response\_appointment\_location {
id (integer),
name (string)
}
ListAppointments\_Response\_appointment\_cancellation\_details {
id (string),
detail (string),
comments (string)
}
```json
[\
{\
"appointment": {\
"id": "string",\
"appointment_status": {\
"id": 0,\
"code": "string",\
"name": "string"\
},\
"patient": {\
"id": "string",\
"chart_number": "string",\
"date_of_birth": "string",\
"first_name": "string",\
"last_name": "string",\
"middle_initial": "string",\
"gender_id": "string",\
"email": "string",\
"patient_status": "string",\
"primary_phone_number": "string"\
},\
"location": {\
"id": 0,\
"name": "string"\
},\
"cancellation_details": {\
"id": "string",\
"detail": "string",\
"comments": "string"\
},\
"chief_complaint": "string",\
"appointment_cancellation_reason_id": "string",\
"arrived_at": "string",\
"business_entity_id": 0,\
"comments": "string",\
"confirmation_details": "string",\
"departed_at": "string",\
"exam_room_id": "string",\
"is_confirmed": "string",\
"is_force_overbook": true,\
"patient_contacted": "string",\
"recurrence_id": "string",\
"recurrence_index": "string",\
"referring_physician_npi": "string",\
"visit_reason_id": 0,\
"resource_id": 0,\
"provider_id": "string",\
"start_time": "string",\
"end_time": "string",\
"created_at": "string",\
"updated_at": "string"\
}\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| location\_id | | Location ID | query | string |
| resource\_id | | Resource ID | query | string |
| start\_date | | Start Date for date filtering (YYYY-MM-DD) | query | string |
| end\_date | | End Date for date filtering (YYYY-MM-DD) | query | string |
| page | | page number | query | string |
| visit\_reason\_ids | | Visit Reason Id or Ids | query | string |
| patient\_ids | | Patient ID or IDs | query | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Appointments/post_appointments)[/appointments](https://developer.carecloud.com/static/swagger.html\#!/Appointments/post_appointments)
- [Create Appointment](https://developer.carecloud.com/static/swagger.html#!/Appointments/post_appointments)
#### Implementation Notes
Create an Appointment
If no `end_time` is specified, the end\_time will be calculated based on the duration specified in Nature of Visit.
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateAppointment\_Response {
appointment (string)
}
```json
{
"appointment": "string"
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment | Parameter content type:application/json | **appointment information** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateAppointment\_Request {
appointment (CreateAppointment\_Request\_appointment)
}
CreateAppointment\_Request\_appointment {
start\_time (string),
end\_time (string),
appointment\_status\_id (string, optional),
location\_id (integer),
provider\_id (integer),
visit\_reason\_id (integer),
resource\_id (integer),
chief\_complaint (string, optional),
comments (string, optional),
patient (CreateAppointment\_Request\_appointment\_patients)
}
CreateAppointment\_Request\_appointment\_patients {
id (string)
}
```json
{
"appointment": {
"start_time": "string",
"end_time": "string",
"appointment_status_id": "string",
"location_id": 0,
"provider_id": 0,
"visit_reason_id": 0,
"resource_id": 0,
"chief_complaint": "string",
"comments": "string",
"patient": {
"id": "string"
}
}
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 422 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointments/get_appointments_appointment_id)[/appointments/{appointment\_id}](https://developer.carecloud.com/static/swagger.html\#!/Appointments/get_appointments_appointment_id)
- [Show Appointment](https://developer.carecloud.com/static/swagger.html#!/Appointments/get_appointments_appointment_id)
#### Implementation Notes
Show an Appointment, includes the Patient's preferred\_confirmation\_method.
The Patient's preferred\_confirmation\_method can have the following values of:
_null_, 'phone', 'email', 'text\_message', 'fax', 'other', 'none'
Note that _null_ and _"none"_ are very different:
- A preferred\_confirmation\_method of _null_ means there is no preference with regard to communication method.
- A preferred\_confirmation\_method of _'none'_ means the Patient does not wish to be contacted at all.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ShowAppointment\_Response {
appointment (ShowAppointment\_Response\_appointment)
}
ShowAppointment\_Response\_appointment {
id (string),
appointment\_status (ListAppointments\_Response\_appointment\_appointment\_status),
patient (ListAppointments\_Response\_appointment\_patient),
location (ListAppointments\_Response\_appointment\_location),
cancellation\_details (ListAppointments\_Response\_appointment\_cancellation\_details),
chief\_complaint (string),
appointment\_cancellation\_reason\_id (string),
arrived\_at (string),
business\_entity\_id (integer),
comments (string),
confirmation\_details (string),
departed\_at (string),
exam\_room\_id (string),
is\_confirmed (string),
is\_force\_overbook (boolean),
patient\_contacted (string),
recurrence\_id (string),
recurrence\_index (string),
referring\_physician\_npi (string),
visit\_reason\_id (integer),
resource\_id (integer),
provider\_id (string),
start\_time (string),
end\_time (string),
created\_at (string),
updated\_at (string),
admit\_diagnosis\_id (string),
note\_set\_id (string),
document\_set\_id (string),
contrast (string),
laterality (string),
created\_by\_application (string),
patient\_instructions (string),
preferred\_confirmation\_method (string),
encounter\_id (string)
}
ListAppointments\_Response\_appointment\_appointment\_status {
id (integer),
code (string),
name (string)
}
ListAppointments\_Response\_appointment\_patient {
id (string),
chart\_number (string),
date\_of\_birth (string),
first\_name (string),
last\_name (string),
middle\_initial (string),
gender\_id (string),
email (string),
patient\_status (string),
primary\_phone\_number (string)
}
ListAppointments\_Response\_appointment\_location {
id (integer),
name (string)
}
ListAppointments\_Response\_appointment\_cancellation\_details {
id (string),
detail (string),
comments (string)
}
```json
{
"appointment": {
"id": "string",
"appointment_status": {
"id": 0,
"code": "string",
"name": "string"
},
"patient": {
"id": "string",
"chart_number": "string",
"date_of_birth": "string",
"first_name": "string",
"last_name": "string",
"middle_initial": "string",
"gender_id": "string",
"email": "string",
"patient_status": "string",
"primary_phone_number": "string"
},
"location": {
"id": 0,
"name": "string"
},
"cancellation_details": {
"id": "string",
"detail": "string",
"comments": "string"
},
"chief_complaint": "string",
"appointment_cancellation_reason_id": "string",
"arrived_at": "string",
"business_entity_id": 0,
"comments": "string",
"confirmation_details": "string",
"departed_at": "string",
"exam_room_id": "string",
"is_confirmed": "string",
"is_force_overbook": true,
"patient_contacted": "string",
"recurrence_id": "string",
"recurrence_index": "string",
"referring_physician_npi": "string",
"visit_reason_id": 0,
"resource_id": 0,
"provider_id": "string",
"start_time": "string",
"end_time": "string",
"created_at": "string",
"updated_at": "string",
"admit_diagnosis_id": "string",
"note_set_id": "string",
"document_set_id": "string",
"contrast": "string",
"laterality": "string",
"created_by_application": "string",
"patient_instructions": "string",
"preferred_confirmation_method": "string",
"encounter_id": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **GUID of the appointment** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [put](https://developer.carecloud.com/static/swagger.html\#!/Appointments/put_appointments_appointment_id_cancel)[/appointments/{appointment\_id}/cancel](https://developer.carecloud.com/static/swagger.html\#!/Appointments/put_appointments_appointment_id_cancel)
- [Cancel Appointment](https://developer.carecloud.com/static/swagger.html#!/Appointments/put_appointments_appointment_id_cancel)
#### Implementation Notes
Cancel an Appointment
An appointment\_cancellation\_reason\_id can be obtained through the [List Appointment Cancellation Reasons](https://developer.carecloud.com/static/swagger.html#!/Appointments/get_appointment_cancellation_reasons) endpoint.
The following Confirmation Methods can be used:
"other", "phone", "email", "text\_message", "fax"
If the communication\_method is included then it will be merged into cancellation\_details message (e.g 'Patient Rescheduled communicated by phone')
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
AppointmentCancel\_Response {
appointment\_id (string),
start\_time (string),
appointment\_cancellation\_request\_id (string),
cancellation\_details (string),
cancellation\_comments (string),
updated\_at (string)
}
```json
{
"appointment_id": "string",
"start_time": "string",
"appointment_cancellation_request_id": "string",
"cancellation_details": "string",
"cancellation_comments": "string",
"updated_at": "string"
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **Appointment ID** | path | string |
| query | Parameter content type:application/json | **appointment cancellation payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
AppointmentCancel\_Request {
appointment\_cancellation\_reason\_id (string),
cancellation\_comments (string),
communication\_method (string, optional)
}
```json
{
"appointment_cancellation_reason_id": "string",
"cancellation_comments": "string",
"communication_method": "string"
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 422 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [put](https://developer.carecloud.com/static/swagger.html\#!/Appointments/put_appointments_appointment_id_check_in)[/appointments/{appointment\_id}/check\_in](https://developer.carecloud.com/static/swagger.html\#!/Appointments/put_appointments_appointment_id_check_in)
- [Check in appointment](https://developer.carecloud.com/static/swagger.html#!/Appointments/put_appointments_appointment_id_check_in)
#### Implementation Notes
Returns the appointment object reflecting the change of state
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ShowAppointment\_Response {
appointment (ShowAppointment\_Response\_appointment)
}
ShowAppointment\_Response\_appointment {
id (string),
appointment\_status (ListAppointments\_Response\_appointment\_appointment\_status),
patient (ListAppointments\_Response\_appointment\_patient),
location (ListAppointments\_Response\_appointment\_location),
cancellation\_details (ListAppointments\_Response\_appointment\_cancellation\_details),
chief\_complaint (string),
appointment\_cancellation\_reason\_id (string),
arrived\_at (string),
business\_entity\_id (integer),
comments (string),
confirmation\_details (string),
departed\_at (string),
exam\_room\_id (string),
is\_confirmed (string),
is\_force\_overbook (boolean),
patient\_contacted (string),
recurrence\_id (string),
recurrence\_index (string),
referring\_physician\_npi (string),
visit\_reason\_id (integer),
resource\_id (integer),
provider\_id (string),
start\_time (string),
end\_time (string),
created\_at (string),
updated\_at (string),
admit\_diagnosis\_id (string),
note\_set\_id (string),
document\_set\_id (string),
contrast (string),
laterality (string),
created\_by\_application (string),
patient\_instructions (string),
preferred\_confirmation\_method (string),
encounter\_id (string)
}
ListAppointments\_Response\_appointment\_appointment\_status {
id (integer),
code (string),
name (string)
}
ListAppointments\_Response\_appointment\_patient {
id (string),
chart\_number (string),
date\_of\_birth (string),
first\_name (string),
last\_name (string),
middle\_initial (string),
gender\_id (string),
email (string),
patient\_status (string),
primary\_phone\_number (string)
}
ListAppointments\_Response\_appointment\_location {
id (integer),
name (string)
}
ListAppointments\_Response\_appointment\_cancellation\_details {
id (string),
detail (string),
comments (string)
}
```json
{
"appointment": {
"id": "string",
"appointment_status": {
"id": 0,
"code": "string",
"name": "string"
},
"patient": {
"id": "string",
"chart_number": "string",
"date_of_birth": "string",
"first_name": "string",
"last_name": "string",
"middle_initial": "string",
"gender_id": "string",
"email": "string",
"patient_status": "string",
"primary_phone_number": "string"
},
"location": {
"id": 0,
"name": "string"
},
"cancellation_details": {
"id": "string",
"detail": "string",
"comments": "string"
},
"chief_complaint": "string",
"appointment_cancellation_reason_id": "string",
"arrived_at": "string",
"business_entity_id": 0,
"comments": "string",
"confirmation_details": "string",
"departed_at": "string",
"exam_room_id": "string",
"is_confirmed": "string",
"is_force_overbook": true,
"patient_contacted": "string",
"recurrence_id": "string",
"recurrence_index": "string",
"referring_physician_npi": "string",
"visit_reason_id": 0,
"resource_id": 0,
"provider_id": "string",
"start_time": "string",
"end_time": "string",
"created_at": "string",
"updated_at": "string",
"admit_diagnosis_id": "string",
"note_set_id": "string",
"document_set_id": "string",
"contrast": "string",
"laterality": "string",
"created_by_application": "string",
"patient_instructions": "string",
"preferred_confirmation_method": "string",
"encounter_id": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **appointment\_id** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [put](https://developer.carecloud.com/static/swagger.html\#!/Appointments/put_appointments_appointment_id_check_out)[/appointments/{appointment\_id}/check\_out](https://developer.carecloud.com/static/swagger.html\#!/Appointments/put_appointments_appointment_id_check_out)
- [Check out appointment](https://developer.carecloud.com/static/swagger.html#!/Appointments/put_appointments_appointment_id_check_out)
#### Implementation Notes
Returns the appointment object reflecting the change of state
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ShowAppointment\_Response {
appointment (ShowAppointment\_Response\_appointment)
}
ShowAppointment\_Response\_appointment {
id (string),
appointment\_status (ListAppointments\_Response\_appointment\_appointment\_status),
patient (ListAppointments\_Response\_appointment\_patient),
location (ListAppointments\_Response\_appointment\_location),
cancellation\_details (ListAppointments\_Response\_appointment\_cancellation\_details),
chief\_complaint (string),
appointment\_cancellation\_reason\_id (string),
arrived\_at (string),
business\_entity\_id (integer),
comments (string),
confirmation\_details (string),
departed\_at (string),
exam\_room\_id (string),
is\_confirmed (string),
is\_force\_overbook (boolean),
patient\_contacted (string),
recurrence\_id (string),
recurrence\_index (string),
referring\_physician\_npi (string),
visit\_reason\_id (integer),
resource\_id (integer),
provider\_id (string),
start\_time (string),
end\_time (string),
created\_at (string),
updated\_at (string),
admit\_diagnosis\_id (string),
note\_set\_id (string),
document\_set\_id (string),
contrast (string),
laterality (string),
created\_by\_application (string),
patient\_instructions (string),
preferred\_confirmation\_method (string),
encounter\_id (string)
}
ListAppointments\_Response\_appointment\_appointment\_status {
id (integer),
code (string),
name (string)
}
ListAppointments\_Response\_appointment\_patient {
id (string),
chart\_number (string),
date\_of\_birth (string),
first\_name (string),
last\_name (string),
middle\_initial (string),
gender\_id (string),
email (string),
patient\_status (string),
primary\_phone\_number (string)
}
ListAppointments\_Response\_appointment\_location {
id (integer),
name (string)
}
ListAppointments\_Response\_appointment\_cancellation\_details {
id (string),
detail (string),
comments (string)
}
```json
{
"appointment": {
"id": "string",
"appointment_status": {
"id": 0,
"code": "string",
"name": "string"
},
"patient": {
"id": "string",
"chart_number": "string",
"date_of_birth": "string",
"first_name": "string",
"last_name": "string",
"middle_initial": "string",
"gender_id": "string",
"email": "string",
"patient_status": "string",
"primary_phone_number": "string"
},
"location": {
"id": 0,
"name": "string"
},
"cancellation_details": {
"id": "string",
"detail": "string",
"comments": "string"
},
"chief_complaint": "string",
"appointment_cancellation_reason_id": "string",
"arrived_at": "string",
"business_entity_id": 0,
"comments": "string",
"confirmation_details": "string",
"departed_at": "string",
"exam_room_id": "string",
"is_confirmed": "string",
"is_force_overbook": true,
"patient_contacted": "string",
"recurrence_id": "string",
"recurrence_index": "string",
"referring_physician_npi": "string",
"visit_reason_id": 0,
"resource_id": 0,
"provider_id": "string",
"start_time": "string",
"end_time": "string",
"created_at": "string",
"updated_at": "string",
"admit_diagnosis_id": "string",
"note_set_id": "string",
"document_set_id": "string",
"contrast": "string",
"laterality": "string",
"created_by_application": "string",
"patient_instructions": "string",
"preferred_confirmation_method": "string",
"encounter_id": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **appointment\_id** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [put](https://developer.carecloud.com/static/swagger.html\#!/Appointments/put_appointments_appointment_id_pending)[/appointments/{appointment\_id}/pending](https://developer.carecloud.com/static/swagger.html\#!/Appointments/put_appointments_appointment_id_pending)
- [Change appointment status to pending](https://developer.carecloud.com/static/swagger.html#!/Appointments/put_appointments_appointment_id_pending)
#### Implementation Notes
Returns the appointment object reflecting the change of state
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ShowAppointment\_Response {
appointment (ShowAppointment\_Response\_appointment)
}
ShowAppointment\_Response\_appointment {
id (string),
appointment\_status (ListAppointments\_Response\_appointment\_appointment\_status),
patient (ListAppointments\_Response\_appointment\_patient),
location (ListAppointments\_Response\_appointment\_location),
cancellation\_details (ListAppointments\_Response\_appointment\_cancellation\_details),
chief\_complaint (string),
appointment\_cancellation\_reason\_id (string),
arrived\_at (string),
business\_entity\_id (integer),
comments (string),
confirmation\_details (string),
departed\_at (string),
exam\_room\_id (string),
is\_confirmed (string),
is\_force\_overbook (boolean),
patient\_contacted (string),
recurrence\_id (string),
recurrence\_index (string),
referring\_physician\_npi (string),
visit\_reason\_id (integer),
resource\_id (integer),
provider\_id (string),
start\_time (string),
end\_time (string),
created\_at (string),
updated\_at (string),
admit\_diagnosis\_id (string),
note\_set\_id (string),
document\_set\_id (string),
contrast (string),
laterality (string),
created\_by\_application (string),
patient\_instructions (string),
preferred\_confirmation\_method (string),
encounter\_id (string)
}
ListAppointments\_Response\_appointment\_appointment\_status {
id (integer),
code (string),
name (string)
}
ListAppointments\_Response\_appointment\_patient {
id (string),
chart\_number (string),
date\_of\_birth (string),
first\_name (string),
last\_name (string),
middle\_initial (string),
gender\_id (string),
email (string),
patient\_status (string),
primary\_phone\_number (string)
}
ListAppointments\_Response\_appointment\_location {
id (integer),
name (string)
}
ListAppointments\_Response\_appointment\_cancellation\_details {
id (string),
detail (string),
comments (string)
}
```json
{
"appointment": {
"id": "string",
"appointment_status": {
"id": 0,
"code": "string",
"name": "string"
},
"patient": {
"id": "string",
"chart_number": "string",
"date_of_birth": "string",
"first_name": "string",
"last_name": "string",
"middle_initial": "string",
"gender_id": "string",
"email": "string",
"patient_status": "string",
"primary_phone_number": "string"
},
"location": {
"id": 0,
"name": "string"
},
"cancellation_details": {
"id": "string",
"detail": "string",
"comments": "string"
},
"chief_complaint": "string",
"appointment_cancellation_reason_id": "string",
"arrived_at": "string",
"business_entity_id": 0,
"comments": "string",
"confirmation_details": "string",
"departed_at": "string",
"exam_room_id": "string",
"is_confirmed": "string",
"is_force_overbook": true,
"patient_contacted": "string",
"recurrence_id": "string",
"recurrence_index": "string",
"referring_physician_npi": "string",
"visit_reason_id": 0,
"resource_id": 0,
"provider_id": "string",
"start_time": "string",
"end_time": "string",
"created_at": "string",
"updated_at": "string",
"admit_diagnosis_id": "string",
"note_set_id": "string",
"document_set_id": "string",
"contrast": "string",
"laterality": "string",
"created_by_application": "string",
"patient_instructions": "string",
"preferred_confirmation_method": "string",
"encounter_id": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **appointment\_id** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointments/get_appointments_appointment_id_notes)[/appointments/{appointment\_id}/notes](https://developer.carecloud.com/static/swagger.html\#!/Appointments/get_appointments_appointment_id_notes)
- [List Appointment Notes](https://developer.carecloud.com/static/swagger.html#!/Appointments/get_appointments_appointment_id_notes)
#### Implementation Notes
List notes associated with an appointment.
If there are note triggers then the note will pop-up when the specified screens, `actions`, are accessed in CareCloud.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
NoteLists\_Response {
notes (ListNote\_Response)
}
ListNote\_Response \[\
\
Note\_Response\
\
\]
Note\_Response {
id (integer),
text (string),
note\_trigger (notetrigger\_Response)
}
notetrigger\_Response {
actions (Array\[trigger\_actions\]),
expires\_at (string)
}
trigger\_actions {
name (string),
code (string)
}
```json
{
"notes": [\
{\
"id": 0,\
"text": "string",\
"note_trigger": {\
"actions": [\
{\
"name": "string",\
"code": "string"\
}\
],\
"expires_at": "string"\
}\
}\
]
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **GUID of the appointment** | path | string |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | Appointment not found for current practice | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Appointments/post_appointments_appointment_id_notes)[/appointments/{appointment\_id}/notes](https://developer.carecloud.com/static/swagger.html\#!/Appointments/post_appointments_appointment_id_notes)
- [Create an Appointment Note](https://developer.carecloud.com/static/swagger.html#!/Appointments/post_appointments_appointment_id_notes)
#### Implementation Notes
Create a Note associated with an appointment.
If `actions` are included in the request then the note pops up when the specified screens are accessed in CareCloud. `actions` accepts an array of codes.
| code | description |
| --- | --- |
| APP | Open or Check in an Appointment | |
| PAT | Open a Patient | |
| COL | Open a Collection Incident | |
| CHG | Open a Charge Entry | |
| REM | Entering a Remitted Payment | |
| CHT | Open a Patient Chart | |
`expires_at` must be in the date format, `YYYY-MM-DD`. If `expires_at = nil` then expiration date of the action(s) would be never.
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Note\_Response {
id (integer),
text (string),
note\_trigger (notetrigger\_Response)
}
notetrigger\_Response {
actions (Array\[trigger\_actions\]),
expires\_at (string)
}
trigger\_actions {
name (string),
code (string)
}
```json
{
"id": 0,
"text": "string",
"note_trigger": {
"actions": [\
{\
"name": "string",\
"code": "string"\
}\
],
"expires_at": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **GUID of the appointment** | path | string |
| body | Parameter content type:application/json | **note payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Note\_Request {
text (string),
note\_trigger (notetrigger\_Request, optional)
}
notetrigger\_Request {
actions (Array\[string\]),
expires\_at (string)
}
```json
{
"text": "string",
"note_trigger": {
"actions": [
"string"
],
"expires_at": "string"
}
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [put](https://developer.carecloud.com/static/swagger.html\#!/Appointments/put_appointments_appointment_id_notes_note_id)[/appointments/{appointment\_id}/notes/{note\_id}](https://developer.carecloud.com/static/swagger.html\#!/Appointments/put_appointments_appointment_id_notes_note_id)
- [Update an Appointment Note](https://developer.carecloud.com/static/swagger.html#!/Appointments/put_appointments_appointment_id_notes_note_id)
#### Implementation Notes
Update an Appointment Note
If `actions` are included in the request then the note pops up when the specified screens are accessed in CareCloud. `actions` accepts an array of codes.
| code | description |
| --- | --- |
| APP | Open or Check in an Appointment | |
| PAT | Open a Patient | |
| COL | Open a Collection Incident | |
| CHG | Open a Charge Entry | |
| REM | Entering a Remitted Payment | |
| CHT | Open a Patient Chart | |
`expires_at` must be in the date format, `YYYY-MM-DD`. If `expires_at = nil` then expiration date of the action(s) would be never.
#### Response Class (Status 204)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Note\_Response {
id (integer),
text (string),
note\_trigger (notetrigger\_Response)
}
notetrigger\_Response {
actions (Array\[trigger\_actions\]),
expires\_at (string)
}
trigger\_actions {
name (string),
code (string)
}
```json
{
"id": 0,
"text": "string",
"note_trigger": {
"actions": [\
{\
"name": "string",\
"code": "string"\
}\
],
"expires_at": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **GUID of the appointment** | path | string |
| note\_id | | **Note id** | path | string |
| body | Parameter content type:application/json | **note payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Note\_Request {
text (string),
note\_trigger (notetrigger\_Request, optional)
}
notetrigger\_Request {
actions (Array\[string\]),
expires\_at (string)
}
```json
{
"text": "string",
"note_trigger": {
"actions": [
"string"
],
"expires_at": "string"
}
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Appointment Recalls](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Recalls)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Appointment_Recalls)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Recalls/get_appointment_recall_types)[/appointment\_recall\_types](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Recalls/get_appointment_recall_types)
- [List Appointment Recall Types](https://developer.carecloud.com/static/swagger.html#!/Appointment_Recalls/get_appointment_recall_types)
#### Implementation Notes
List Appointment Recall Types for a Practice
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
AppointmentRecallType\_Response\
\
\]
AppointmentRecallType\_Response {
recall\_type (AppointmentRecallType\_Response\_recall\_type)
}
AppointmentRecallType\_Response\_recall\_type {
id (integer),
description (string),
name (string),
created\_at (string),
updated\_at (string)
}
```json
[\
{\
"recall_type": {\
"id": 0,\
"description": "string",\
"name": "string",\
"created_at": "string",\
"updated_at": "string"\
}\
}\
]
```
Response Content Typeapplication/json
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Recalls/get_appointment_recalls)[/appointment\_recalls](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Recalls/get_appointment_recalls)
- [List Appointment Recalls](https://developer.carecloud.com/static/swagger.html#!/Appointment_Recalls/get_appointment_recalls)
#### Implementation Notes
List Appointment Recalls in a Date Range
An Appointment recall is a follow up or reminder note that is associated to a patient. The recall object has a reason/type (e.g Surgical Follow-Up, Annual Physical), an occurrence (e.g a date, 1 week from now, in 1 year), and a note section.The status of a recall can be tracked whether it is pending or completed. When the recall needs to be executed, a task is automatically created and appears in the user's task inbox.A recall object is linked to a patient and not directly to an appointment object.
Results are paginated to 100 Appointment Recalls per page. The `page` parameter sets the page number to return, the default being `1`. Pagination state is indicated by the Link header, in accordance with [RFC5988](https://tools.ietf.org/html/rfc5988#section-5). The `Link` header contains URIs to the first, next, previous, and last pages in the result set. For an example see [Pagination](https://developer.carecloud.com/overview).
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
AppointmentRecall\_Response\
\
\]
AppointmentRecall\_Response {
recall (AppointmentRecall\_Response\_recall)
}
AppointmentRecall\_Response\_recall {
id (integer),
comments (string),
recall\_at (string),
recall\_type (AppointmentRecall\_Response\_recall\_recall\_type),
recall\_status (AppointmentRecall\_Response\_recall\_recall\_status),
patient (AppointmentRecall\_Response\_recall\_patient)
}
AppointmentRecall\_Response\_recall\_recall\_type {
id (integer),
name (string),
description (string)
}
AppointmentRecall\_Response\_recall\_recall\_status {
name (string),
code (string)
}
AppointmentRecall\_Response\_recall\_patient {
id (string),
preferred\_communication\_method (string)
}
```json
[\
{\
"recall": {\
"id": 0,\
"comments": "string",\
"recall_at": "string",\
"recall_type": {\
"id": 0,\
"name": "string",\
"description": "string"\
},\
"recall_status": {\
"name": "string",\
"code": "string"\
},\
"patient": {\
"id": "string",\
"preferred_communication_method": "string"\
}\
}\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| start\_date | | start date (YYYY-MM-DD) | query | string |
| end\_date | | end date (YYYY-MM-DD) | query | string |
| recall\_status | | recall status | query | string |
| page | | page number | query | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Recalls/get_appointment_recalls_id)[/appointment\_recalls/{id}](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Recalls/get_appointment_recalls_id)
- [Get Appointment Recall by ID](https://developer.carecloud.com/static/swagger.html#!/Appointment_Recalls/get_appointment_recalls_id)
#### Implementation Notes
Get an Appointment Recall
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
AppointmentRecall\_Response {
recall (AppointmentRecall\_Response\_recall)
}
AppointmentRecall\_Response\_recall {
id (integer),
comments (string),
recall\_at (string),
recall\_type (AppointmentRecall\_Response\_recall\_recall\_type),
recall\_status (AppointmentRecall\_Response\_recall\_recall\_status),
patient (AppointmentRecall\_Response\_recall\_patient)
}
AppointmentRecall\_Response\_recall\_recall\_type {
id (integer),
name (string),
description (string)
}
AppointmentRecall\_Response\_recall\_recall\_status {
name (string),
code (string)
}
AppointmentRecall\_Response\_recall\_patient {
id (string),
preferred\_communication\_method (string)
}
```json
{
"recall": {
"id": 0,
"comments": "string",
"recall_at": "string",
"recall_type": {
"id": 0,
"name": "string",
"description": "string"
},
"recall_status": {
"name": "string",
"code": "string"
},
"patient": {
"id": "string",
"preferred_communication_method": "string"
}
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| id | | **id** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [put](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Recalls/put_appointment_recalls_id)[/appointment\_recalls/{id}](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Recalls/put_appointment_recalls_id)
- [Update Appointment Recall](https://developer.carecloud.com/static/swagger.html#!/Appointment_Recalls/put_appointment_recalls_id)
#### Implementation Notes
Update an Appointment Recall
#### Response Class (Status 204)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
AppointmentRecall\_Response\
\
\]
AppointmentRecall\_Response {
recall (AppointmentRecall\_Response\_recall)
}
AppointmentRecall\_Response\_recall {
id (integer),
comments (string),
recall\_at (string),
recall\_type (AppointmentRecall\_Response\_recall\_recall\_type),
recall\_status (AppointmentRecall\_Response\_recall\_recall\_status),
patient (AppointmentRecall\_Response\_recall\_patient)
}
AppointmentRecall\_Response\_recall\_recall\_type {
id (integer),
name (string),
description (string)
}
AppointmentRecall\_Response\_recall\_recall\_status {
name (string),
code (string)
}
AppointmentRecall\_Response\_recall\_patient {
id (string),
preferred\_communication\_method (string)
}
```json
[\
{\
"recall": {\
"id": 0,\
"comments": "string",\
"recall_at": "string",\
"recall_type": {\
"id": 0,\
"name": "string",\
"description": "string"\
},\
"recall_status": {\
"name": "string",\
"code": "string"\
},\
"patient": {\
"id": "string",\
"preferred_communication_method": "string"\
}\
}\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| id | | **id** | path | string |
| body | Parameter content type:application/json | **appointment recall update payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
AppointmentRecallUpdate\_Request {
recall\_status (string): 'pending', 'assigned', 'completed', 'attempt\_failed',
comments (string)
}
```json
{
"recall_status": "string",
"comments": "string"
}
```
Click to set as parameter value |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Appointment Resources](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Resources)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Appointment_Resources)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Resources/get_appointment_resources)[/appointment\_resources](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Resources/get_appointment_resources)
- [List Appointment Resources](https://developer.carecloud.com/static/swagger.html#!/Appointment_Resources/get_appointment_resources)
#### Implementation Notes
List Appointment Resources for a Practice.
An Appointment Resource is used to facilitate scheduling or reserving of a resource (i.e not just a person). An Appointment Resource can be a person (doctor), place (procedure room), or thing (xray,ultrasound machine).
Appointments are linked to an Appointment Resource via the resource\_id. An actual provider/doctor(s) is associated to the AppointmentResource to facilitate the billing process. When the Appointment Resource is the provider/doctor, they typically name the Appointment Resource using the provider/doctor's name.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
ListResources\_Response\
\
\]
ListResources\_Response {
resource (ListResources\_Response\_resource)
}
ListResources\_Response\_resource {
appointment\_confirmation (string),
business\_entity\_id (integer),
code (string),
created\_at (string),
created\_by (integer),
description (string),
id (integer),
is\_for\_requests (boolean),
name (string),
sort\_code (integer),
status (string),
updated\_at (string),
updated\_by (integer)
}
```json
[\
{\
"resource": {\
"appointment_confirmation": "string",\
"business_entity_id": 0,\
"code": "string",\
"created_at": "string",\
"created_by": 0,\
"description": "string",\
"id": 0,\
"is_for_requests": true,\
"name": "string",\
"sort_code": 0,\
"status": "string",\
"updated_at": "string",\
"updated_by": 0\
}\
}\
]
```
Response Content Typeapplication/json
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Resources/get_appointment_resources_resource_id)[/appointment\_resources/{resource\_id}](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Resources/get_appointment_resources_resource_id)
- [Show Appointment Resource](https://developer.carecloud.com/static/swagger.html#!/Appointment_Resources/get_appointment_resources_resource_id)
#### Implementation Notes
Show Appointment Resource and its Default Provider
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
ShowResource\_Response\
\
\]
ShowResource\_Response {
resource (ShowResource\_Response\_resource)
}
ShowResource\_Response\_resource {
id (integer),
business\_entity\_id (integer),
name (string),
code (string),
description (string),
status (string),
sort\_code (integer),
created\_at (string),
updated\_at (string),
is\_for\_requests (boolean),
appointment\_confirmation (string),
default\_provider (ShowResource\_Response\_resource\_default\_provider)
}
ShowResource\_Response\_resource\_default\_provider {
id (integer),
name (string)
}
```json
[\
{\
"resource": {\
"id": 0,\
"business_entity_id": 0,\
"name": "string",\
"code": "string",\
"description": "string",\
"status": "string",\
"sort_code": 0,\
"created_at": "string",\
"updated_at": "string",\
"is_for_requests": true,\
"appointment_confirmation": "string",\
"default_provider": {\
"id": 0,\
"name": "string"\
}\
}\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| resource\_id | | **Appointment Resource ID** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Resources/get_visit_reasons_visit_reason_id_appointment_resources)[/visit\_reasons/{visit\_reason\_id}/appointment\_resources](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Resources/get_visit_reasons_visit_reason_id_appointment_resources)
- [List Appointment Resources for a Visit Reason](https://developer.carecloud.com/static/swagger.html#!/Appointment_Resources/get_visit_reasons_visit_reason_id_appointment_resources)
#### Implementation Notes
List Appointment Resources for a Practice, filtered by a Visit Reason
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
ListResources\_Response\
\
\]
ListResources\_Response {
resource (ListResources\_Response\_resource)
}
ListResources\_Response\_resource {
appointment\_confirmation (string),
business\_entity\_id (integer),
code (string),
created\_at (string),
created\_by (integer),
description (string),
id (integer),
is\_for\_requests (boolean),
name (string),
sort\_code (integer),
status (string),
updated\_at (string),
updated\_by (integer)
}
```json
[\
{\
"resource": {\
"appointment_confirmation": "string",\
"business_entity_id": 0,\
"code": "string",\
"created_at": "string",\
"created_by": 0,\
"description": "string",\
"id": 0,\
"is_for_requests": true,\
"name": "string",\
"sort_code": 0,\
"status": "string",\
"updated_at": "string",\
"updated_by": 0\
}\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| visit\_reason\_id | | **ID of the Visit Reason** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Appointment Templates](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Templates)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Appointment_Templates)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Templates/get_appointment_resources_resource_id_appointment_templates)[/appointment\_resources/{resource\_id}/appointment\_templates](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Templates/get_appointment_resources_resource_id_appointment_templates)
- [List Appointment Templates By Resource](https://developer.carecloud.com/static/swagger.html#!/Appointment_Templates/get_appointment_resources_resource_id_appointment_templates)
#### Implementation Notes
List Appointment Templates for a Practice filtered by Resource
Filtering params are optional.
If date filtering is provided, occurences of each template within the given timespan will be included.
Without date filtering, all templates for the Practice will be returned.
Results are paginated to 20 Appointment Templates per page. The `page` parameter sets the page number to return, the default being `1`. Pagination state is indicated by the Link header, in accordance with [RFC5988](https://tools.ietf.org/html/rfc5988#section-5). The `Link` header contains URIs to the first, next, previous, and last pages in the result set. For an example see [Pagination](https://developer.carecloud.com/overview).
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
AppointmentTemplates\_Response\
\
\]
AppointmentTemplates\_Response {
appointment\_templates (Array\[AppointmentTemplates\_Response\_appointment\_templates\])
}
AppointmentTemplates\_Response\_appointment\_templates {
id (integer),
name (string),
locations (Array\[AppointmentTemplates\_Response\_appointment\_templates\_locations\]),
resources (Array\[AppointmentTemplates\_Response\_appointment\_templates\_resources\]),
visit\_reasons (Array\[AppointmentTemplates\_Response\_appointment\_templates\_visit\_reasons\]),
business\_entity\_id (integer),
description (string),
use\_monday (boolean),
use\_tuesday (boolean),
use\_wednesday (boolean),
use\_thursday (boolean),
use\_friday (boolean),
use\_saturday (boolean),
use\_sunday (boolean),
effective\_from (string),
effective\_to (string),
max\_appointments\_allowed (integer),
start\_at (string),
end\_at (string),
occurrences (Array\[AppointmentTemplates\_Response\_appointment\_templates\_occurrences\])
}
AppointmentTemplates\_Response\_appointment\_templates\_locations {
id (integer),
name (string)
}
AppointmentTemplates\_Response\_appointment\_templates\_resources {
id (integer),
name (string)
}
AppointmentTemplates\_Response\_appointment\_templates\_visit\_reasons {
id (integer),
name (string),
max\_appointments\_allowed (string)
}
AppointmentTemplates\_Response\_appointment\_templates\_occurrences {
start\_at (string),
end\_at (string)
}
```json
[\
{\
"appointment_templates": [\
{\
"id": 0,\
"name": "string",\
"locations": [\
{\
"id": 0,\
"name": "string"\
}\
],\
"resources": [\
{\
"id": 0,\
"name": "string"\
}\
],\
"visit_reasons": [\
{\
"id": 0,\
"name": "string",\
"max_appointments_allowed": "string"\
}\
],\
"business_entity_id": 0,\
"description": "string",\
"use_monday": true,\
"use_tuesday": true,\
"use_wednesday": true,\
"use_thursday": true,\
"use_friday": true,\
"use_saturday": true,\
"use_sunday": true,\
"effective_from": "string",\
"effective_to": "string",\
"max_appointments_allowed": 0,\
"start_at": "string",\
"end_at": "string",\
"occurrences": [\
{\
"start_at": "string",\
"end_at": "string"\
}\
]\
}\
]\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| start\_date | | Start Date (YYYY-MM-DD) | query | string |
| end\_date | | End Date (YYYY-MM-DD) | query | string |
| location\_id | | Location ID | query | string |
| resource\_id | | **Resource ID** | path | string |
| page | | page number | query | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Templates/get_appointment_templates)[/appointment\_templates](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Templates/get_appointment_templates)
- [List Appointment Templates](https://developer.carecloud.com/static/swagger.html#!/Appointment_Templates/get_appointment_templates)
#### Implementation Notes
List Appointment Templates for a Practice
Filtering params are optional.
If date filtering is provided, occurences of each template within the given timespan will be included.
Without date filtering, all templates for the Practice will be returned.
Results are paginated to 20 Appointment Templates per page. The `page` parameter sets the page number to return, the default being `1`. Pagination state is indicated by the Link header, in accordance with [RFC5988](https://tools.ietf.org/html/rfc5988#section-5). The `Link` header contains URIs to the first, next, previous, and last pages in the result set. For an example see [Pagination](https://developer.carecloud.com/overview).
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
AppointmentTemplates\_Response\
\
\]
AppointmentTemplates\_Response {
appointment\_templates (Array\[AppointmentTemplates\_Response\_appointment\_templates\])
}
AppointmentTemplates\_Response\_appointment\_templates {
id (integer),
name (string),
locations (Array\[AppointmentTemplates\_Response\_appointment\_templates\_locations\]),
resources (Array\[AppointmentTemplates\_Response\_appointment\_templates\_resources\]),
visit\_reasons (Array\[AppointmentTemplates\_Response\_appointment\_templates\_visit\_reasons\]),
business\_entity\_id (integer),
description (string),
use\_monday (boolean),
use\_tuesday (boolean),
use\_wednesday (boolean),
use\_thursday (boolean),
use\_friday (boolean),
use\_saturday (boolean),
use\_sunday (boolean),
effective\_from (string),
effective\_to (string),
max\_appointments\_allowed (integer),
start\_at (string),
end\_at (string),
occurrences (Array\[AppointmentTemplates\_Response\_appointment\_templates\_occurrences\])
}
AppointmentTemplates\_Response\_appointment\_templates\_locations {
id (integer),
name (string)
}
AppointmentTemplates\_Response\_appointment\_templates\_resources {
id (integer),
name (string)
}
AppointmentTemplates\_Response\_appointment\_templates\_visit\_reasons {
id (integer),
name (string),
max\_appointments\_allowed (string)
}
AppointmentTemplates\_Response\_appointment\_templates\_occurrences {
start\_at (string),
end\_at (string)
}
```json
[\
{\
"appointment_templates": [\
{\
"id": 0,\
"name": "string",\
"locations": [\
{\
"id": 0,\
"name": "string"\
}\
],\
"resources": [\
{\
"id": 0,\
"name": "string"\
}\
],\
"visit_reasons": [\
{\
"id": 0,\
"name": "string",\
"max_appointments_allowed": "string"\
}\
],\
"business_entity_id": 0,\
"description": "string",\
"use_monday": true,\
"use_tuesday": true,\
"use_wednesday": true,\
"use_thursday": true,\
"use_friday": true,\
"use_saturday": true,\
"use_sunday": true,\
"effective_from": "string",\
"effective_to": "string",\
"max_appointments_allowed": 0,\
"start_at": "string",\
"end_at": "string",\
"occurrences": [\
{\
"start_at": "string",\
"end_at": "string"\
}\
]\
}\
]\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| start\_date | | Start Date (YYYY-MM-DD) | query | string |
| end\_date | | End Date (YYYY-MM-DD) | query | string |
| location\_id | | Location ID | query | string |
| page | | page number | query | string |
| resource\_id | | Resource ID | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Appointment Visit Reasons](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Visit_Reasons)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Appointment_Visit_Reasons)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Visit_Reasons/get_appointment_resources_resource_id_visit_reasons)[/appointment\_resources/{resource\_id}/visit\_reasons](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Visit_Reasons/get_appointment_resources_resource_id_visit_reasons)
- [List Visit Reasons for an Appointment Resource](https://developer.carecloud.com/static/swagger.html#!/Appointment_Visit_Reasons/get_appointment_resources_resource_id_visit_reasons)
#### Implementation Notes
List Visit Reasons for a Practice, filtered by an Appointment Resource
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
NatureOfVisit\
\
\]
NatureOfVisit {
id (string),
name (string),
description (string)
}
```json
[\
{\
"id": "string",\
"name": "string",\
"description": "string"\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| resource\_id | | **ID of the Appointment Resource** | path | string |
| request\_types\_only | truefalse | filters visit reasons available for patient appointment requests | query | boolean |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Visit_Reasons/get_visit_reasons)[/visit\_reasons](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Visit_Reasons/get_visit_reasons)
- [List Visit Reasons](https://developer.carecloud.com/static/swagger.html#!/Appointment_Visit_Reasons/get_visit_reasons)
#### Implementation Notes
List Visit Reasons for a Practice
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
NatureOfVisit\
\
\]
NatureOfVisit {
id (string),
name (string),
description (string)
}
```json
[\
{\
"id": "string",\
"name": "string",\
"description": "string"\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| request\_types\_only | truefalse | filters visit reasons available for patient appointment requests | query | boolean |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Appointment Confirmations](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Confirmations)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Appointment_Confirmations)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Confirmations/post_appointments_appointment_id_confirmation)[/appointments/{appointment\_id}/confirmation](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Confirmations/post_appointments_appointment_id_confirmation)
- [Confirm Appointment (to be depracated)](https://developer.carecloud.com/static/swagger.html#!/Appointment_Confirmations/post_appointments_appointment_id_confirmation)
#### Implementation Notes
Record Attempt to Confirm an Appointment and its Outcome
We are planning to deprecate this endpoint in favor of single purpose endpoints that remove ambiguity between confirming an appointment and appointment communications.
The following communication methods can be used:
"other", "phone", "email", "text\_message", "fax"
The following Confirmation Outcomes can be used:
"terminated", "undeliverable", "error", "responded", "processing", "message\_sent", "left\_message\_to\_reschedule", "incorrect\_number", "confirmed", "line\_busy", "no\_answer", "left\_message", "disconnected"
| outcome name | description |
| --- | --- |
| terminated | Terminated by System | |
| undeliverable | Undeliverable: Missing or Invalid Information | |
| error | Error Message | |
| responded | Message Responded | |
| processing | Processing | |
| message\_sent | Message Sent | |
| left\_message\_to\_reschedule | Left message to reschedule | |
| incorrect\_number | The phone number was not correct | |
| confirmed | The patient confirmed the appointment | |
| line\_Busy | The line dialed was busy | |
| no\_answer | No one answered the phone | |
| left\_message | Left a message | |
| disconnected | Phone number disconnected | |
When passing "confirmed" as the Confirmation Outcome, the Appointment will be marked as Confirmed.
Before calling this endpoint, [Show Appointment](https://developer.carecloud.com/static/swagger.html#!/Appointments/get_appointments_appointment_id) should be called to check the preferred\_confirmation\_method of the Appointment. For Appointments showing a preferred\_confirmation\_method of 'none', the Patient does not wish to be contacted at all, and no confirmation attempts should be made.
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateAppointmentConfirmation\_Response {
appointment\_confirmation (CreateAppointmentConfirmation\_Response\_appointment\_confirmation)
}
CreateAppointmentConfirmation\_Response\_appointment\_confirmation {
appointment\_id (integer),
comments (string),
communication\_method (string),
communication\_method\_description (string),
communication\_outcome (string),
created\_at (string),
date\_confirmed (string),
id (integer),
updated\_at (string)
}
```json
{
"appointment_confirmation": {
"appointment_id": 0,
"comments": "string",
"communication_method": "string",
"communication_method_description": "string",
"communication_outcome": "string",
"created_at": "string",
"date_confirmed": "string",
"id": 0,
"updated_at": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **GUID of the appointment** | path | string |
| confirmation | Parameter content type:application/json | **appointment confirmation payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateAppointmentConfirmation\_Request {
date\_confirmed (string),
communication\_method\_description (string),
comments (string),
communication\_method (string),
communication\_outcome (string)
}
```json
{
"date_confirmed": "string",
"communication_method_description": "string",
"comments": "string",
"communication_method": "string",
"communication_outcome": "string"
}
```
Click to set as parameter value |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Confirmations/post_appointments_appointment_id_confirm)[/appointments/{appointment\_id}/confirm](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Confirmations/post_appointments_appointment_id_confirm)
- [Confirm Appointment](https://developer.carecloud.com/static/swagger.html#!/Appointment_Confirmations/post_appointments_appointment_id_confirm)
#### Implementation Notes
Record an Appointment as confirmed.
The following communications methods can be used:
"other", "phone", "email", "text\_message", "fax"
Before calling this endpoint, [Show Appointment](https://developer.carecloud.com/static/swagger.html#!/Appointments/get_appointments_appointment_id) should be called to check the preferred\_confirmation\_method of the Appointment. For Appointments showing a preferred\_confirmation\_method of 'none', the Patient does not wish to be contacted at all, and no confirmation attempts should be made.
The default date\_confirmed is the current date, if not passed.
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateAppointmentConfirmation\_Response\_appointment\_confirmation {
appointment\_id (integer),
comments (string),
communication\_method (string),
communication\_method\_description (string),
communication\_outcome (string),
created\_at (string),
date\_confirmed (string),
id (integer),
updated\_at (string)
}
```json
{
"appointment_id": 0,
"comments": "string",
"communication_method": "string",
"communication_method_description": "string",
"communication_outcome": "string",
"created_at": "string",
"date_confirmed": "string",
"id": 0,
"updated_at": "string"
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **GUID of the appointment** | path | string |
| confirm | Parameter content type:application/json | **confirm appointment payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateAppointmentConfirm\_Request {
date\_confirmed (string),
communication\_method\_description (string),
comments (string),
communication\_method (string)
}
```json
{
"date_confirmed": "string",
"communication_method_description": "string",
"comments": "string",
"communication_method": "string"
}
```
Click to set as parameter value |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Confirmations/post_appointments_appointment_id_communication)[/appointments/{appointment\_id}/communication](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Confirmations/post_appointments_appointment_id_communication)
- [Appointment Communication](https://developer.carecloud.com/static/swagger.html#!/Appointment_Confirmations/post_appointments_appointment_id_communication)
#### Implementation Notes
Record Appointment Communication and it's Outcome
An appointment communication is a convenient way to log a simple appointment reminder or any other type of communication outreach to the patient regarding their upcoming appointment. This endpoint does not confirm an appointment nor change an appointment's status. To confirm an appointment use the [Confirm Appointment](https://developer.carecloud.com/static/swagger.html#!/Appointment_Confirmations/post_appointments_appointment_id_confirm).
The following communication methods can be used:
"other", "phone", "email", "text\_message", "fax"
The following Confirmation Outcomes can be used:
"terminated", "undeliverable", "error", "responded", "processing", "message\_sent", "left\_message\_to\_reschedule", "incorrect\_number", "confirmed", "line\_busy", "no\_answer", "left\_message", "disconnected"
| outcome name | description |
| --- | --- |
| terminated | Terminated by System | |
| undeliverable | Undeliverable: Missing or Invalid Information | |
| error | Error Message | |
| responded | Message Responded | |
| processing | Processing | |
| message\_sent | Message Sent | |
| left\_message\_to\_reschedule | Left message to reschedule | |
| incorrect\_number | The phone number was not correct | |
| line\_Busy | The line dialed was busy | |
| no\_answer | No one answered the phone | |
| left\_message | Left a message | |
| disconnected | Phone number disconnected |
Before calling this endpoint, [Show Appointment](https://developer.carecloud.com/static/swagger.html#!/Appointments/get_appointments_appointment_id) should be called to check the preferred\_confirmation\_method of the Appointment. For Appointments showing a preferred\_confirmation\_method of 'none', the Patient does not wish to be contacted at all, and no confirmation attempts should be made.
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateAppointmentCommunication\_Response {
appointment\_id (integer),
comments (string),
communication\_method (string),
communication\_method\_description (string),
communication\_outcome (string),
created\_at (string),
id (integer),
updated\_at (string)
}
```json
{
"appointment_id": 0,
"comments": "string",
"communication_method": "string",
"communication_method_description": "string",
"communication_outcome": "string",
"created_at": "string",
"id": 0,
"updated_at": "string"
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **GUID of the appointment** | path | string |
| communication | Parameter content type:application/json | **appointment communication payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateAppointmentCommunication\_Request {
communication\_method\_description (string),
comments (string),
communication\_method (string),
communication\_outcome (string)
}
```json
{
"communication_method_description": "string",
"comments": "string",
"communication_method": "string",
"communication_outcome": "string"
}
```
Click to set as parameter value |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Confirmations/get_appointments_appointment_id_confirmations)[/appointments/{appointment\_id}/confirmations](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Confirmations/get_appointments_appointment_id_confirmations)
- [List Appointment Confirmations](https://developer.carecloud.com/static/swagger.html#!/Appointment_Confirmations/get_appointments_appointment_id_confirmations)
#### Implementation Notes
List confirmations for a particular appointment
The following Confirmation Methods will be used:
"other", "phone", "email", "text\_message", "fax"
The following Confirmation Outcomes will be used:
"terminated", "undeliverable", "error", "responded", "processing", "message\_sent", "left\_message\_to\_reschedule", "incorrect\_number", "confirmed", "line\_busy", "no\_answer", "left\_message", "disconnected"
| name | description |
| --- | --- |
| terminated | Terminated by System | |
| undeliverable | Undeliverable: Missing or Invalid Information | |
| error | Error Message | |
| responded | Message Responded | |
| processing | Processing | |
| message\_sent | Message Sent | |
| left\_message\_to\_reschedule | Left message to reschedule | |
| incorrect\_number | The phone number was not correct | |
| confirmed | The patient confirmed the appointment | |
| line\_Busy | The line dialed was busy | |
| no\_answer | No one answered the phone | |
| left\_message | Left a message | |
| disconnected | Phone number disconnected | |
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
CreateAppointmentConfirmation\_Response\
\
\]
CreateAppointmentConfirmation\_Response {
appointment\_confirmation (CreateAppointmentConfirmation\_Response\_appointment\_confirmation)
}
CreateAppointmentConfirmation\_Response\_appointment\_confirmation {
appointment\_id (integer),
comments (string),
communication\_method (string),
communication\_method\_description (string),
communication\_outcome (string),
created\_at (string),
date\_confirmed (string),
id (integer),
updated\_at (string)
}
```json
[\
{\
"appointment_confirmation": {\
"appointment_id": 0,\
"comments": "string",\
"communication_method": "string",\
"communication_method_description": "string",\
"communication_outcome": "string",\
"created_at": "string",\
"date_confirmed": "string",\
"id": 0,\
"updated_at": "string"\
}\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **GUID of the appointment** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Ccda](https://developer.carecloud.com/static/swagger.html\#!/Ccda)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Ccda)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Ccda/get_ccda_ccda_id)[/ccda/{ccda\_id}](https://developer.carecloud.com/static/swagger.html\#!/Ccda/get_ccda_ccda_id)
- [Get Ccda Request](https://developer.carecloud.com/static/swagger.html#!/Ccda/get_ccda_ccda_id)
#### Implementation Notes
Get a Ccda Request
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
GetCcda\_Response {
CreateCcda\_Response
}
CreateCcda\_Response {
business\_entity\_id (integer),
created\_at (string),
created\_by (integer),
document\_id (string),
document\_name (string),
document\_url (string),
guid (string),
id (integer),
job\_id (string),
provider\_id (integer),
updated\_at (string),
updated\_by (integer),
status (Ccda\_Status)
}
Ccda\_Status {
time (integer),
status (string),
uuid (string),
options (object),
name (string),
message (string)
}
```json
{
"business_entity_id": 0,
"created_at": "string",
"created_by": 0,
"document_id": "string",
"document_name": "string",
"document_url": "string",
"guid": "string",
"id": 0,
"job_id": "string",
"provider_id": 0,
"updated_at": "string",
"updated_by": 0,
"status": {
"time": 0,
"status": "string",
"uuid": "string",
"options": {},
"name": "string",
"message": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| ccda\_id | | **id of the ccda request** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Ccda/post_ccda)[/ccda](https://developer.carecloud.com/static/swagger.html\#!/Ccda/post_ccda)
- [Create Ccda Request](https://developer.carecloud.com/static/swagger.html#!/Ccda/post_ccda)
#### Implementation Notes
Create a Ccda Request for all patients for a business entity.
Optionally takes either a single `date` or both a `start_date` and an `end_date`
for scoping to a particular date of service or a range of dates.
All dates are in YYYY-MM-DD format.
If any data does not have a date associated to it then it will always be returned. Immunizations and vital signs returned are a historical list from most recent date provided regardless if they occurred on the date or during the date range provided because they are considered "medically necessary" information.
Optionally takes an array of `patient_ids` to scope the ccda request for
specified patients.
Also, optionally takes an array of any of these CCDS Sections
"PATIENT\_NAME", "SEX", "DATE\_OF\_BIRTH", "RACE", "ETHNICITY",
"PREFERRED\_LANGUAGE", "SMOKING\_STATUS", "PROBLEMS", "MEDICATIONS",
"MEDICATION\_ALLERGIES", "LABORATORY\_RESULTS",
"VITAL\_SIGNS", "PROCEDURES", "CARE\_TEAM\_MEMBERS", "IMMUNIZATIONS",
"UNIQUE\_DEVICE\_IDENTIFIERS", "PLAN\_OF\_TREATMENT", "GOALS",
"HEALTH\_CONCERNS", "REASON\_FOR\_REFERRAL","ASSESSMENT"
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateCcda\_Response {
business\_entity\_id (integer),
created\_at (string),
created\_by (integer),
document\_id (string),
document\_name (string),
document\_url (string),
guid (string),
id (integer),
job\_id (string),
provider\_id (integer),
updated\_at (string),
updated\_by (integer),
status (Ccda\_Status)
}
Ccda\_Status {
time (integer),
status (string),
uuid (string),
options (object),
name (string),
message (string)
}
```json
{
"business_entity_id": 0,
"created_at": "string",
"created_by": 0,
"document_id": "string",
"document_name": "string",
"document_url": "string",
"guid": "string",
"id": 0,
"job_id": "string",
"provider_id": 0,
"updated_at": "string",
"updated_by": 0,
"status": {
"time": 0,
"status": "string",
"uuid": "string",
"options": {},
"name": "string",
"message": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| filters | Parameter content type:application/json | | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Ccda\_Request {
date (string, optional),
start\_date (string, optional),
end\_date (string, optional),
patient\_ids (Array\[string\], optional),
sections (Array\[string\], optional)
}
```json
{
"date": "string",
"start_date": "string",
"end_date": "string",
"patient_ids": [
"string"
],
"sections": [
"string"
]
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 400 | Bad Request - Message will explain error | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateCcda\_BadDateFormatResponse {
error (Inline Model 1, optional)
}
Inline Model 1 {
date (string, optional),
start\_date (string, optional),
end\_date (string, optional),
base (string, optional),
sections (string, optional)
}
```json
{
"error": {
"date": "string",
"start_date": "string",
"end_date": "string",
"base": "string",
"sections": "string"
}
}
``` | |
| |
| 401 | Bad Request - Message will explain error | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateCcda\_UnauthorizedResponse {
error (string, optional)
}
```json
{
"error": "string"
}
``` | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Encounter Notes](https://developer.carecloud.com/static/swagger.html\#!/Encounter_Notes)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Encounter_Notes)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [put](https://developer.carecloud.com/static/swagger.html\#!/Encounter_Notes/put_encounter_notes_encounter_id_merge_transcriptions)[/encounter\_notes/{encounter\_id}/merge\_transcriptions](https://developer.carecloud.com/static/swagger.html\#!/Encounter_Notes/put_encounter_notes_encounter_id_merge_transcriptions)
- [Merge Clinical Transcriptions](https://developer.carecloud.com/static/swagger.html#!/Encounter_Notes/put_encounter_notes_encounter_id_merge_transcriptions)
#### Implementation Notes
Update encounter note with clinical transcription
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| transcription | Parameter content type:application/json | **Endpoint takes thirteen fields, with the transcription's paragraphs as items in an array:**
**Possible fields are:**
**```undefined**
**chief_complaint**
**history_of_present_illness**
**therapy**
**surgical_history**
**social_history**
**past_medical_history**
**current_medications**
**allergies**
**family_history**
**review_of_systems**
**physical_examination**
**diagnostic_imaging**
**impression_plan**
**```** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
EncounterNoteTranscription {
chief\_complaint (Array\[string\]),
history\_of\_present\_illness (Array\[string\]),
therapy (Array\[string\]),
surgical\_history (Array\[string\]),
social\_history (Array\[string\]),
past\_medical\_history (Array\[string\]),
current\_medications (Array\[string\]),
allergies (Array\[string\]),
family\_history (Array\[string\]),
review\_of\_systems (Array\[string\]),
physical\_examination (Array\[string\]),
diagnostic\_imaging (Array\[string\]),
impression\_plan (Array\[string\])
}
```json
{
"chief_complaint": [
"string"
],
"history_of_present_illness": [
"string"
],
"therapy": [
"string"
],
"surgical_history": [
"string"
],
"social_history": [
"string"
],
"past_medical_history": [
"string"
],
"current_medications": [
"string"
],
"allergies": [
"string"
],
"family_history": [
"string"
],
"review_of_systems": [
"string"
],
"physical_examination": [
"string"
],
"diagnostic_imaging": [
"string"
],
"impression_plan": [
"string"
]
}
```
Click to set as parameter value |
| encounter\_id | | **encounter\_id** | path | string |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 200 | Successfully updated encounter note | | |
| |
| 400 | Bad Request, JSON is malformed OR one or more of the sections is not supported | | |
| |
| 404 | Not Found, Encounter ID passed in URL does not have a Encounter Note associated to it. | | |
| |
| 409 | Conflict, Cannot update encounter note because it's not in an updatable state (namely, created or amended) | | |
| |
| 423 | Locked, Encounter note is being updated | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Locations](https://developer.carecloud.com/static/swagger.html\#!/Locations)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Locations)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Locations/get_locations)[/locations](https://developer.carecloud.com/static/swagger.html\#!/Locations/get_locations)
- [List Locations](https://developer.carecloud.com/static/swagger.html#!/Locations/get_locations)
#### Implementation Notes
Public locations will be returned. Public locations mean any location that has a community view selected within the practice's location settings.
By default, the value of all\_public query param is false.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
Location\
\
\]
Location {
id (string),
name (string),
is\_visible\_appointment\_scheduler (string),
place\_of\_service\_code (string, optional),
address (LocationAddress),
phones (Array\[LocationPhone\])
}
LocationAddress {
line1 (string),
line2 (string),
line3 (string),
city (string),
zip\_code (string),
county\_name (string),
latitude (float),
longitude (float),
state\_name (string)
}
LocationPhone {
phone\_number (string),
phone\_type (string),
phone\_ext (string),
is\_primary (boolean)
}
```json
[\
{\
"id": "string",\
"name": "string",\
"is_visible_appointment_scheduler": "string",\
"place_of_service_code": "string",\
"address": {\
"line1": "string",\
"line2": "string",\
"line3": "string",\
"city": "string",\
"zip_code": "string",\
"county_name": "string",\
"latitude": 0,\
"longitude": 0,\
"state_name": "string"\
},\
"phones": [\
{\
"phone_number": "string",\
"phone_type": "string",\
"phone_ext": "string",\
"is_primary": true\
}\
]\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| all\_public | truefalse | list of locations for a practice | query | boolean |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [OAuth](https://developer.carecloud.com/static/swagger.html\#!/OAuth)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/OAuth)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/OAuth/get_oauth2_authorization)[/oauth2/authorization](https://developer.carecloud.com/static/swagger.html\#!/OAuth/get_oauth2_authorization)
- [Authorization Details](https://developer.carecloud.com/static/swagger.html#!/OAuth/get_oauth2_authorization)
#### Implementation Notes
Show information about an authorization grant, such as the Practice ID, OAuth scopes, and the User who allowed it
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
OAuth2Authorization\_Response {
access\_token (string),
type (string),
expires\_in (integer),
scopes (Array\[string\]),
business\_entity (OAuth2Authorization\_Response\_business\_entity),
application (OAuth2Authorization\_Response\_application),
user (OAuth2Authorization\_Response\_user)
}
OAuth2Authorization\_Response\_business\_entity {
id (string),
name (string)
}
OAuth2Authorization\_Response\_application {
id (string)
}
OAuth2Authorization\_Response\_user {
id (string),
first\_name (string),
last\_name (string)
}
```json
{
"access_token": "string",
"type": "string",
"expires_in": 0,
"scopes": [\
"string"\
],
"business_entity": {
"id": "string",
"name": "string"
},
"application": {
"id": "string"
},
"user": {
"id": "string",
"first_name": "string",
"last_name": "string"
}
}
```
Response Content Typeapplication/json
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/OAuth/get_oauth2_token_info)[/oauth2/token\_info](https://developer.carecloud.com/static/swagger.html\#!/OAuth/get_oauth2_token_info)
- [Token Details](https://developer.carecloud.com/static/swagger.html#!/OAuth/get_oauth2_token_info)
#### Implementation Notes
Show information about a token, such as the time remaining until it expires
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
OAuth2TokenInfo\_Response {
access\_token (string),
type (string),
expires\_in (integer),
scope (string)
}
```json
{
"access_token": "string",
"type": "string",
"expires_in": 0,
"scope": "string"
}
```
Response Content Typeapplication/json
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Referral Location](https://developer.carecloud.com/static/swagger.html\#!/Referral_Location)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Referral_Location)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Referral_Location/get_referral_location_search)[/referral\_location/search](https://developer.carecloud.com/static/swagger.html\#!/Referral_Location/get_referral_location_search)
- [Show Referral Location](https://developer.carecloud.com/static/swagger.html#!/Referral_Location/get_referral_location_search)
#### Implementation Notes
Show Referral Location
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
ReferralLocationObject\
\
\]
ReferralLocationObject {
location\_id (string, optional),
location\_name (string, optional),
addresses (Array\[ReferralAddressCreate\], optional),
phones (Array\[ReferralPhoneCreate\], optional)
}
ReferralAddressCreate {
line1 (string),
line2 (string),
city (string),
state\_code (string),
zip\_code (string)
}
ReferralPhoneCreate {
phone\_number (string),
phone\_type\_code (string),
extension (string)
}
```json
[\
{\
"location_id": "string",\
"location_name": "string",\
"addresses": [\
{\
"line1": "string",\
"line2": "string",\
"city": "string",\
"state_code": "string",\
"zip_code": "string"\
}\
],\
"phones": [\
{\
"phone_number": "string",\
"phone_type_code": "string",\
"extension": "string"\
}\
]\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| name | | Name of the Referral Location | query | string |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | referral location is not found | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Referral_Location/post_referral_location_create)[/referral\_location/create](https://developer.carecloud.com/static/swagger.html\#!/Referral_Location/post_referral_location_create)
- [Create Referral Location](https://developer.carecloud.com/static/swagger.html#!/Referral_Location/post_referral_location_create)
#### Implementation Notes
Create a Referral Location
| parameter | options |
| --- | --- |
| state\_code | Uses FIPS 2 letter state abbreviations ( [FIPS code listing](https://www.mcc.co.mercer.pa.us/dps/state_fips_code_listing.htm)) | |
| phone\_type\_code | "B": Business; "M": Main; "F": Fax; "P": Pager; "C": Cell; "H": Home | |
- The phones array must contain 2 elements. A phone number for a fax machine, and a phone number associated to the location.
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ReferralLocationCreate\_Response {
location\_id (string)
}
```json
{
"location_id": "string"
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| query | Parameter content type:application/json | **referral location creation payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ReferralLocationCreate {
location\_name (string),
effective\_from (string),
address (ReferralAddressCreate),
phones (Array\[ReferralPhoneCreate\], optional)
}
ReferralAddressCreate {
line1 (string),
line2 (string),
city (string),
state\_code (string),
zip\_code (string)
}
ReferralPhoneCreate {
phone\_number (string),
phone\_type\_code (string),
extension (string)
}
```json
{
"location_name": "string",
"effective_from": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state_code": "string",
"zip_code": "string"
},
"phones": [
{
"phone_number": "string",
"phone_type_code": "string",
"extension": "string"
}
]
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 422 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Referral_Location/get_referral_source_search)[/referral\_source/search](https://developer.carecloud.com/static/swagger.html\#!/Referral_Location/get_referral_source_search)
- [Show Referral Source Details](https://developer.carecloud.com/static/swagger.html#!/Referral_Location/get_referral_source_search)
#### Implementation Notes
Show Referral Source Detail
| parameter | options |
| --- | --- |
| referral\_source\_type\_id | "1": Provider; "2": Attorney; "3": Other; | |
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
ReferralSourceObject\
\
\]
ReferralSourceObject {
first\_name (string, optional),
last\_name (string, optional),
tax\_id (string, optional),
npi (string, optional),
referral\_source\_type\_id (string, optional),
addresses (Array\[ReferralAddressCreate\], optional),
phones (Array\[ReferralPhoneCreate\], optional)
}
ReferralAddressCreate {
line1 (string),
line2 (string),
city (string),
state\_code (string),
zip\_code (string)
}
ReferralPhoneCreate {
phone\_number (string),
phone\_type\_code (string),
extension (string)
}
```json
[\
{\
"first_name": "string",\
"last_name": "string",\
"tax_id": "string",\
"npi": "string",\
"referral_source_type_id": "string",\
"addresses": [\
{\
"line1": "string",\
"line2": "string",\
"city": "string",\
"state_code": "string",\
"zip_code": "string"\
}\
],\
"phones": [\
{\
"phone_number": "string",\
"phone_type_code": "string",\
"extension": "string"\
}\
]\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| name | | **Name of the Referral Source** | query | string |
| referral\_source\_type\_id | | **Source Type Id of the Referral Source Detail** | query | string |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | referral source detail is not found | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Referral_Location/post_referral_source_create)[/referral\_source/create](https://developer.carecloud.com/static/swagger.html\#!/Referral_Location/post_referral_source_create)
- [Create Referral Source](https://developer.carecloud.com/static/swagger.html#!/Referral_Location/post_referral_source_create)
#### Implementation Notes
Create a Referral Source
| parameter | options |
| --- | --- |
| state\_code | Uses FIPS 2 letter state abbreviations ( [FIPS code listing](https://www.mcc.co.mercer.pa.us/dps/state_fips_code_listing.htm)) | |
| phone\_type\_code | "B": Business; "M": Main; "F": Fax; "P": Pager; "C": Cell; "H": Home | |
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ReferralSourceCreate\_Response {
referral\_source (string)
}
```json
{
"referral_source": "string"
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| query | Parameter content type:application/json | **referral source creation payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ReferralSourceCreate {
referral\_name (string),
referral\_location\_id (string),
effective\_from (string),
patient\_id (string),
referral\_provider (ReferralProviderCreate)
}
ReferralProviderCreate {
first\_name (string),
last\_name (string),
npi (string),
tax\_id (string, optional),
referral\_source\_type\_id (string)
}
```json
{
"referral_name": "string",
"referral_location_id": "string",
"effective_from": "string",
"patient_id": "string",
"referral_provider": {
"first_name": "string",
"last_name": "string",
"npi": "string",
"tax_id": "string",
"referral_source_type_id": "string"
}
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 422 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Patients](https://developer.carecloud.com/static/swagger.html\#!/Patients)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Patients)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Patients/post_patients)[/patients](https://developer.carecloud.com/static/swagger.html\#!/Patients/post_patients)
- [Create Patient](https://developer.carecloud.com/static/swagger.html#!/Patients/post_patients)
#### Implementation Notes
Create a Patient
| parameter | options |
| --- | --- |
| gender\_code | Uses FHIR DSTU 1 (v0.0.82) administrative gender codes ( [FHIR Documentation](http://www.hl7.org/FHIR/valueset-administrative-gender.html)) | |
| race\_code | Uses HL7 Race Codes with "" as Declined to Specify. ( [HL7 List](https://www.hl7.org/fhir/us/core/CodeSystem-cdcrec.html)) | |
| marital\_status\_code | Uses FHIR DSTU 1 (v0.0.82) administrative marital status codes. A, I and P are not supported. ( [FHIR Documentation](http://www.hl7.org/FHIR/valueset-marital-status.html)) | |
| state | Uses FIPS 2 letter state abbreviations ( [FIPS code listing](https://www.mcc.co.mercer.pa.us/dps/state_fips_code_listing.htm)) | |
| country\_name | Uses ISO Alpha-3 letter abbreviations ( [ISO Alpha-3 code listing](http://www.nationsonline.org/oneworld/country_code_list.htm)) | |
| language\_code | Uses ISO639.2 Language Codes ( [ISO639.2 Language list](http://www.loc.gov/standards/iso639-2/php/code_list.php)) | |
| drivers\_license\_state\_code | Uses USPS 2-Letter State Abbreviations | |
| employment\_status\_code | "E": Employed; "D": Disabled; "R": Retired; "P": Part Time; "U": Unknown; "S": Student'; "N": Not Employed | |
| ethnicity\_code | "U": Declined To Provide; "H": Hispanic or Latino; "N": Not Hispanic or Latino | |
| student\_status\_code | "F": Full Time; "P": Part Time; "N": Not A Student; "U": Unknown | |
| phone\_type\_code | "B": Business; "M": Main; "F": Fax; "P": Pager; "C": Cell; "H": Home | |
| employer\_id | You can get employer\_id from employers section, for more details see, [Employers](https://developer.carecloud.com/static/swagger.html#!/Employers) |
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
PatientCreate\_Response {
patient (string)
}
```json
{
"patient": "string"
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| query | Parameter content type:application/json | **patient creation payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
PatientCreate {
patient (Patient),
addresses (Array\[PatientAddressCreate\]),
phones (Array\[PatientPhoneCreate\])
}
Patient {
first\_name (string),
last\_name (string),
middle\_initial (string, optional),
email (string, optional),
prefix (string, optional),
suffix (string, optional),
ssn (string, optional),
gender\_code (string, optional),
date\_of\_birth (string, optional),
race\_code (string, optional),
marital\_status\_code (string, optional),
language\_code (string, optional),
chart\_number (string, optional),
drivers\_license\_number (string, optional),
drivers\_license\_state\_code (string, optional),
employment\_status\_code (string, optional),
school\_name (string, optional),
employer\_id (integer, optional),
account\_number (string, optional),
legacy\_patient\_id (string, optional),
ethnicity\_code (string, optional),
student\_status\_code (string, optional),
primary\_care\_physician\_npi (integer, optional),
referring\_physician\_npi (integer, optional),
mother\_maiden\_name (string, optional)
}
PatientAddressCreate {
line1 (string),
line2 (string),
city (string),
state (string),
zip\_code (string),
country\_name (string),
is\_primary (boolean)
}
PatientPhoneCreate {
phone\_number (string),
phone\_type\_code (string),
extension (string),
is\_primary (boolean)
}
```json
{
"patient": {
"first_name": "string",
"last_name": "string",
"middle_initial": "string",
"email": "string",
"prefix": "string",
"suffix": "string",
"ssn": "string",
"gender_code": "string",
"date_of_birth": "string",
"race_code": "string",
"marital_status_code": "string",
"language_code": "string",
"chart_number": "string",
"drivers_license_number": "string",
"drivers_license_state_code": "string",
"employment_status_code": "string",
"school_name": "string",
"employer_id": 0,
"account_number": "string",
"legacy_patient_id": "string",
"ethnicity_code": "string",
"student_status_code": "string",
"primary_care_physician_npi": 0,
"referring_physician_npi": 0,
"mother_maiden_name": "string"
},
"addresses": [
{
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"country_name": "string",
"is_primary": true
}
],
"phones": [
{
"phone_number": "string",
"phone_type_code": "string",
"extension": "string",
"is_primary": true
}
]
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 422 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Patients/post_patients_search)[/patients/search](https://developer.carecloud.com/static/swagger.html\#!/Patients/post_patients_search)
- [Search Patients](https://developer.carecloud.com/static/swagger.html#!/Patients/post_patients_search)
#### Implementation Notes
Search for a Patient
You must choose among searching by "terms", "fields", or by "search".
When providing an array of "terms", the following patient attributes will be interrogated for a match:
- first name
- last name
- ssn
- patient number
- chart number
- driver's license
- email
- date\_of\_birth ( _term must be in the format of MM/DD/YYYY, MM-DD-YYYY, MMDDYYYY, MMDDYY, MM/DD/YY, or MM-DD-YY_)
- insurance policy numbers
- insurance member numbers
- phone\_number ( _value must be in the format of xxx-xxx-xxxx or xxxxxxxxxx_)
When providing a "fields" object, results will match the provided values for the specific fields given. You can not search by gender or phone number fields only. You must include a first\_name, last\_name or dob field. Supported fields are:
- first\_name
- last\_name
- dob ( _value must be in the format of MM/DD/YYYY, MM-DD-YYYY, MMDDYYYY, MMDDYY, MM/DD/YY, or MM-DD-YY_)
- gender (pass in 'm' for male or 'f' for female or 'u' for unknown)
- phone\_number ( _value must be in the format of xxx-xxx-xxxx or xxxxxxxxxx_)
When providing a "search" object, results will match a date range of when the patient was created based on two date fields:
- created\_from ( _value must be in the format of YYYY-MM-DD_)
- created\_to ( _value must be in the format of YYYY-MM-DD_)
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
PatientSearch\
\
\]
PatientSearch {
patients (PatientSearchInner)
}
PatientSearchInner {
id (string),
external\_id (string),
first\_name (string),
last\_name (string),
middle\_initial (string),
name (string),
dob (string),
account\_balance (string),
chart\_number (string),
last\_seen\_date (string),
gender (string),
gender\_id (string),
primary\_location\_id (string),
phones (Array\[PatientPhoneCreate\], optional),
email (string, optional),
photo (string)
}
PatientPhoneCreate {
phone\_number (string),
phone\_type\_code (string),
extension (string),
is\_primary (boolean)
}
```json
[\
{\
"patients": {\
"id": "string",\
"external_id": "string",\
"first_name": "string",\
"last_name": "string",\
"middle_initial": "string",\
"name": "string",\
"dob": "string",\
"account_balance": "string",\
"chart_number": "string",\
"last_seen_date": "string",\
"gender": "string",\
"gender_id": "string",\
"primary_location_id": "string",\
"phones": [\
{\
"phone_number": "string",\
"phone_type_code": "string",\
"extension": "string",\
"is_primary": true\
}\
],\
"email": "string",\
"photo": "string"\
}\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| query | Parameter content type:application/json | **search query** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
PatientSearch\_Request {
limit (integer),
search (PatientSearch\_Request\_created\_range),
terms (Array\[string\]),
fields (PatientSearch\_Request\_fields)
}
PatientSearch\_Request\_created\_range {
created\_from (string): YYYYMMDD,
created\_to (string): YYYYMMDD
}
PatientSearch\_Request\_fields {
first\_name (string),
last\_name (string),
dob (string): MMDDYYYY,
gender (string),
phone\_number (string)
}
```json
{
"limit": 0,
"search": {
"created_from": "string",
"created_to": "string"
},
"terms": [
"string"
],
"fields": {
"first_name": "string",
"last_name": "string",
"dob": "string",
"gender": "string",
"phone_number": "string"
}
}
```
Click to set as parameter value |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id)[/patients/{patient\_id}](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id)
- [Show Patient](https://developer.carecloud.com/static/swagger.html#!/Patients/get_patients_patient_id)
#### Implementation Notes
Show a Patient by its ID
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
PatientObject {
patient (PatientShow)
}
PatientShow {
id (string),
first\_name (string),
last\_name (string),
middle\_initial (string),
prefix (string),
suffix (string),
preferred\_name (string),
ssn (string),
name (string),
dob (string),
email\_address (string),
status (string),
status\_id (string),
legacy\_patient\_id (string),
race\_id (integer),
chart\_number (string),
account\_number (string),
business\_entity\_id (integer),
business\_entity\_name (string),
preferred\_communication\_method= (string),
interface (PatientInterface),
emergency\_contact\_first\_name (string),
emergency\_contact\_last\_name (string),
emergency\_contact\_email (string),
emergency\_contact\_date\_of\_birth (string),
emergency\_contact\_gender (string),
emergency\_contact\_addresses (Array\[PatientAddress\]),
emergency\_contact\_phones (Array\[Inline Model 1\]),
emergency\_contact\_person\_relationship\_type (string),
date\_of\_death (string),
last\_seen\_date (string),
drivers\_license\_number (string),
drivers\_license\_state\_id (string),
drivers\_license\_state\_cc\_id (integer),
employment\_code (string),
employment\_description (string),
employment\_id (integer),
employment\_name (string),
employer (Employer),
student\_status\_code (string),
student\_status\_id (integer),
student\_status\_name (string),
marital\_status\_code (string),
marital\_status (string),
language\_id (integer),
language (string),
language\_code (string),
gender (string),
gender\_id (integer),
ethnicity (string),
ethnicity\_id (integer),
ethnicity\_code (string),
race (string),
race\_code (string),
mother\_maiden\_name (string),
primary\_location (PatientPrimaryLocation),
primary\_provider\_id (string),
primary\_provider\_npi (string),
primary\_provider\_first\_name (string),
primary\_provider\_last\_name (string),
primary\_care\_physician\_addresses (Array\[PhysicianAddress\]),
primary\_care\_physician\_default\_specialty (Inline Model 2),
primary\_care\_physician\_email (string),
primary\_care\_physician\_first\_name (string),
primary\_care\_physician\_last\_name (string),
primary\_care\_physician\_middle\_name (string),
primary\_care\_physician\_npi (string),
primary\_care\_physician\_prefix (string),
primary\_care\_physician\_phones (Array\[PhysicianPhone\]),
referring\_physician\_addresses (Array\[PhysicianAddress\]),
referring\_physician\_default\_specialty (Inline Model 3),
referring\_physician\_email (string),
referring\_physician\_first\_name (string),
referring\_physician\_last\_name (string),
referring\_physician\_middle\_name (string),
referring\_physician\_prefix (string),
referring\_physician\_phones (Array\[PhysicianPhone\]),
referring\_physician\_npi (string),
responsible\_party (PatientResponsibleParty),
insurance\_profiles (Array\[InsuranceProfile\]),
addresses (Array\[PatientAddress\]),
phones (Array\[PatientPhone\]),
photo (Inline Model 4),
gender\_code (string),
created\_at (string),
updated\_at (string)
}
PatientInterface {
interface\_code (string),
interface\_password (string)
}
PatientAddress {
id (integer),
line1 (string),
line2 (string),
line3 (string),
city (string),
state (string),
state\_id (integer),
state\_code (string),
zip\_code (string),
country\_id (integer),
country\_name (string),
county\_name (string),
is\_primary (boolean)
}
Inline Model 1 {
emergency\_contact\_phone\_number (string, optional),
phone\_type (integer, optional),
phone\_ext (string, optional),
is\_primary (boolean, optional)
}
Employer {
employer\_id (integer),
employer\_name (string),
employer\_addresses (Array\[EmployerAddress\], optional),
employer\_phones (Array\[EmployerPhone\], optional)
}
PatientPrimaryLocation {
id (integer),
name (string),
mnemonic (string),
additional\_name (string),
fda\_number (string),
clia\_number (string),
npi (string),
is\_default (boolean),
address (PatientPrimaryLocationAddress)
}
PhysicianAddress {
line1 (string),
line2 (string),
city (string),
state (string),
state\_id (integer),
zip (string),
country\_id (integer),
country\_name (string)
}
Inline Model 2 {
name (string, optional),
specialty\_type (string, optional),
status (string, optional)
}
PhysicianPhone {
id (integer),
phone\_number (string),
phone\_type (string),
phone\_type\_id (integer),
phone\_ext (string),
is\_primary (boolean)
}
Inline Model 3 {
name (string, optional),
specialty\_type (string, optional),
status (string, optional)
}
PatientResponsibleParty {
responsible\_party\_person\_relationship\_type\_id (integer),
responsible\_party\_person\_relationship\_type\_name (string),
responsible\_party\_person\_relationship\_type\_code (string),
id (integer),
name (string),
last\_name (string),
first\_name (string),
middle (string),
dob (string),
gender\_id (integer),
gender (string),
addresses (Array\[PatientAddress\]),
phones (Array\[PatientPhone\])
}
InsuranceProfile {
id (integer),
self\_pay (boolean),
insurance\_policies (Array\[InsurancePolicy\_for\_Patient\_Response\])
}
PatientPhone {
id (integer),
phone\_number (string),
phone\_type (integer),
phone\_type\_code (string),
phone\_ext (string),
is\_primary (boolean)
}
Inline Model 4 {
small (string, optional),
medium (string, optional),
avatar (string, optional)
}
EmployerAddress {
id (integer),
line1 (string),
line2 (string),
city (string),
state (string),
state\_code (string, optional),
zip\_code (string),
country\_name (string)
}
EmployerPhone {
id (integer, optional),
phone\_number (string),
phone\_type\_code (integer, optional),
extension (string)
}
PatientPrimaryLocationAddress {
line1 (string),
line2 (string),
line3 (string),
city (string),
state (string),
zip\_code (string),
country\_name (string),
county\_name (string),
latitude (float),
longitude (float)
}
InsurancePolicy\_for\_Patient\_Response {
policy\_priority (integer, optional),
member\_number (string, optional),
payer\_plan\_id (integer, optional),
payer\_plan\_name (string, optional),
policy\_number (string, optional),
group\_name (string, optional),
effective\_to (string, optional),
effective\_from (string, optional),
co\_payment (string, optional),
deductible (string, optional),
requires\_authorization (boolean, optional),
type (string, optional),
payer (object, optional),
insured\_contact (object, optional)
}
```json
{
"patient": {
"id": "string",
"first_name": "string",
"last_name": "string",
"middle_initial": "string",
"prefix": "string",
"suffix": "string",
"preferred_name": "string",
"ssn": "string",
"name": "string",
"dob": "string",
"email_address": "string",
"status": "string",
"status_id": "string",
"legacy_patient_id": "string",
"race_id": 0,
"chart_number": "string",
"account_number": "string",
"business_entity_id": 0,
"business_entity_name": "string",
"preferred_communication_method=": "string",
"interface": {
"interface_code": "string",
"interface_password": "string"
},
"emergency_contact_first_name": "string",
"emergency_contact_last_name": "string",
"emergency_contact_email": "string",
"emergency_contact_date_of_birth": "string",
"emergency_contact_gender": "string",
"emergency_contact_addresses": [\
{\
"id": 0,\
"line1": "string",\
"line2": "string",\
"line3": "string",\
"city": "string",\
"state": "string",\
"state_id": 0,\
"state_code": "string",\
"zip_code": "string",\
"country_id": 0,\
"country_name": "string",\
"county_name": "string",\
"is_primary": true\
}\
],
"emergency_contact_phones": [\
{\
"emergency_contact_phone_number": "string",\
"phone_type": 0,\
"phone_ext": "string",\
"is_primary": true\
}\
],
"emergency_contact_person_relationship_type": "string",
"date_of_death": "string",
"last_seen_date": "string",
"drivers_license_number": "string",
"drivers_license_state_id": "string",
"drivers_license_state_cc_id": 0,
"employment_code": "string",
"employment_description": "string",
"employment_id": 0,
"employment_name": "string",
"employer": {
"employer_id": 0,
"employer_name": "string",
"employer_addresses": [\
{\
"id": 0,\
"line1": "string",\
"line2": "string",\
"city": "string",\
"state": "string",\
"state_code": "string",\
"zip_code": "string",\
"country_name": "string"\
}\
],
"employer_phones": [\
{\
"id": 0,\
"phone_number": "string",\
"phone_type_code": 0,\
"extension": "string"\
}\
]
},
"student_status_code": "string",
"student_status_id": 0,
"student_status_name": "string",
"marital_status_code": "string",
"marital_status": "string",
"language_id": 0,
"language": "string",
"language_code": "string",
"gender": "string",
"gender_id": 0,
"ethnicity": "string",
"ethnicity_id": 0,
"ethnicity_code": "string",
"race": "string",
"race_code": "string",
"mother_maiden_name": "string",
"primary_location": {
"id": 0,
"name": "string",
"mnemonic": "string",
"additional_name": "string",
"fda_number": "string",
"clia_number": "string",
"npi": "string",
"is_default": true,
"address": {
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"country_name": "string",
"county_name": "string",
"latitude": 0,
"longitude": 0
}
},
"primary_provider_id": "string",
"primary_provider_npi": "string",
"primary_provider_first_name": "string",
"primary_provider_last_name": "string",
"primary_care_physician_addresses": [\
{\
"line1": "string",\
"line2": "string",\
"city": "string",\
"state": "string",\
"state_id": 0,\
"zip": "string",\
"country_id": 0,\
"country_name": "string"\
}\
],
"primary_care_physician_default_specialty": {
"name": "string",
"specialty_type": "string",
"status": "string"
},
"primary_care_physician_email": "string",
"primary_care_physician_first_name": "string",
"primary_care_physician_last_name": "string",
"primary_care_physician_middle_name": "string",
"primary_care_physician_npi": "string",
"primary_care_physician_prefix": "string",
"primary_care_physician_phones": [\
{\
"id": 0,\
"phone_number": "string",\
"phone_type": "string",\
"phone_type_id": 0,\
"phone_ext": "string",\
"is_primary": true\
}\
],
"referring_physician_addresses": [\
{\
"line1": "string",\
"line2": "string",\
"city": "string",\
"state": "string",\
"state_id": 0,\
"zip": "string",\
"country_id": 0,\
"country_name": "string"\
}\
],
"referring_physician_default_specialty": {
"name": "string",
"specialty_type": "string",
"status": "string"
},
"referring_physician_email": "string",
"referring_physician_first_name": "string",
"referring_physician_last_name": "string",
"referring_physician_middle_name": "string",
"referring_physician_prefix": "string",
"referring_physician_phones": [\
{\
"id": 0,\
"phone_number": "string",\
"phone_type": "string",\
"phone_type_id": 0,\
"phone_ext": "string",\
"is_primary": true\
}\
],
"referring_physician_npi": "string",
"responsible_party": {
"responsible_party_person_relationship_type_id": 0,
"responsible_party_person_relationship_type_name": "string",
"responsible_party_person_relationship_type_code": "string",
"id": 0,
"name": "string",
"last_name": "string",
"first_name": "string",
"middle": "string",
"dob": "string",
"gender_id": 0,
"gender": "string",
"addresses": [\
{\
"id": 0,\
"line1": "string",\
"line2": "string",\
"line3": "string",\
"city": "string",\
"state": "string",\
"state_id": 0,\
"state_code": "string",\
"zip_code": "string",\
"country_id": 0,\
"country_name": "string",\
"county_name": "string",\
"is_primary": true\
}\
],
"phones": [\
{\
"id": 0,\
"phone_number": "string",\
"phone_type": 0,\
"phone_type_code": "string",\
"phone_ext": "string",\
"is_primary": true\
}\
]
},
"insurance_profiles": [\
{\
"id": 0,\
"self_pay": true,\
"insurance_policies": [\
{\
"policy_priority": 0,\
"member_number": "string",\
"payer_plan_id": 0,\
"payer_plan_name": "string",\
"policy_number": "string",\
"group_name": "string",\
"effective_to": "string",\
"effective_from": "string",\
"co_payment": "string",\
"deductible": "string",\
"requires_authorization": true,\
"type": "string",\
"payer": {},\
"insured_contact": {}\
}\
]\
}\
],
"addresses": [\
{\
"id": 0,\
"line1": "string",\
"line2": "string",\
"line3": "string",\
"city": "string",\
"state": "string",\
"state_id": 0,\
"state_code": "string",\
"zip_code": "string",\
"country_id": 0,\
"country_name": "string",\
"county_name": "string",\
"is_primary": true\
}\
],
"phones": [\
{\
"id": 0,\
"phone_number": "string",\
"phone_type": 0,\
"phone_type_code": "string",\
"phone_ext": "string",\
"is_primary": true\
}\
],
"photo": {
"small": "string",
"medium": "string",
"avatar": "string"
},
"gender_code": "string",
"created_at": "string",
"updated_at": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **GUID of the patient** | path | string |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | patient not found for current practice | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [put](https://developer.carecloud.com/static/swagger.html\#!/Patients/put_patients_patient_id)[/patients/{patient\_id}](https://developer.carecloud.com/static/swagger.html\#!/Patients/put_patients_patient_id)
- [Update Patient](https://developer.carecloud.com/static/swagger.html#!/Patients/put_patients_patient_id)
#### Implementation Notes
Update a Patient
| parameter | options |
| --- | --- |
| gender\_code | Uses FHIR DSTU 1 (v0.0.82) administrative gender codes ( [FHIR Documentation](http://www.hl7.org/FHIR/valueset-administrative-gender.html)) | |
| race\_code | Uses HL7 Race Codes with "" as Declined to Specify. ( [HL7 List](https://www.hl7.org/fhir/us/core/CodeSystem-cdcrec.html)) | |
| marital\_status\_code | Uses FHIR DSTU 1 (v0.0.82) administrative marital status codes. A, I and P are not supported. ( [FHIR Documentation](http://www.hl7.org/FHIR/valueset-marital-status.html)) | |
| state\_code | Uses FIPS 2 letter state abbreviations ( [FIPS code listing](https://www.mcc.co.mercer.pa.us/dps/state_fips_code_listing.htm)) | |
| country\_name | Uses ISO Alpha-3 letter abbreviations ( [ISO Alpha-3 code listing](http://www.nationsonline.org/oneworld/country_code_list.htm)) | |
| language\_code | Uses ISO639.2 Language Codes ( [ISO639.2 Language list](http://www.loc.gov/standards/iso639-2/php/code_list.php)) | |
| drivers\_license\_state\_code | Uses USPS 2-Letter State Abbreviations | |
| employment\_status\_code | "E": Employed; "D": Disabled; "R": Retired; "P": Part Time; "U": Unknown; "S": Student'; "N": Not Employed | |
| ethnicity\_code | "U": Declined To Provide; "H": Hispanic or Latino; "N": Not Hispanic or Latino | |
| student\_status\_code | "F": Full Time; "P": Part Time; "N": Not A Student; "U": Unknown | |
| phone\_type\_code | "B": Business; "M": Main; "F": Fax; "P": Pager; "C": Cell; "H": Home | |
| employer\_id | You can get employer\_id from employers section, for more details see, [Employers](https://developer.carecloud.com/static/swagger.html#!/Employers) |
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **GUID of the patient** | path | string |
| body | Parameter content type:application/json | **patient update payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
PatientCreate {
patient (Patient),
addresses (Array\[PatientAddressCreate\]),
phones (Array\[PatientPhoneCreate\])
}
Patient {
first\_name (string),
last\_name (string),
middle\_initial (string, optional),
email (string, optional),
prefix (string, optional),
suffix (string, optional),
ssn (string, optional),
gender\_code (string, optional),
date\_of\_birth (string, optional),
race\_code (string, optional),
marital\_status\_code (string, optional),
language\_code (string, optional),
chart\_number (string, optional),
drivers\_license\_number (string, optional),
drivers\_license\_state\_code (string, optional),
employment\_status\_code (string, optional),
school\_name (string, optional),
employer\_id (integer, optional),
account\_number (string, optional),
legacy\_patient\_id (string, optional),
ethnicity\_code (string, optional),
student\_status\_code (string, optional),
primary\_care\_physician\_npi (integer, optional),
referring\_physician\_npi (integer, optional),
mother\_maiden\_name (string, optional)
}
PatientAddressCreate {
line1 (string),
line2 (string),
city (string),
state (string),
zip\_code (string),
country\_name (string),
is\_primary (boolean)
}
PatientPhoneCreate {
phone\_number (string),
phone\_type\_code (string),
extension (string),
is\_primary (boolean)
}
```json
{
"patient": {
"first_name": "string",
"last_name": "string",
"middle_initial": "string",
"email": "string",
"prefix": "string",
"suffix": "string",
"ssn": "string",
"gender_code": "string",
"date_of_birth": "string",
"race_code": "string",
"marital_status_code": "string",
"language_code": "string",
"chart_number": "string",
"drivers_license_number": "string",
"drivers_license_state_code": "string",
"employment_status_code": "string",
"school_name": "string",
"employer_id": 0,
"account_number": "string",
"legacy_patient_id": "string",
"ethnicity_code": "string",
"student_status_code": "string",
"primary_care_physician_npi": 0,
"referring_physician_npi": 0,
"mother_maiden_name": "string"
},
"addresses": [
{
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"country_name": "string",
"is_primary": true
}
],
"phones": [
{
"phone_number": "string",
"phone_type_code": "string",
"extension": "string",
"is_primary": true
}
]
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 204 | patient updated successfully | | |
| |
| 422 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id_balance)[/patients/{patient\_id}/balance](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id_balance)
- [Show Balance for Patient](https://developer.carecloud.com/static/swagger.html#!/Patients/get_patients_patient_id_balance)
#### Implementation Notes
Show Balance information for a Patient
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
PatientBalance\
\
\]
PatientBalance {
balance\_type (string),
unapplied\_credit (string),
unbilled (string),
current (string),
greater\_than\_30 (string),
greater\_than\_60 (string),
greater\_than\_90 (string),
greater\_than\_120 (string),
total (string)
}
```json
[\
{\
"balance_type": "string",\
"unapplied_credit": "string",\
"unbilled": "string",\
"current": "string",\
"greater_than_30": "string",\
"greater_than_60": "string",\
"greater_than_90": "string",\
"greater_than_120": "string",\
"total": "string"\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **ID of the Patient** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id_charges)[/patients/{patient\_id}/charges](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id_charges)
- [List Patient Charges](https://developer.carecloud.com/static/swagger.html#!/Patients/get_patients_patient_id_charges)
#### Implementation Notes
List Charges for a Patient
Filtering params are optional. Date filtering fields filter by posting\_date.
Without date filtering, the past 30 days worth of posted charges for the Patient will be returned.
With just a start\_date, charges posted 30 days from the start\_date will be returned.
The following types of charges exist:
```undefined
simple_charge
charge
```
The following transaction\_statuses exist:
```undefined
posted
not_posted
closed
```
Results are paginated to 50 Transactions per page. The `page` parameter sets the page number to return, the default being `1`. Pagination state is indicated by the Link header, in accordance with [RFC5988](https://tools.ietf.org/html/rfc5988#section-5). The `Link` header contains URIs to the first, next, previous, and last pages in the result set. For an example see [Pagination](https://developer.carecloud.com/overview).
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
Transaction\_Response\
\
\]
Transaction\_Response {
id (integer),
amount (string),
balance (string),
unapplied\_credit (integer),
effective\_date (string, optional),
service\_date (string, optional),
posting\_date (string),
transaction\_type (string),
transaction\_status (string),
location\_id (integer),
provider\_id (integer),
procedure\_code (string, optional),
units (string),
diagnosis\_code(s) (string, optional),
description (string)
}
```json
[\
{\
"id": 0,\
"amount": "string",\
"balance": "string",\
"unapplied_credit": 0,\
"effective_date": "string",\
"service_date": "string",\
"posting_date": "string",\
"transaction_type": "string",\
"transaction_status": "string",\
"location_id": 0,\
"provider_id": 0,\
"procedure_code": "string",\
"units": "string",\
"diagnosis_code(s)": "string",\
"description": "string"\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **Patient ID** | path | string |
| start\_date | | Start Date | query | string |
| end\_date | | End Date | query | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Patients/post_patients_patient_id_charge)[/patients/{patient\_id}/charge](https://developer.carecloud.com/static/swagger.html\#!/Patients/post_patients_patient_id_charge)
- [Create a Patient Charge](https://developer.carecloud.com/static/swagger.html#!/Patients/post_patients_patient_id_charge)
#### Implementation Notes
Create a Charge for a Patient
If `provider_id`, `location_id`, or `insurance_profile_id` is nil then the value is set to the patient's default. If a patient doesn't have a default then a 400 will be returned.
`start_time` and `end_time` must be formatted in [ISO-8601 Timestamp](https://developer.carecloud.com/overview#4) in UTC timezone, `YYYY-MM-DD` T `HH:MM`. There is a `T` that separates the date and time parts. The `start_time` and `end_time` will display in the practice's time zone in CareCloud.
If `encounter_id` is nil then an encounter is created. Each request creates a single charge to an encounter. If `provider_id`, `location_id`, and `start_time` (only the date portion) all match for an exisiting encounter then a new charge is added to that encounter.
Valid `icd_indicator` values are 9 or 10. 10 is the default.
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
CreateCharge\_Response\
\
\]
CreateCharge\_Response {
id (integer, optional),
encounter\_id (integer, optional)
}
```json
[\
{\
"id": 0,\
"encounter_id": 0\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **Patient ID** | path | string |
| body | Parameter content type:application/json | **Charge details** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateCharge\_Request {
charge (CreateCharge\_Object)
}
CreateCharge\_Object {
provider\_id (string, optional),
insurance\_profile\_id (string, optional),
referring\_physician\_id (string, optional),
authorization\_id (string, optional),
clinical\_case\_id (string, optional),
location\_id (string, optional),
encounter\_id (string, optional),
start\_time (string),
end\_time (string),
units (string),
icd\_indicator (string, optional),
amount (string, optional),
procedure\_code (string),
diagnosis1\_code (string),
diagnosis2\_code (string, optional),
diagnosis3\_code (string, optional),
diagnosis4\_code (string, optional),
diagnosis5\_code (string, optional),
diagnosis6\_code (string, optional),
diagnosis7\_code (string, optional),
diagnosis8\_code (string, optional),
modifier1\_code (string, optional),
modifier2\_code (string, optional),
modifier3\_code (string, optional),
modifier4\_code (string, optional)
}
```json
{
"charge": {
"provider_id": "string",
"insurance_profile_id": "string",
"referring_physician_id": "string",
"authorization_id": "string",
"clinical_case_id": "string",
"location_id": "string",
"encounter_id": "string",
"start_time": "string",
"end_time": "string",
"units": "string",
"icd_indicator": "string",
"amount": "string",
"procedure_code": "string",
"diagnosis1_code": "string",
"diagnosis2_code": "string",
"diagnosis3_code": "string",
"diagnosis4_code": "string",
"diagnosis5_code": "string",
"diagnosis6_code": "string",
"diagnosis7_code": "string",
"diagnosis8_code": "string",
"modifier1_code": "string",
"modifier2_code": "string",
"modifier3_code": "string",
"modifier4_code": "string"
}
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 400 | Invalid Request | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [put](https://developer.carecloud.com/static/swagger.html\#!/Patients/put_patients_patient_id_insurances_insurance_profile_id_policies_insurance_policy_id)[/patients/{patient\_id}/insurances/{insurance\_profile\_id}/policies/{insurance\_policy\_id}](https://developer.carecloud.com/static/swagger.html\#!/Patients/put_patients_patient_id_insurances_insurance_profile_id_policies_insurance_policy_id)
- [Update Patient Insurance Policy](https://developer.carecloud.com/static/swagger.html#!/Patients/put_patients_patient_id_insurances_insurance_profile_id_policies_insurance_policy_id)
#### Implementation Notes
Update Patient Insurance Policy
It is not allowed to update the Payer when an an Insurance Policy is in use (claim submitted/ pending).
Include the payer’s `id` to set a Payer from the CareCloud Payers library. If the Payer has associated plan(s) then it’s required to include a `plan_id`. If the Payer is not in the CareCloud Payer library then create a new payer.
For `insured_person_relationship`, the following Patient Relationship Types are supported:
```undefined
unknown
organ_donor
cadaver_donor
life_partner
nephew
significant_other
dependant_of_a_minor_dependant
ward
stepchild
handicapped_dependent
emancipated_minor
injured_plaintiff
child_where_insured_has_no_financial_responsibility
father
grandparent
self
attorney
other
domestic_partner
paternal_grandparent
maternal_grandparent
aunt_uncle
sibling
niece
foster_child
sponsored_dependent
child
grandchild
spouse
mother
foster_parent
employee
```
For `insurance_policy_type`, the following Insurance Types are available:
```undefined
choice_epo
capitation
open_access
attorney
auto_insurance
champus
flat_fee_arrangement
hmo
medicaid
medikids
medipass_or_psn
pos
workers_compensation
healthy_kids
ppo
exclusive_provider_organization_(epo)
blue_cross_blue_shield
medicare_hmo
medicare_supplement
commercial_insurance
other_federal_program
federal_employees_program
indemnity_insurance
medicare_ppo
medicaid_hmo
medicare_railroad
medicare_b
medicare_a
mutually_defined
champ_va
medicare_pos
medicaid_newborn
choice_plus
```
The `phone_type` field can be filled in with one of the following codes:
| code | description |
| --- | --- |
| B | Business | |
| M | Main | |
| F | Fax | |
| P | Pager | |
| C | Cell | |
| H | Home | |
The `state_code` field of an Address should use a FIPS 2 letter state abbreviation ( [FIPS code listing](https://www.mcc.co.mercer.pa.us/dps/state_fips_code_listing.htm))
The `country_code` field of an Address should use a [three-letter ISO3166 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
`effective_date` and `termination_date` must be in the date format, `YYYY-MM-DD`.
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
InsurancePolicy\_Response {
insurance\_profile (Inline Model 1, optional),
insurance\_policy (InsurancePolicy\_Response\_insurance\_policy)
}
Inline Model 1 {
id (integer, optional),
name (string, optional)
}
InsurancePolicy\_Response\_insurance\_policy {
id (integer, optional),
priority (integer, optional),
payer\_pending\_approval (boolean, optional),
updated\_at (string, optional)
}
```json
{
"insurance_profile": {
"id": 0,
"name": "string"
},
"insurance_policy": {
"id": 0,
"priority": 0,
"payer_pending_approval": true,
"updated_at": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **GUID of the patient** | path | string |
| insurance\_profile\_id | | **Insurance Profile id** | path | string |
| insurance\_policy\_id | | **Insurance Policy id** | path | string |
| body | Parameter content type:application/json | **Insurance Policy details** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
InsurancePolicy\_Request {
insurance\_policy (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy)
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy {
insured\_person\_relationship (string),
insurance\_policy\_type (string),
member\_number (string),
group\_number (string),
group\_name (string, optional),
effective\_date (string),
termination\_date (string, optional),
requires\_authorization (boolean, optional),
co\_payment (string, optional),
deductible (string, optional),
plan\_id (string, optional),
payer (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_payer),
insured (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured)
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_payer {
id (string),
name (string),
address (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_payer\_address),
phone (string)
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured {
first\_name (string),
last\_name (string),
date\_of\_birth (string),
ssn (string),
gender\_code (string),
email (string),
addresses (Array\[InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured\_addresses\]),
phones (Array\[InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured\_phones\])
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_payer\_address {
line1 (string),
line2 (string),
city (string),
state\_code (string),
zip\_code (string),
country\_code (string)
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured\_addresses {
line1 (string),
city (string),
state\_code (string),
zip\_code (string),
country\_code (string),
is\_primary (boolean)
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured\_phones {
phone\_number (string),
phone\_type\_code (string),
extension (string),
is\_primary (boolean)
}
```json
{
"insurance_policy": {
"insured_person_relationship": "string",
"insurance_policy_type": "string",
"member_number": "string",
"group_number": "string",
"group_name": "string",
"effective_date": "string",
"termination_date": "string",
"requires_authorization": true,
"co_payment": "string",
"deductible": "string",
"plan_id": "string",
"payer": {
"id": "string",
"name": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state_code": "string",
"zip_code": "string",
"country_code": "string"
},
"phone": "string"
},
"insured": {
"first_name": "string",
"last_name": "string",
"date_of_birth": "string",
"ssn": "string",
"gender_code": "string",
"email": "string",
"addresses": [
{
"line1": "string",
"city": "string",
"state_code": "string",
"zip_code": "string",
"country_code": "string",
"is_primary": true
}
],
"phones": [
{
"phone_number": "string",
"phone_type_code": "string",
"extension": "string",
"is_primary": true
}
]
}
}
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | patient not found for current practice | | |
| |
| 422 | Payer can't be edited | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id_insurances)[/patients/{patient\_id}/insurances](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id_insurances)
- [Show Patient Insurances](https://developer.carecloud.com/static/swagger.html#!/Patients/get_patients_patient_id_insurances)
#### Implementation Notes
Show Patient Insurances
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
PatientInsuranceShow {
id (string),
name (string),
self\_pay (boolean),
default (boolean),
insurance\_policies (Array\[PatientInsurancePolicy\])
}
PatientInsurancePolicy {
id (integer),
policy\_priority (integer),
member\_number (string),
policy\_number (string),
effective\_from (string),
effective\_to (string),
co\_payment (string),
type (string),
insured (PatientInsured),
payer (PatientInsurancePayer)
}
PatientInsured {
first\_name (string),
last\_name (string),
middle\_initial (string),
date\_of\_birth (string),
gender (string),
relation\_to\_patient (string),
addresses (Array\[PatientInsuranceAddress\]),
phones (Array\[PatientInsurancePhone\])
}
PatientInsurancePayer {
id (integer),
name (string),
phones (Array\[PatientInsurancePhone\]),
address (PatientInsuranceAddress)
}
PatientInsuranceAddress {
line1 (string),
line2 (string),
line3 (string),
city (string),
state (integer),
zip (string),
county\_name (string),
country\_name (integer),
is\_primary (boolean),
latitude (float),
longitude (float)
}
PatientInsurancePhone {
phone\_number (string),
phone\_type (string),
phone\_ext (string),
is\_primary (string)
}
```json
{
"id": "string",
"name": "string",
"self_pay": true,
"default": true,
"insurance_policies": [\
{\
"id": 0,\
"policy_priority": 0,\
"member_number": "string",\
"policy_number": "string",\
"effective_from": "string",\
"effective_to": "string",\
"co_payment": "string",\
"type": "string",\
"insured": {\
"first_name": "string",\
"last_name": "string",\
"middle_initial": "string",\
"date_of_birth": "string",\
"gender": "string",\
"relation_to_patient": "string",\
"addresses": [\
{\
"line1": "string",\
"line2": "string",\
"line3": "string",\
"city": "string",\
"state": 0,\
"zip": "string",\
"county_name": "string",\
"country_name": 0,\
"is_primary": true,\
"latitude": 0,\
"longitude": 0\
}\
],\
"phones": [\
{\
"phone_number": "string",\
"phone_type": "string",\
"phone_ext": "string",\
"is_primary": "string"\
}\
]\
},\
"payer": {\
"id": 0,\
"name": "string",\
"phones": [\
{\
"phone_number": "string",\
"phone_type": "string",\
"phone_ext": "string",\
"is_primary": "string"\
}\
],\
"address": {\
"line1": "string",\
"line2": "string",\
"line3": "string",\
"city": "string",\
"state": 0,\
"zip": "string",\
"county_name": "string",\
"country_name": 0,\
"is_primary": true,\
"latitude": 0,\
"longitude": 0\
}\
}\
}\
]
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **GUID of the patient** | path | string |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | patient not found for current practice | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Patients/post_patients_patient_id_insurances)[/patients/{patient\_id}/insurances](https://developer.carecloud.com/static/swagger.html\#!/Patients/post_patients_patient_id_insurances)
- [Create Patient Insurance](https://developer.carecloud.com/static/swagger.html#!/Patients/post_patients_patient_id_insurances)
#### Implementation Notes
Create Patient Insurance
One Insurance Profile contains multiple Insurance Policies. There can be up to four Policies, prioritized from primary through quaternary.
For `responsible_party_relationship` and `insured_person_relationship`, the following Patient Relationship Types are supported:
```undefined
unknown
organ_donor
cadaver_donor
life_partner
nephew
significant_other
dependant_of_a_minor_dependant
ward
stepchild
handicapped_dependent
emancipated_minor
injured_plaintiff
child_where_insured_has_no_financial_responsibility
father
grandparent
self
attorney
other
domestic_partner
paternal_grandparent
maternal_grandparent
aunt_uncle
sibling
niece
foster_child
sponsored_dependent
child
grandchild
spouse
mother
foster_parent
employee
```
For `insurance_policy_type`, the following Insurance Types are available:
```undefined
choice_epo
capitation
open_access
attorney
auto_insurance
champus
flat_fee_arrangement
hmo
medicaid
medikids
medipass_or_psn
pos
workers_compensation
healthy_kids
ppo
exclusive_provider_organization_(epo)
blue_cross_blue_shield
medicare_hmo
medicare_supplement
commercial_insurance
other_federal_program
federal_employees_program
indemnity_insurance
medicare_ppo
medicaid_hmo
medicare_railroad
medicare_b
medicare_a
mutually_defined
champ_va
medicare_pos
medicaid_newborn
choice_plus
```
nThe `phone_type` field can be filled in with one of the following codes:
| code | description |
| --- | --- |
| B | Business | |
| M | Main | |
| F | Fax | |
| P | Pager | |
| C | Cell | |
| H | Home | |
The `country` field of an Address should using a [three-letter ISO3166 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
InsuranceProfile\_Response {
insurance\_profile (InsuranceProfile\_Response\_insurance\_profile)
}
InsuranceProfile\_Response\_insurance\_profile {
id (integer),
is\_default (boolean),
name (string)
}
```json
{
"insurance_profile": {
"id": 0,
"is_default": true,
"name": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **GUID of the patient** | path | string |
| body | Parameter content type:application/json | **Insurance Profile with Policies** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
InsuranceProfile\_Request {
insurance\_profile (InsuranceProfile\_Request\_insurance\_profile)
}
InsuranceProfile\_Request\_insurance\_profile {
responsible\_party\_relationship (string),
is\_default (boolean),
responsible\_party (InsuranceProfile\_Request\_insurance\_profile\_responsible\_party),
primary\_insurance\_policy (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy),
secondary\_insurance\_policy (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy),
tertiary\_insurance\_policy (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy),
quaternary\_insurance\_policy (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy)
}
InsuranceProfile\_Request\_insurance\_profile\_responsible\_party {
first\_name (string),
last\_name (string),
date\_of\_birth (string),
ssn (string),
gender (string),
email (string),
addresses (Array\[InsuranceProfile\_Request\_insurance\_profile\_responsible\_party\_addresses\]),
phones (Array\[InsuranceProfile\_Request\_insurance\_profile\_responsible\_party\_phones\])
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy {
insured\_person\_relationship (string),
insurance\_policy\_type (string),
member\_number (string),
group\_number (string),
group\_name (string, optional),
effective\_date (string),
termination\_date (string, optional),
requires\_authorization (boolean, optional),
co\_payment (string, optional),
deductible (string, optional),
plan\_id (string, optional),
payer (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_payer),
insured (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured)
}
InsuranceProfile\_Request\_insurance\_profile\_responsible\_party\_addresses {
line1 (string),
city (string),
state (string),
zip\_code (string),
country (string),
is\_primary (boolean)
}
InsuranceProfile\_Request\_insurance\_profile\_responsible\_party\_phones {
phone\_number (string),
phone\_type (string),
extension (string),
is\_primary (boolean)
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_payer {
id (string),
name (string),
address (InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_payer\_address),
phone (string)
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured {
first\_name (string),
last\_name (string),
date\_of\_birth (string),
ssn (string),
gender\_code (string),
email (string),
addresses (Array\[InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured\_addresses\]),
phones (Array\[InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured\_phones\])
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_payer\_address {
line1 (string),
line2 (string),
city (string),
state\_code (string),
zip\_code (string),
country\_code (string)
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured\_addresses {
line1 (string),
city (string),
state\_code (string),
zip\_code (string),
country\_code (string),
is\_primary (boolean)
}
InsuranceProfile\_Request\_insurance\_profile\_insurance\_policy\_insured\_phones {
phone\_number (string),
phone\_type\_code (string),
extension (string),
is\_primary (boolean)
}
```json
{
"insurance_profile": {
"responsible_party_relationship": "string",
"is_default": true,
"responsible_party": {
"first_name": "string",
"last_name": "string",
"date_of_birth": "string",
"ssn": "string",
"gender": "string",
"email": "string",
"addresses": [
{
"line1": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"country": "string",
"is_primary": true
}
],
"phones": [
{
"phone_number": "string",
"phone_type": "string",
"extension": "string",
"is_primary": true
}
]
},
"primary_insurance_policy": {
"insured_person_relationship": "string",
"insurance_policy_type": "string",
"member_number": "string",
"group_number": "string",
"group_name": "string",
"effective_date": "string",
"termination_date": "string",
"requires_authorization": true,
"co_payment": "string",
"deductible": "string",
"plan_id": "string",
"payer": {
"id": "string",
"name": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state_code": "string",
"zip_code": "string",
"country_code": "string"
},
"phone": "string"
},
"insured": {
"first_name": "string",
"last_name": "string",
"date_of_birth": "string",
"ssn": "string",
"gender_code": "string",
"email": "string",
"addresses": [
{
"line1": "string",
"city": "string",
"state_code": "string",
"zip_code": "string",
"country_code": "string",
"is_primary": true
}
],
"phones": [
{
"phone_number": "string",
"phone_type_code": "string",
"extension": "string",
"is_primary": true
}
]
}
},
"secondary_insurance_policy": {
"insured_person_relationship": "string",
"insurance_policy_type": "string",
"member_number": "string",
"group_number": "string",
"group_name": "string",
"effective_date": "string",
"termination_date": "string",
"requires_authorization": true,
"co_payment": "string",
"deductible": "string",
"plan_id": "string",
"payer": {
"id": "string",
"name": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state_code": "string",
"zip_code": "string",
"country_code": "string"
},
"phone": "string"
},
"insured": {
"first_name": "string",
"last_name": "string",
"date_of_birth": "string",
"ssn": "string",
"gender_code": "string",
"email": "string",
"addresses": [
{
"line1": "string",
"city": "string",
"state_code": "string",
"zip_code": "string",
"country_code": "string",
"is_primary": true
}
],
"phones": [
{
"phone_number": "string",
"phone_type_code": "string",
"extension": "string",
"is_primary": true
}
]
}
},
"tertiary_insurance_policy": {
"insured_person_relationship": "string",
"insurance_policy_type": "string",
"member_number": "string",
"group_number": "string",
"group_name": "string",
"effective_date": "string",
"termination_date": "string",
"requires_authorization": true,
"co_payment": "string",
"deductible": "string",
"plan_id": "string",
"payer": {
"id": "string",
"name": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state_code": "string",
"zip_code": "string",
"country_code": "string"
},
"phone": "string"
},
"insured": {
"first_name": "string",
"last_name": "string",
"date_of_birth": "string",
"ssn": "string",
"gender_code": "string",
"email": "string",
"addresses": [
{
"line1": "string",
"city": "string",
"state_code": "string",
"zip_code": "string",
"country_code": "string",
"is_primary": true
}
],
"phones": [
{
"phone_number": "string",
"phone_type_code": "string",
"extension": "string",
"is_primary": true
}
]
}
},
"quaternary_insurance_policy": {
"insured_person_relationship": "string",
"insurance_policy_type": "string",
"member_number": "string",
"group_number": "string",
"group_name": "string",
"effective_date": "string",
"termination_date": "string",
"requires_authorization": true,
"co_payment": "string",
"deductible": "string",
"plan_id": "string",
"payer": {
"id": "string",
"name": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state_code": "string",
"zip_code": "string",
"country_code": "string"
},
"phone": "string"
},
"insured": {
"first_name": "string",
"last_name": "string",
"date_of_birth": "string",
"ssn": "string",
"gender_code": "string",
"email": "string",
"addresses": [
{
"line1": "string",
"city": "string",
"state_code": "string",
"zip_code": "string",
"country_code": "string",
"is_primary": true
}
],
"phones": [
{
"phone_number": "string",
"phone_type_code": "string",
"extension": "string",
"is_primary": true
}
]
}
}
}
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | patient not found for current practice | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id_transactions)[/patients/{patient\_id}/transactions](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id_transactions)
- [List Patient Transactions](https://developer.carecloud.com/static/swagger.html#!/Patients/get_patients_patient_id_transactions)
#### Implementation Notes
List Transactions for a Patient
Filtering params are optional. Date filtering fields filter by posting\_date.
Without date filtering, the past 30 days worth of posted transactions for the Patient will be returned.
With just a start\_date, transactions posted 30 days from the start\_date will be returned.
The following transaction\_types exist:
```undefined
simple_charge_reversal
charge_reversal
returned_insurance_check_reversal
returned_patient_check_reversal
simple_charge
charge
returned_insurance_check
returned_patient_check
insurance_adjustment
insurance_adjustment_refund
insurance_adjustment_refund_reversal
insurance_adjustment_reversal
insurance_payment
insurance_payment_refund
insurance_payment_refund_reversal
insurance_payment_reversal
patient_adjustment
patient_adjustment_reversal
patient_payment
patient_payment_refund
patient_payment_refund_reversal
patient_payment_reversal
withhold
withhold_refund
withhold_refund_reversal
withhold_reversal
```
The following transaction\_statuses exist:
```undefined
posted
not_posted
closed
```
Results are paginated to 50 Transactions per page. The `page` parameter sets the page number to return, the default being `1`. Pagination state is indicated by the Link header, in accordance with [RFC5988](https://tools.ietf.org/html/rfc5988#section-5). The `Link` header contains URIs to the first, next, previous, and last pages in the result set. For an example see [Pagination](https://developer.carecloud.com/overview).
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
Transaction\_Response\
\
\]
Transaction\_Response {
id (integer),
amount (string),
balance (string),
unapplied\_credit (integer),
effective\_date (string, optional),
service\_date (string, optional),
posting\_date (string),
transaction\_type (string),
transaction\_status (string),
location\_id (integer),
provider\_id (integer),
procedure\_code (string, optional),
units (string),
diagnosis\_code(s) (string, optional),
description (string)
}
```json
[\
{\
"id": 0,\
"amount": "string",\
"balance": "string",\
"unapplied_credit": 0,\
"effective_date": "string",\
"service_date": "string",\
"posting_date": "string",\
"transaction_type": "string",\
"transaction_status": "string",\
"location_id": 0,\
"provider_id": 0,\
"procedure_code": "string",\
"units": "string",\
"diagnosis_code(s)": "string",\
"description": "string"\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **Patient ID** | path | string |
| start\_date | | Start Date | query | string |
| end\_date | | End Date | query | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id_notes)[/patients/{patient\_id}/notes](https://developer.carecloud.com/static/swagger.html\#!/Patients/get_patients_patient_id_notes)
- [List Patient Notes](https://developer.carecloud.com/static/swagger.html#!/Patients/get_patients_patient_id_notes)
#### Implementation Notes
List notes associated with a patient.
If there are note triggers then the note will pop-up when the specified screens, `actions`, are accessed in CareCloud.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
NoteLists\_Response {
notes (ListNote\_Response)
}
ListNote\_Response \[\
\
Note\_Response\
\
\]
Note\_Response {
id (integer),
text (string),
note\_trigger (notetrigger\_Response)
}
notetrigger\_Response {
actions (Array\[trigger\_actions\]),
expires\_at (string)
}
trigger\_actions {
name (string),
code (string)
}
```json
{
"notes": [\
{\
"id": 0,\
"text": "string",\
"note_trigger": {\
"actions": [\
{\
"name": "string",\
"code": "string"\
}\
],\
"expires_at": "string"\
}\
}\
]
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **GUID of the patient** | path | string |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | patient not found for current practice | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Patients/post_patients_patient_id_notes)[/patients/{patient\_id}/notes](https://developer.carecloud.com/static/swagger.html\#!/Patients/post_patients_patient_id_notes)
- [Create a Patient Note](https://developer.carecloud.com/static/swagger.html#!/Patients/post_patients_patient_id_notes)
#### Implementation Notes
Create a Note associated with a patient.
If `actions` are passed in the request then the note pops up when the specified screens are accessed in CareCloud. `actions` accepts an array of codes.
| code | description |
| --- | --- |
| APP | Open or Check in an Appointment | |
| PAT | Open a Patient | |
| COL | Open a Collection Incident | |
| CHG | Open a Charge Entry | |
| REM | Entering a Remitted Payment | |
| CHT | Open a Patient Chart | |
`expires_at` must be in the date format, `YYYY-MM-DD`. If `expires_at = nil` then expiration date of the action(s) would be never.
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Note\_Response {
id (integer),
text (string),
note\_trigger (notetrigger\_Response)
}
notetrigger\_Response {
actions (Array\[trigger\_actions\]),
expires\_at (string)
}
trigger\_actions {
name (string),
code (string)
}
```json
{
"id": 0,
"text": "string",
"note_trigger": {
"actions": [\
{\
"name": "string",\
"code": "string"\
}\
],
"expires_at": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **GUID of the patient** | path | string |
| body | Parameter content type:application/json | **note payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Note\_Request {
text (string),
note\_trigger (notetrigger\_Request, optional)
}
notetrigger\_Request {
actions (Array\[string\]),
expires\_at (string)
}
```json
{
"text": "string",
"note_trigger": {
"actions": [
"string"
],
"expires_at": "string"
}
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [put](https://developer.carecloud.com/static/swagger.html\#!/Patients/put_patients_patient_id_notes_note_id)[/patients/{patient\_id}/notes/{note\_id}](https://developer.carecloud.com/static/swagger.html\#!/Patients/put_patients_patient_id_notes_note_id)
- [Update a Patient Note](https://developer.carecloud.com/static/swagger.html#!/Patients/put_patients_patient_id_notes_note_id)
#### Implementation Notes
Update a Patient Note
If `actions` are included in the request then the note pops up when the specified screens are accessed in CareCloud. `actions` accepts an array of codes.
| code | description |
| --- | --- |
| APP | Open or Check in an Appointment | |
| PAT | Open a Patient | |
| COL | Open a Collection Incident | |
| CHG | Open a Charge Entry | |
| REM | Entering a Remitted Payment | |
| CHT | Open a Patient Chart | |
`expires_at` must be in the date format, `YYYY-MM-DD`. If `expires_at = nil` then expiration date of the action(s) would be never.
#### Response Class (Status 204)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Note\_Response {
id (integer),
text (string),
note\_trigger (notetrigger\_Response)
}
notetrigger\_Response {
actions (Array\[trigger\_actions\]),
expires\_at (string)
}
trigger\_actions {
name (string),
code (string)
}
```json
{
"id": 0,
"text": "string",
"note_trigger": {
"actions": [\
{\
"name": "string",\
"code": "string"\
}\
],
"expires_at": "string"
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| patient\_id | | **GUID of the patient** | path | string |
| note\_id | | **Note id** | path | string |
| body | Parameter content type:application/json | **note payload** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Note\_Request {
text (string),
note\_trigger (notetrigger\_Request, optional)
}
notetrigger\_Request {
actions (Array\[string\]),
expires\_at (string)
}
```json
{
"text": "string",
"note_trigger": {
"actions": [
"string"
],
"expires_at": "string"
}
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 404 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Employers](https://developer.carecloud.com/static/swagger.html\#!/Employers)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Employers)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Employers/get_employers)[/employers](https://developer.carecloud.com/static/swagger.html\#!/Employers/get_employers)
- [List Employers](https://developer.carecloud.com/static/swagger.html#!/Employers/get_employers)
#### Implementation Notes
List Employers in CareCloud’s Library.
Results are paginated to 50 Employers per page. The `page` parameter sets the page number to return. The default page is `1`. Pagination state is indicated by the Link header, in accordance with [RFC5988](https://tools.ietf.org/html/rfc5988#section-5). The `Link` header contains URIs to the first, next, previous, and last pages in the result set. For an example see [Pagination](https://developer.carecloud.com/overview).
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ListEmployers\_Response {
employers (ListEmployer\_Response)
}
ListEmployer\_Response {
employer (Inline Model 1, optional)
}
Inline Model 1 {
id (integer, optional),
name (string, optional),
phone (EmployerPhone, optional),
address (EmployerAddress, optional)
}
EmployerPhone {
id (integer, optional),
phone\_number (string),
phone\_type\_code (integer, optional),
extension (string)
}
EmployerAddress {
id (integer),
line1 (string),
line2 (string),
city (string),
state (string),
state\_code (string, optional),
zip\_code (string),
country\_name (string)
}
```json
{
"employers": {
"employer": {
"id": 0,
"name": "string",
"phone": {
"id": 0,
"phone_number": "string",
"phone_type_code": 0,
"extension": "string"
},
"address": {
"id": 0,
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"state_code": "string",
"zip_code": "string",
"country_name": "string"
}
}
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| id | | employer id | query | integer |
| page | | page number | query | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Employers/post_employers)[/employers](https://developer.carecloud.com/static/swagger.html\#!/Employers/post_employers)
- [Create Employer](https://developer.carecloud.com/static/swagger.html#!/Employers/post_employers)
#### Implementation Notes
Create an Employer
| parameter | options |
| --- | --- |
| state | Uses FIPS 2 letter state abbreviations ( [FIPS code listing](https://www.mcc.co.mercer.pa.us/dps/state_fips_code_listing.htm)) | |
| country\_name | Uses ISO Alpha-3 letter abbreviations ( [ISO Alpha-3 code listing](http://www.nationsonline.org/oneworld/country_code_list.htm)) | |
| phone\_type\_code | "B": Business; "M": Main; "F": Fax; "P": Pager; "C": Cell; "H": Home |
#### Response Class (Status 201)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateEmployer\_Response {
employer\_id (string, optional)
}
```json
{
"employer_id": "string"
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| employer | Parameter content type:application/json | **employer information** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
CreateEmployer\_Request {
employer (CreateEmployer\_Request\_employer)
}
CreateEmployer\_Request\_employer {
name (string),
phone (CreateEmployerPhone, optional),
address (CreateEmployerAddress, optional)
}
CreateEmployerPhone {
phone\_number (string),
phone\_type\_code (integer, optional),
extension (string)
}
CreateEmployerAddress {
line1 (string),
line2 (string),
city (string),
state (string),
zip\_code (string),
country\_name (string)
}
```json
{
"employer": {
"name": "string",
"phone": {
"phone_number": "string",
"phone_type_code": 0,
"extension": "string"
},
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"country_name": "string"
}
}
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 422 | validation error | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Employers/post_employers_search)[/employers/search](https://developer.carecloud.com/static/swagger.html\#!/Employers/post_employers_search)
- [Search Employers](https://developer.carecloud.com/static/swagger.html#!/Employers/post_employers_search)
#### Implementation Notes
Search for an employer in CareCloud’s Library.
Results will have matching term(s) found within the Employer’s name or address.The first 100 results are returned.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ListEmployers\_Response {
employers (ListEmployer\_Response)
}
ListEmployer\_Response {
employer (Inline Model 1, optional)
}
Inline Model 1 {
id (integer, optional),
name (string, optional),
phone (EmployerPhone, optional),
address (EmployerAddress, optional)
}
EmployerPhone {
id (integer, optional),
phone\_number (string),
phone\_type\_code (integer, optional),
extension (string)
}
EmployerAddress {
id (integer),
line1 (string),
line2 (string),
city (string),
state (string),
state\_code (string, optional),
zip\_code (string),
country\_name (string)
}
```json
{
"employers": {
"employer": {
"id": 0,
"name": "string",
"phone": {
"id": 0,
"phone_number": "string",
"phone_type_code": 0,
"extension": "string"
},
"address": {
"id": 0,
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"state_code": "string",
"zip_code": "string",
"country_name": "string"
}
}
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| body | Parameter content type:application/json | **Employer Search details** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
EmployerSearch\_Request {
terms (Array\[string\])
}
```json
{
"terms": [
"string"
]
}
```
Click to set as parameter value |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Document Sources](https://developer.carecloud.com/static/swagger.html\#!/Document_Sources)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Document_Sources)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Document_Sources/get_document_sources)[/document\_sources](https://developer.carecloud.com/static/swagger.html\#!/Document_Sources/get_document_sources)
- [List Document Sources](https://developer.carecloud.com/static/swagger.html#!/Document_Sources/get_document_sources)
#### Implementation Notes
List all Document Sources
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ListDocumentSources {
document\_sources (Array\[DocumentSource\_Response\])
}
DocumentSource\_Response {
id (integer, optional),
name (string, optional),
code (string, optional),
description (string, optional),
status (string, optional),
sort\_code (integer, optional),
created\_at (string, optional),
updated\_at (string, optional),
is\_custom (boolean, optional)
}
```json
{
"document_sources": [\
{\
"id": 0,\
"name": "string",\
"code": "string",\
"description": "string",\
"status": "string",\
"sort_code": 0,\
"created_at": "string",\
"updated_at": "string",\
"is_custom": true\
}\
]
}
```
Response Content Typeapplication/json
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Payers](https://developer.carecloud.com/static/swagger.html\#!/Payers)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Payers)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Payers/post_payers_search)[/payers/search](https://developer.carecloud.com/static/swagger.html\#!/Payers/post_payers_search)
- [Search Payers](https://developer.carecloud.com/static/swagger.html#!/Payers/post_payers_search)
#### Implementation Notes
Search for a payer in CareCloud’s Library.
Results will have matching term(s) found within the Payer’s name or address.The first 100 results are returned.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ListPayers\_Response {
payers (ListPayer\_Response)
}
ListPayer\_Response \[\
\
insurance\_policy\_payer\_with\_plan\
\
\]
insurance\_policy\_payer\_with\_plan {
payer (Inline Model 1, optional)
}
Inline Model 1 {
id (integer, optional),
name (string, optional),
sender\_number (string, optional),
addresses (Array\[PayerInsuranceAddress\], optional),
phones (Array\[PayerInsurancePhone\], optional),
plans (PayerPlanList\_Response, optional)
}
PayerInsuranceAddress {
line1 (string),
line2 (string),
line3 (string),
city (string),
state (string),
zip (string),
country\_name (string)
}
PayerInsurancePhone {
phone\_number (string),
phone\_type (string),
phone\_ext (string)
}
PayerPlanList\_Response \[\
\
PayerPlan\_Response\
\
\]
PayerPlan\_Response {
id (integer, optional),
name (string, optional)
}
```json
{
"payers": [\
{\
"payer": {\
"id": 0,\
"name": "string",\
"sender_number": "string",\
"addresses": [\
{\
"line1": "string",\
"line2": "string",\
"line3": "string",\
"city": "string",\
"state": "string",\
"zip": "string",\
"country_name": "string"\
}\
],\
"phones": [\
{\
"phone_number": "string",\
"phone_type": "string",\
"phone_ext": "string"\
}\
],\
"plans": [\
{\
"id": 0,\
"name": "string"\
}\
]\
}\
}\
]
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| body | Parameter content type:application/json | **Payer Search details** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
PayerSearch\_Request {
terms (Array\[string\])
}
```json
{
"terms": [
"string"
]
}
```
Click to set as parameter value |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Payers/get_payers)[/payers](https://developer.carecloud.com/static/swagger.html\#!/Payers/get_payers)
- [List Payers](https://developer.carecloud.com/static/swagger.html#!/Payers/get_payers)
#### Implementation Notes
List Payers in CareCloud’s Library.
Results are paginated to 50 Payers per page. The `page` parameter sets the page number to return. The default page is `1`. Pagination state is indicated by the Link header, in accordance with [RFC5988](https://tools.ietf.org/html/rfc5988#section-5). The `Link` header contains URIs to the first, next, previous, and last pages in the result set. For an example see [Pagination](https://developer.carecloud.com/overview).
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ListPayers\_Response {
payers (ListPayer\_Response)
}
ListPayer\_Response \[\
\
insurance\_policy\_payer\_with\_plan\
\
\]
insurance\_policy\_payer\_with\_plan {
payer (Inline Model 1, optional)
}
Inline Model 1 {
id (integer, optional),
name (string, optional),
sender\_number (string, optional),
addresses (Array\[PayerInsuranceAddress\], optional),
phones (Array\[PayerInsurancePhone\], optional),
plans (PayerPlanList\_Response, optional)
}
PayerInsuranceAddress {
line1 (string),
line2 (string),
line3 (string),
city (string),
state (string),
zip (string),
country\_name (string)
}
PayerInsurancePhone {
phone\_number (string),
phone\_type (string),
phone\_ext (string)
}
PayerPlanList\_Response \[\
\
PayerPlan\_Response\
\
\]
PayerPlan\_Response {
id (integer, optional),
name (string, optional)
}
```json
{
"payers": [\
{\
"payer": {\
"id": 0,\
"name": "string",\
"sender_number": "string",\
"addresses": [\
{\
"line1": "string",\
"line2": "string",\
"line3": "string",\
"city": "string",\
"state": "string",\
"zip": "string",\
"country_name": "string"\
}\
],\
"phones": [\
{\
"phone_number": "string",\
"phone_type": "string",\
"phone_ext": "string"\
}\
],\
"plans": [\
{\
"id": 0,\
"name": "string"\
}\
]\
}\
}\
]
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| page | | page number | query | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Physicians](https://developer.carecloud.com/static/swagger.html\#!/Physicians)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Physicians)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Physicians/get_physicians_npi)[/physicians/{npi}](https://developer.carecloud.com/static/swagger.html\#!/Physicians/get_physicians_npi)
- [Show Physician](https://developer.carecloud.com/static/swagger.html#!/Physicians/get_physicians_npi)
#### Implementation Notes
Show physician based on their National Provider Identifier (NPI). If the physician is an organization,
then the `organization` object will be returned, otherwise it will be null.
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Physician {
physician (PhysicianShow)
}
PhysicianShow {
npi (string),
prefix (string),
first\_name (string),
middle\_initial (string),
last\_name (string),
suffix (string),
email (string),
phone\_number (string),
gender\_code (string),
deactivation\_date (string),
organization (Organization),
specialties (Array\[Specialty\])
}
Organization {
name (string),
official\_email (string),
official\_first\_name (string),
official\_last\_name (string),
official\_middle\_initial (string),
official\_phone (string),
official\_prefix (string),
official\_suffix (string),
official\_title (string)
}
Specialty {
name (string),
taxonomy\_code (string)
}
```json
{
"physician": {
"npi": "string",
"prefix": "string",
"first_name": "string",
"middle_initial": "string",
"last_name": "string",
"suffix": "string",
"email": "string",
"phone_number": "string",
"gender_code": "string",
"deactivation_date": "string",
"organization": {
"name": "string",
"official_email": "string",
"official_first_name": "string",
"official_last_name": "string",
"official_middle_initial": "string",
"official_phone": "string",
"official_prefix": "string",
"official_suffix": "string",
"official_title": "string"
},
"specialties": [\
{\
"name": "string",\
"taxonomy_code": "string"\
}\
]
}
}
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| npi | | **National Provider Identifier (NPI)** | path | string |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Providers](https://developer.carecloud.com/static/swagger.html\#!/Providers)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Providers)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Providers/get_providers)[/providers](https://developer.carecloud.com/static/swagger.html\#!/Providers/get_providers)
- [List Providers](https://developer.carecloud.com/static/swagger.html#!/Providers/get_providers)
#### Implementation Notes
List Providers for a Practice
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
Inline Model \[\
\
Provider\
\
\]
Provider {
id (string),
npi (string),
name (string),
email (string),
phone\_number (string),
specialty (Specialty)
}
Specialty {
name (string),
taxonomy\_code (string)
}
```json
[\
{\
"id": "string",\
"npi": "string",\
"name": "string",\
"email": "string",\
"phone_number": "string",\
"specialty": {\
"name": "string",\
"taxonomy_code": "string"\
}\
}\
]
```
Response Content Typeapplication/json
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ## [Appointment Waitlist](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Waitlist)
- [Show/Hide](https://developer.carecloud.com/static/swagger.html#!/Appointment_Waitlist)
- [List Operations](https://developer.carecloud.com/static/swagger.html#)
- [Expand Operations](https://developer.carecloud.com/static/swagger.html#)
- ### [get](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Waitlist/get_waitlist)[/waitlist](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Waitlist/get_waitlist)
- [Read Waitlist](https://developer.carecloud.com/static/swagger.html#!/Appointment_Waitlist/get_waitlist)
#### Implementation Notes
Show all waitlist requests for a cancelled appointment's time, location, and resource
#### Response Class (Status 200)
- [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
ListAppointmentWailist\_Response \[\
\
Waitlist\_Response\
\
\]
Waitlist\_Response {
id (integer, optional),
business\_entity\_id (string, optional),
appointment\_id (integer, optional),
appointment\_external\_id (string, optional),
priority (integer, optional),
created\_at (string, optional),
updated\_at (string, optional),
appointment\_request (Inline Model 1, optional)
}
Inline Model 1 {
visit\_reason\_id (integer, optional),
show\_alert (integer, optional),
calendars (Array\[Inline Model 2\], optional),
weekday (Inline Model 3, optional),
part\_of\_day (Inline Model 4, optional),
appointment (Inline Model 5, optional)
}
Inline Model 2 {
resource\_id (integer, optional),
location\_id (integer, optional)
}
Inline Model 3 {
monday (boolean, optional),
tuesday (boolean, optional),
wednesday (boolean, optional),
thursday (boolean, optional),
friday (boolean, optional),
saturday (boolean, optional),
sunday (boolean, optional)
}
Inline Model 4 {
morning (boolean, optional),
afternoon (boolean, optional)
}
Inline Model 5 {
id (integer, optional),
external\_id (object, optional),
start\_time (string, optional),
end\_time (string, optional),
nature\_of\_visit\_id (integer, optional),
patient\_id (string, optional),
first\_name (string, optional),
last\_name (string, optional),
date\_of\_birth\_string (string, optional),
primary\_payer\_id (string, optional)
}
```json
[\
{\
"id": 0,\
"business_entity_id": "string",\
"appointment_id": 0,\
"appointment_external_id": "string",\
"priority": 0,\
"created_at": "string",\
"updated_at": "string",\
"appointment_request": {\
"visit_reason_id": 0,\
"show_alert": 0,\
"calendars": [\
{\
"resource_id": 0,\
"location_id": 0\
}\
],\
"weekday": {\
"monday": true,\
"tuesday": true,\
"wednesday": true,\
"thursday": true,\
"friday": true,\
"saturday": true,\
"sunday": true\
},\
"part_of_day": {\
"morning": true,\
"afternoon": true\
},\
"appointment": {\
"id": 0,\
"external_id": {},\
"start_time": "string",\
"end_time": "string",\
"nature_of_visit_id": 0,\
"patient_id": "string",\
"first_name": "string",\
"last_name": "string",\
"date_of_birth_string": "string",\
"primary_payer_id": "string"\
}\
}\
}\
]
```
Response Content Typeapplication/json
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| appointment\_id | | **cancelled appointment's id** | query | string |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 423 | Appointment slot has a hold placed, waitlist is locked | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
- ### [post](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Waitlist/post_waitlist_book)[/waitlist/book](https://developer.carecloud.com/static/swagger.html\#!/Appointment_Waitlist/post_waitlist_book)
- [Book an appointment from the waitlist](https://developer.carecloud.com/static/swagger.html#!/Appointment_Waitlist/post_waitlist_book)
#### Implementation Notes
Schedule an appointment from the waitlist on a cancelled appointment's slot
#### Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
| --- | --- | --- | --- | --- |
| body | Parameter content type:application/json | **cancelled appointment ID and waitlist request ID** | body | - [Model](https://developer.carecloud.com/static/swagger.html#)
- [Model Schema](https://developer.carecloud.com/static/swagger.html#)
WaitlistBookPayload {
appointment\_id (string),
waitlist\_request\_id (string)
}
```json
{
"appointment_id": "string",
"waitlist_request_id": "string"
}
```
Click to set as parameter value |
#### Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
| --- | --- | --- | --- |
| 200 | Appointment successfully booked | | |
| |
[Hide Response](https://developer.carecloud.com/static/swagger.html#)
#### Request URL
#### Response Body
#### Response Code
#### Response Headers
# Demo Token
You may request a demo token here. With this token, you can make calls against a test Practice, on behalf of the CareCloud Interactive API Docs application.
`{message: "Response with access token goes here."}`
[Submit](https://developer.carecloud.com/static/swagger.html#)
[Use This Token](https://developer.carecloud.com/static/swagger.html#)