Docsink REST endpoints

DocsInk mobile apps and 3rd party integration

Contact

Jake Ceballos
jceballos@docsink.com
Visit us for more information

Servers

https://api.docsink.com/api

Operations

AppointmentTypes

Get all Appointment Types

Get all Appointment Types.

get /appointments/types

Example Request

get /appointments/types HTTP/1.1
Content-Type: application/json; charset=utf-8

Store new Appointment Type

Store new Appointment Type.

post /appointments/types

Example Request

post /appointments/types HTTP/1.1
Content-Type: application/json; charset=utf-8

update a Appointment Type

put /appointments/types/{uuid}

Example Request

put /appointments/types/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Delete an appointment type

Remove appointment type. Note: Appointment type must not be tied to any existing appointments.

delete /appointments/types/{uuid}

Parameter Name	Description	Location	Required	Data Type
uuid	Appointment type identifier	query	true	number

Example Request

delete /appointments/types/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get appointment type

Retrieve appointment type by uuid identifier

get /appointments/types/{uuid}

Parameter Name	Description	Location	Required	Data Type
uuid	Appointment type identifier	query	true	number

Example Request

get /appointments/types/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Appointments

Get Appointment

Get Appointment.

get /appointments/{uuid}

Example Request

get /appointments/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Delete Appointment

Delete Appointment.

delete /appointments/{uuid}

Example Request

delete /appointments/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Save Appointment

Update Appointment.

post /appointments/{uuid}

Request Body: Appointments.Update_Appointment

Example Request

post /appointments/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "appointment_type_id": "1786",
  "patient_id": "4246",
  "appointment_date": "timestamp",
  "appointment_timezone": "string",
  "office_id": "2440",
  "location_id": "6345",
  "waiting_room_id": "7209",
  "type": 424,
  "office": 465,
  "location": 251,
  "user[]": 405
}

Get all Appointments

Get all Appointments.

get /appointments/all

Parameter Name	Description	Location	Required	Data Type
user_id	User ID(uuid)(OPTIONAL, Defaults to All)	query	true	integer
min_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
max_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
type	type_id (uuid) (OPTIONAL)	query	true	number
office	office_id (uuid) (OPTIONAL)	query	true	number
location	location_id (uuid) (OPTIONAL)	query	true	number
user[]	user_id (uuid) (array) (OPTIONAL)	query	true	number

Example Request

get /appointments/all HTTP/1.1
Content-Type: application/json; charset=utf-8

Get My Appointments by status

Get My Appointments by status.

get /appointments/status

Parameter Name	Description	Location	Required	Data Type
user_id	user uuid	query	true	integer
status	Status to search for(OPTIONAL, Defaults to Yes)	query	true	string
min_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
max_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string

Example Request

get /appointments/status HTTP/1.1
Content-Type: application/json; charset=utf-8

Get % of confirmed Appointments

Get % of confirmed Appointments for Org

get /appointments/percentage

Parameter Name	Description	Location	Required	Data Type
show_on_tasks	(1 for true, 0 for no, OPTIONAL)	query	true	boolean
min_appointment_date	(ex. 2018-10-01T01:02:00, OPTIONAL)	query	true	string
max_appointment_date	(ex. 2018-10-01T01:02:00, OPTIONAL)	query	true	string
type	type_id (uuid) (OPTIONAL)	query	true	number
office	office_id (uuid) (OPTIONAL)	query	true	number
location	location_id (uuid) (OPTIONAL)	query	true	number
user[]	user_id (uuid) (array) (OPTIONAL)	query	true	number

Example Request

get /appointments/percentage HTTP/1.1
Content-Type: application/json; charset=utf-8

Get status of all Appointments

Get status of all Appointments.

get /appointments/status/all

Parameter Name	Description	Location	Required	Data Type
user_id	User ID(uuid)(OPTIONAL, Defaults to All)	query	true	integer
min_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
max_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
type	type_id (uuid) (OPTIONAL)	query	true	number
office	office_id (uuid) (OPTIONAL)	query	true	number
location	location_id (uuid) (OPTIONAL)	query	true	number
user[]	user_id (uuid) (array) (OPTIONAL)	query	true	number

Example Request

get /appointments/status/all HTTP/1.1
Content-Type: application/json; charset=utf-8

Create Appointment

Create Appointment.

post /appointments/

Request Body: Appointments.Create_Appointment

Example Request

post /appointments/ HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "appointment_type_id": "6623",
  "patient_id": "3949",
  "office_id": "8054",
  "location_id": "8319",
  "appointment_date": "timestamp",
  "appointment_timezone": "string",
  "waiting_room_id": "9286"
}

Get list of timezones

get /appointments/timezones

Example Request

get /appointments/timezones HTTP/1.1
Content-Type: application/json; charset=utf-8

Get My Appointments

Get my Appointments.

get /appointments

Parameter Name	Description	Location	Required	Data Type
min_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
max_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
type	type_id (uuid) (OPTIONAL)	query	true	number
office	office_id (uuid) (OPTIONAL)	query	true	number
location	location_id (uuid) (OPTIONAL)	query	true	number
user[]	user_id of provider (uuid) (array) (OPTIONAL)	query	true	number

Example Request

get /appointments HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all Patient Appointments

Get all Patient Appointments.

get /appointments/patient/{uuid}

Parameter Name	Description	Location	Required	Data Type
type	type_id (uuid) (OPTIONAL)	query	true	number
office	office_id (uuid) (OPTIONAL)	query	true	number
location	location_id (uuid) (OPTIONAL)	query	true	number
user[]	user_id (uuid) (array) (OPTIONAL)	query	true	number

Example Request

get /appointments/patient/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Search Patient Appointments

Search Patient Appointments.

get /appointments/search

Parameter Name	Description	Location	Required	Data Type
show_on_tasks	(1 for true, 0 for no, OPTIONAL)	query	true	boolean
min_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
max_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
type	type_id (uuid) (OPTIONAL)	query	true	number
office	office_id (uuid) (OPTIONAL)	query	true	number
location	location_id (uuid) (OPTIONAL)	query	true	number
user[]	user_id (uuid) (array) (OPTIONAL)	query	true	number

Example Request

get /appointments/search HTTP/1.1
Content-Type: application/json; charset=utf-8

Send Appointment SMS

post /appointments/{uuid}/send-sms

Request Body: Appointments.Send_Appointment_SMS

Example Request

post /appointments/{uuid}/send-sms HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "template_id": "5345",
  "message": "string",
  "review_user_id": "9145"
}

Attachment

Get Attachment

get /attachment/{attachment}/body/{filename}

Example Request

get /attachment/{attachment}/body/{filename} HTTP/1.1
Content-Type: application/json; charset=utf-8

Upload Attachment

post /attachment

Request Body: Attachment.Upload_Image

Example Request

post /attachment HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "file": "file"
}

Authorization

Get client information

Get user details..

get /client

Example Request

get /client HTTP/1.1
Content-Type: application/json; charset=utf-8

Login user

Generate a new access token for the user.

post /login

Request Body: Authorization.LoginUser

Example Request

post /login HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "email": "string",
  "password": "string"
}

Logout user

Logout the user and destroy the access token.

post /logout

Example Request

post /logout HTTP/1.1
Content-Type: application/json; charset=utf-8

Refresh user token

Refresh Access token for the user.

post /refresh

Request Body: Authorization.RefreshUserToken

Example Request

post /refresh HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "token": "string"
}

Get user information

Get user details..

get /user

Example Request

get /user HTTP/1.1
Content-Type: application/json; charset=utf-8

Call_Groups

Get Available Numbers

Get list of available numbers.

get /available-numbers

Parameter Name	Description	Location	Required	Data Type
areaCode	Area Code (optional defults to 910).	query	true	number
limit	Limit (optional defults to 10).	query	true	number
contains	Contains (optional Valid characters are , 0-9, a-z, and A-Z. The character matches any single digit).	query	true	string

Example Request

get /available-numbers HTTP/1.1
Content-Type: application/json; charset=utf-8

Purchase Available Number

Purchase Available Number.

post /available-numbers

Request Body: Call_Groups.Purchase_Available_Number

Example Request

post /available-numbers HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "number": 785,
  "type": "string",
  "chat_id": "6047"
}

Get Chat Call Group Data

Get Chat Call Group Data.

get /chats/{chat_id}/call-group-data

Example Request

get /chats/{chat_id}/call-group-data HTTP/1.1
Content-Type: application/json; charset=utf-8

Get Incomming call logs.

Get logs.

get /incomming-call-log

Parameter Name	Description	Location	Required	Data Type
number	Phone Number (10 digit)	query	true	number
page	page (optional)	query	true	number
limit	Limit (optional)	query	true	number
startTimeBefore	Area Code (optional ex. 2019-7-11).	query	true	string
startTimeAfter	Limit (optional ex. 2019-7-11).	query	true	string

Example Request

get /incomming-call-log HTTP/1.1
Content-Type: application/json; charset=utf-8

CannedReplies

Create Canned Reply

Create canned reply.

post /canned-replies

Request Body: CannedReplies.CreateCannedReply

Example Request

post /canned-replies HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "message": "string"
}

Canned_Reply

Show Canned Reply

Get Canned Reply.

get /canned-replies/{id}

Example Request

get /canned-replies/{id} HTTP/1.1
Content-Type: application/json; charset=utf-8

CheckIns

Create and send Check-In

Create and send check-in {{url}} {{first name}} {{last name}} {{org name}} {{org phone number}} Example: {{first name}} {{last name}}, this is a check in from {{org name}} {{url}}

post /checkin/send

Request Body: CheckIns.CreateAndSendChekin

Example Request

post /checkin/send HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "message": "string",
  "sms_email": "string",
  "recipient_id": "1034",
  "survey_type_id": "8734"
}

Create Scheduled Check-In

Create check-in.

post /scheduled-checkins

Request Body: CheckIns.CreateChekin

Example Request

post /scheduled-checkins HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "name": "string",
  "schedule_time": "string",
  "schedule_period": "string",
  "surveys": "array"
}

Show Check-In

Show Check-In.

get /scheduled-checkins/{checkin}

Example Request

get /scheduled-checkins/{checkin} HTTP/1.1
Content-Type: application/json; charset=utf-8

ContactContactTags

DELETE

delete /contact-contact-tags/<uuid>

Example Request

delete /contact-contact-tags/<uuid> HTTP/1.1
Content-Type: application/json; charset=utf-8

POST

post /contact-contact-tags/<uuid>

Request Body: ContactContactTags.PostContactContactTag

Example Request

post /contact-contact-tags/<uuid> HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "contact_uuid": "7770",
  "contact_tag_uuid": "9145"
}

GET

get /contact-contact-tags

Example Request

get /contact-contact-tags HTTP/1.1
Content-Type: application/json; charset=utf-8

Contact

Show Contact

Get Contact.

get /contacts/{id}

Example Request

get /contacts/{id} HTTP/1.1
Content-Type: application/json; charset=utf-8

ContactTags

DELETE

delete /contact-tags/<uuid>

Example Request

delete /contact-tags/<uuid> HTTP/1.1
Content-Type: application/json; charset=utf-8

PUT

put /contact-tags/<uuid>

Request Body: ContactTags.PutContactTag

Example Request

put /contact-tags/<uuid> HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "name": "string",
  "color": "string"
}

GET

get /contact-tags

Example Request

get /contact-tags HTTP/1.1
Content-Type: application/json; charset=utf-8

POST

post /contact-tags

Request Body: ContactTags.PostContactTag

Example Request

post /contact-tags HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "name": "string",
  "color": "string"
}

Contacts

Get all Appointments

Get all contacts.

get /contacts

Example Request

get /contacts HTTP/1.1
Content-Type: application/json; charset=utf-8

ExternalMessages

Create External Message

Create external message.

post /external-messages

Request Body: ExternalMessages.CreateExternalMessage

Example Request

post /external-messages HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "message": "string",
  "sent_to": "string",
  "Contact": 957,
  "receiver_first_name": "string",
  "receiver_last_name": "string",
  "expires": "string",
  "total_views": 853,
  "total_downloads": 658,
  "extra_auth": 171,
  "subject": "string",
  "display_credentials": 709,
  "attachments": "array"
}

Show External Message

Show External Message.

get /external-messages/{external_message}

Example Request

get /external-messages/{external_message} HTTP/1.1
Content-Type: application/json; charset=utf-8

FaxNumber

Delete FaxNumber

Delete FaxNumber.

delete /fax-numbers/{uuid}

Example Request

delete /fax-numbers/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all Chat_id FaxNumber

Get all Chat_id FaxNumber.

get /fax-numbers/chat/{chat_id}

Example Request

get /fax-numbers/chat/{chat_id} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all FaxNumber

Get all FaxNumber.

get /fax-numbers

Example Request

get /fax-numbers HTTP/1.1
Content-Type: application/json; charset=utf-8

Save FaxNumber

Save FaxNumber.

post /fax-numbers

Request Body: FaxNumber.Save_FaxNumber

Example Request

post /fax-numbers HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "number": 871,
  "chat_id": "3523"
}

Meet

Get a new meet session

get /meet-session

Example Request

get /meet-session HTTP/1.1
Content-Type: application/json; charset=utf-8

Organiztations_Group

Get a single organization

Display a single organization.

get /organizations/{organization}

Example Request

get /organizations/{organization} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all Organizations

Get all Organizations..

get /organizations

Example Request

get /organizations HTTP/1.1
Content-Type: application/json; charset=utf-8

Patient

Get all patients

Get all Patients

get /patients

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /patients HTTP/1.1
Content-Type: application/json; charset=utf-8

Get a single patient

Get a particular patient

get /patients/uuid

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /patients/uuid HTTP/1.1
Content-Type: application/json; charset=utf-8

Get telehealth visits

get /telehealth-visits/{uuid}

Example Request

get /telehealth-visits/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all telehealth visits

get /patients/{uuid}/telehealth-visits

Example Request

get /patients/{uuid}/telehealth-visits HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all telehealth and waiting room visits

Get all telehealth visits

get /patients/{uuid}/telehealth-and-waiting-room-visits

Example Request

get /patients/{uuid}/telehealth-and-waiting-room-visits HTTP/1.1
Content-Type: application/json; charset=utf-8

Get waiting room visit

get /waiting-room-visits/{UUID}

Example Request

get /waiting-room-visits/{UUID} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get waiting room visits

get /patients/{UUID}/waiting-room-visits

Example Request

get /patients/{UUID}/waiting-room-visits HTTP/1.1
Content-Type: application/json; charset=utf-8

Providers

Get Provider by NPI

Get Provider by NPI.

get /providers/npi/{npi}

Example Request

get /providers/npi/{npi} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get a single Provider

Display a single provider.

get /providers/{provider}

Example Request

get /providers/{provider} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get Provider List

Display List of Providers.

get /providers

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /providers HTTP/1.1
Content-Type: application/json; charset=utf-8

RemotePatientMonitoring

Get Check-In Reviews

Get Check-In Reviews.

get /remote-patient-monitoring/checkin-reviews

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string
org_uuid	(optional)	query	true	number
start_date	(ex. 2018-10-01)	query	true	string
end_date	(ex. 2018-10-30)	query	true	string

Example Request

get /remote-patient-monitoring/checkin-reviews HTTP/1.1
Content-Type: application/json; charset=utf-8

Check-In Reviews (POST)

Send Push Notification.

post /remote-patient-monitoring/checkin-reviews

Request Body: RemotePatientMonitoring.Check_In_Review_POST

Example Request

post /remote-patient-monitoring/checkin-reviews HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "checkin_uuid": "1803",
  "user_uuid": "9481",
  "patient_uuid": "9491",
  "message": "string",
  "display": 770,
  "minutes": 851
}

CheckinController index

Get Total Checkins as per the user organization .

get /remote-patient-monitoring/checkins

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /remote-patient-monitoring/checkins HTTP/1.1
Content-Type: application/json; charset=utf-8

Add RPM Patient

Create Remote Patient.

post /remote-patient-monitoring/programs/add-patient

Request Body: RemotePatientMonitoring.Create_Patient

Example Request

post /remote-patient-monitoring/programs/add-patient HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "program_uuid": "9718",
  "patient_uuid": "2672"
}

Check-In Review (Delete)

Delete Checked-In Information

delete /remote-patient-monitoring/checkin-reviews{checkin_review}

Example Request

delete /remote-patient-monitoring/checkin-reviews{checkin_review} HTTP/1.1
Content-Type: application/json; charset=utf-8

Remove Patient RPM

Delete Patient RPM.

delete /remote-patient-monitoring/programs{program_uuid}/patients/{patient_uuid}

Example Request

delete /remote-patient-monitoring/programs{program_uuid}/patients/{patient_uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Tracked Condition (Delete)

Delete Tracked Information

delete /remote-patient-monitoring/tracked-conditions/{tracked_condition}

Example Request

delete /remote-patient-monitoring/tracked-conditions/{tracked_condition} HTTP/1.1
Content-Type: application/json; charset=utf-8

Tracked Condition (GET)

Get single tracked condition

get /remote-patient-monitoring/tracked-conditions/{tracked_condition}

Example Request

get /remote-patient-monitoring/tracked-conditions/{tracked_condition} HTTP/1.1
Content-Type: application/json; charset=utf-8

Tracked Condition (PUT)

Update Patient's Tracked data.

put /remote-patient-monitoring/tracked-conditions/{tracked_condition}

Request Body: RemotePatientMonitoring.Update_Tracked_data

Example Request

put /remote-patient-monitoring/tracked-conditions/{tracked_condition} HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "patient_uuid": "6393",
  "provider_uuid": "8776",
  "user_uuid": "4705",
  "icd_lex_code": 134,
  "items": "array"
}

Check-In Counts

Get Total Check-Ins, Reviewed Check-Ins, Unreviewed Check-Ins .

get /remote-patient-monitoring/checkins/count/{user_uuid}

Example Request

get /remote-patient-monitoring/checkins/count/{user_uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get a single program.

get /remote-patient-monitoring/programs/{program}

Example Request

get /remote-patient-monitoring/programs/{program} HTTP/1.1
Content-Type: application/json; charset=utf-8

Check-In Reviews (GET)

Get single Check-In review

get /remote-patient-monitoring/checkin-reviews/{checkin_review}

Example Request

get /remote-patient-monitoring/checkin-reviews/{checkin_review} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get Items

List the Items.

get /remote-patient-monitoring/items

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /remote-patient-monitoring/items HTTP/1.1
Content-Type: application/json; charset=utf-8

Display a listing of the resource

get /remote-patient-monitoring/patients/{patient}

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /remote-patient-monitoring/patients/{patient} HTTP/1.1
Content-Type: application/json; charset=utf-8

Patient Check-Ins

Get Patient's Check-Ins as per the dates.

get /remote-patient-monitoring/checkins/patients/{patient_uuid}

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string
start_date	(ex. 2018-10-01)	query	true	string
end_date	(ex. 2018-10-30)	query	true	string

Example Request

get /remote-patient-monitoring/checkins/patients/{patient_uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Show Patient Programs

Show Patient Programs.

get /remote-patient-monitoring/programs/patients/{patient_uuid}

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /remote-patient-monitoring/programs/patients/{patient_uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Patients Track Index

get /remote-patient-monitoring/tracked-conditions

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /remote-patient-monitoring/tracked-conditions HTTP/1.1
Content-Type: application/json; charset=utf-8

Tracked Condition (POST)

Store Patient's Tracked data.

post /remote-patient-monitoring/tracked-conditions

Request Body: RemotePatientMonitoring.Store_Tracked_data

Example Request

post /remote-patient-monitoring/tracked-conditions HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "patient_uuid": "5226",
  "provider_uuid": "5341",
  "user_uuid": "2291",
  "icd_lex_code": 102,
  "items": "array"
}

Programs assigned to an organization.

get /remote-patient-monitoring/programs

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /remote-patient-monitoring/programs HTTP/1.1
Content-Type: application/json; charset=utf-8

Patients List With RPM Flag

Display a listing of the patients with RPM flag.

get /remote-patient-monitoring/patients

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string
keyword	(optional)	query	true	string
org_uuid	(optional)	query	true	number

Example Request

get /remote-patient-monitoring/patients HTTP/1.1
Content-Type: application/json; charset=utf-8

Store workflow event

Store workflow events.

post /remote-patient-monitoring/programs/events

Request Body: RemotePatientMonitoring.Store_Event

Example Request

post /remote-patient-monitoring/programs/events HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "program_uuid": "6688",
  "patient_uuid": "3673",
  "step_uuid": "5816"
}

RPM WorkFlow Steps Tracking

This is Patient Track Progress steps.

get /remote-patient-monitoring/workflow

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /remote-patient-monitoring/workflow HTTP/1.1
Content-Type: application/json; charset=utf-8

SMS_Message_Templates

Activate this template

Activate this template.

post /sms-message-template/category/activate/{template-uuid}

Example Request

post /sms-message-template/category/activate/{template-uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Create SMS Message Template

Create SMS Message Template.

post /sms-message-template

Example Request

post /sms-message-template HTTP/1.1
Content-Type: application/json; charset=utf-8

Delete SMS Message Template

Delete SMS Message Template.

Delete /sms-message-template

Example Request

Delete /sms-message-template HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all SMS Message Templates

Get all SMS Message Templates.

get /sms-message-template

Example Request

get /sms-message-template HTTP/1.1
Content-Type: application/json; charset=utf-8

Render SMS Message Template

Render SMS Message Template.

get /sms-message-template/{uuid}/render

Parameter Name	Description	Location	Required	Data Type
appointment_id	Appointment ID(uuid)	query	true	integer
patient_id	Patient ID(uuid)	query	true	integer

Example Request

get /sms-message-template/{uuid}/render HTTP/1.1
Content-Type: application/json; charset=utf-8

Render SMS Track Response Message Template

Render SMS Track Response Message Template.

get /sms-message-track-response-template/{uuid}/render

Parameter Name	Description	Location	Required	Data Type
appointment_id	Appointment ID(uuid)	query	true	integer
patient_id	Patient ID(uuid)	query	true	integer

Example Request

get /sms-message-track-response-template/{uuid}/render HTTP/1.1
Content-Type: application/json; charset=utf-8

Create SMS Message Template

Update SMS Message Template.

Put /sms-message-template/{uuid}/

Example Request

Put /sms-message-template/{uuid}/ HTTP/1.1
Content-Type: application/json; charset=utf-8

SMS_Messages

Get all SMS Messages

Get all SMS Messages.

get /sms-messages

Example Request

get /sms-messages HTTP/1.1
Content-Type: application/json; charset=utf-8

Get SMS Messages Report

Get SMS Messages Report.

get /sms-messages/report

Example Request

get /sms-messages/report HTTP/1.1
Content-Type: application/json; charset=utf-8

TokboxSessionImage

Search Tokbox Session Image

Search Tokbox Session Image.

get /tokbox-session-image/search

Example Request

get /tokbox-session-image/search HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all Tokbox Sessions Images

Get all TokboxSessionImage.

get /tokbox-session-Image

Example Request

get /tokbox-session-Image HTTP/1.1
Content-Type: application/json; charset=utf-8

Get Tokbox Session Image

Get TokboxSessionImage.

get /tokbox-session-image/{uuid}

Example Request

get /tokbox-session-image/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Tokbox Session Get Image

Tokbox Session Image.

get /tokbox-session-image/{uuid}/body

Example Request

get /tokbox-session-image/{uuid}/body HTTP/1.1
Content-Type: application/json; charset=utf-8

TokboxSession

Search Tokbox Session.

get /tokbox-session/search

Example Request

get /tokbox-session/search HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all Tokbox Sessions

Get all TokboxSession.

get /tokbox-session

Example Request

get /tokbox-session HTTP/1.1
Content-Type: application/json; charset=utf-8

Invite to Session

Invite to Session.

post /tokbox-session/{GUID}/invite

Request Body: TokboxSession.TokboxSession_Invite

Example Request

post /tokbox-session/{GUID}/invite HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "email": "string",
  "patient_id": "7868",
  "emailOrSms": "string",
  "phone": 645,
  "orgOrDocsinkNumber": "string"
}

Get Tokbox Session

Get TokboxSession.

get /tokbox-session/{uuid}

Example Request

get /tokbox-session/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Telehealth Session

Telehealth Session.

get /tokbox-session/telehealth-sessions

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /tokbox-session/telehealth-sessions HTTP/1.1
Content-Type: application/json; charset=utf-8

Telehealth Data

Telehealth Session.

get /tokbox-session/telehealth-data

Parameter Name	Description	Location	Required	Data Type
min-date	Starting date for data (ie 2020-03-01)	query	true	string
max-date	end date for data (optional) (ie 2020-03-01)	query	true	string

Example Request

get /tokbox-session/telehealth-data HTTP/1.1
Content-Type: application/json; charset=utf-8

Telehealth Session User Data

Telehealth Session.

get /tokbox-session/telehealth-user-data

Parameter Name	Description	Location	Required	Data Type
min-date	Starting date for data (ie 2020-03-01)	query	true	string
max-date	end date for data (optional) (ie 2020-03-01)	query	true	string

Example Request

get /tokbox-session/telehealth-user-data HTTP/1.1
Content-Type: application/json; charset=utf-8

TokboxSessionVideo

Search Tokbox Session Video

Search Tokbox Session Video.

get /tokbox-session-video/search

Example Request

get /tokbox-session-video/search HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all Tokbox Sessions Videos

Get all TokboxSessionVideo.

get /tokbox-session-video

Example Request

get /tokbox-session-video HTTP/1.1
Content-Type: application/json; charset=utf-8

Get Tokbox Session Video

Get TokboxSessionVideo.

get /tokbox-session-video/{uuid}

Example Request

get /tokbox-session-video/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Tokbox Session Get Video

Tokbox Session Video.

get /tokbox-session-video/{uuid}/body

Example Request

get /tokbox-session-video/{uuid}/body HTTP/1.1
Content-Type: application/json; charset=utf-8

Tokbox Session Get Video Thumbnail

Tokbox Session Video Thumbnail.

get /tokbox-session-video/{uuid}/body-thumbnail

Example Request

get /tokbox-session-video/{uuid}/body-thumbnail HTTP/1.1
Content-Type: application/json; charset=utf-8

UserAppointments

Search Patient Appointments

Search User Appointments.

get /user-appointments/search

Parameter Name	Description	Location	Required	Data Type
show_on_tasks	(1 for true, 0 for no, OPTIONAL)	query	true	boolean
appointment_type[]	(UUID)(Array)	query	true	number
user[]	(UUID)(Array)	query	true	number
min_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
max_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string

Example Request

get /user-appointments/search HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all This Users Appointments

Get all This Users Appointments.

get /user-appointments/self

Parameter Name	Description	Location	Required	Data Type
show_on_tasks	(1 for true, 0 for no, OPTIONAL)	query	true	boolean
min_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
max_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string

Example Request

get /user-appointments/self HTTP/1.1
Content-Type: application/json; charset=utf-8

Remove Users Appointment.

delete /user-appointments/{userUUID}

Parameter Name	Description	Location	Required	Data Type
appointment_id	Appointment UUID	query	true	integer

Example Request

delete /user-appointments/{userUUID} HTTP/1.1
Content-Type: application/json; charset=utf-8

Add Users Appointment.

Add Users Appointment {userUUID}.

put /user-appointments/{userUUID}

Request Body: UserAppointments.UserAppointment_PUT

Example Request

put /user-appointments/{userUUID} HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "appointment_id": "9325"
}

Get all User Appointments

Get all User Appointments.

get /user-appointments

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /user-appointments HTTP/1.1
Content-Type: application/json; charset=utf-8

Add Users Appointment.

post /user-appointments/

Request Body: UserAppointments.UserAppointment_POST

Example Request

post /user-appointments/ HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "user_id": "8204",
  "appointment_id": "3185"
}

Get User Appointment for User.

get /user-appointments/{uuid}

Parameter Name	Description	Location	Required	Data Type
show_on_tasks	(1 for true, 0 for no, OPTIONAL)	query	true	boolean
min_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string
max_appointment_date	(ex. 2018-10-01T01:02:00+00:00 , OPTIONAL)	query	true	string

Example Request

get /user-appointments/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

UserReviewUrls

Get UserReviewUrl

get /user-review-url/{uuid}

Example Request

get /user-review-url/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get UserReviewUrl Users

get /user-review-url/listUsersWithReviewUrl

Parameter Name	Description	Location	Required	Data Type
sort	(ex. id or title) (optional).	query	true	string
order	(ex. ASC or DESC) (optional).	query	true	string

Example Request

get /user-review-url/listUsersWithReviewUrl HTTP/1.1
Content-Type: application/json; charset=utf-8

Get UserReviewUrls

get /user-review-url/

Example Request

get /user-review-url/ HTTP/1.1
Content-Type: application/json; charset=utf-8

Users

Get a User in the org

get /users/{uuid}

Example Request

get /users/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all Users in org

Get all Users.

get /users

Example Request

get /users HTTP/1.1
Content-Type: application/json; charset=utf-8

Search all Users in org

get /users/search

Example Request

get /users/search HTTP/1.1
Content-Type: application/json; charset=utf-8

VoicePagerNumber

Save VoicePagerNumber

Save VoicePagerNumber.

post /voice-pager-numbers

Request Body: VoicePagerNumber.Save_VoicePagerNumber

Example Request

post /voice-pager-numbers HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "number": 959,
  "chat_id": "7160"
}

Get all VoicePagerNumber

Get all VoicePagerNumber.

get /voice-pager-numbers

Example Request

get /voice-pager-numbers HTTP/1.1
Content-Type: application/json; charset=utf-8

Search Voice Pager Number Messages

Search Voice Pager Number Messages.

get /voice-pager-number-messages/Search

Example Request

get /voice-pager-number-messages/Search HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all Chat_id VoicePagerNumber

Get all Chat_id VoicePagerNumber.

get /voice-pager-numbers/chat/{chat_id}

Example Request

get /voice-pager-numbers/chat/{chat_id} HTTP/1.1
Content-Type: application/json; charset=utf-8

Delete VoicePagerNumber

Delete VoicePagerNumber.

delete /voice-pager-numbers/{uuid}

Example Request

delete /voice-pager-numbers/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get VoicePagerNumber Messages

get /voice-pager-numbers-messages/chat/{chat}

Example Request

get /voice-pager-numbers-messages/chat/{chat} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get all Voice Pager Number Messages

Get all Voice Pager Number Messages.

get /voice-pager-number-messages

Example Request

get /voice-pager-number-messages HTTP/1.1
Content-Type: application/json; charset=utf-8

WaitingRooms

Invite to Waiting Room

post /waiting-rooms/{UUID}/invite/{Patient-UUID}

Request Body: WaitingRooms.waiting_rooms_Invite

Example Request

post /waiting-rooms/{UUID}/invite/{Patient-UUID} HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "emailOrSms": "string",
  "orgOrDocsinkNumber": "string"
}

Waiting_Rooms

Get 5 Minute Checkin

get /waiting-rooms/5-minute-checkin

Example Request

get /waiting-rooms/5-minute-checkin HTTP/1.1
Content-Type: application/json; charset=utf-8

Put 5 Minute Checkin

put /waiting-rooms/5-minute-checkin

Request Body: Waiting_Rooms.Put_5_Minute_Checkin

Example Request

put /waiting-rooms/5-minute-checkin HTTP/1.1
Content-Type: application/json; charset=utf-8
{
  "teleheath_5_minute_check_in": "boolean",
  "teleheath_5_minute_check_in_type": "string"
}

office

Get office

get /office/{uuid}

Example Request

get /office/{uuid} HTTP/1.1
Content-Type: application/json; charset=utf-8

Get My Appointments

Get Offices

get /office

Example Request

get /office HTTP/1.1
Content-Type: application/json; charset=utf-8