DocsInk API Schema Reference
Complete description of all our data models
Check_In_Review_POST
{
"type": "object",
"properties": {
"checkin_uuid": {
"type": "number"
},
"user_uuid": {
"type": "number"
},
"patient_uuid": {
"type": "number"
},
"message": {
"type": "string"
},
"display": {
"type": "number"
},
"minutes": {
"type": "number"
}
},
"required": [
"checkin_uuid",
"user_uuid",
"patient_uuid",
"message",
"display",
"minutes"
],
"example": {
"checkin_uuid": "1803",
"user_uuid": "9481",
"patient_uuid": "9491",
"message": "string",
"display": 770,
"minutes": 851
}
}
CreateAndSendChekin
{
"type": "object",
"properties": {
"message": {
"type": "string"
},
"sms_email": {
"type": "string"
},
"recipient_id": {
"type": "number"
},
"survey_type_id": {
"type": "number"
}
},
"required": [
"message",
"sms_email",
"recipient_id",
"survey_type_id"
],
"example": {
"message": "string",
"sms_email": "string",
"recipient_id": "1034",
"survey_type_id": "8734"
}
}
CreateCannedReply
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"example": {
"message": "string"
}
}
CreateChekin
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"schedule_time": {
"type": "string"
},
"schedule_period": {
"type": "string"
},
"surveys": {
"type": "array"
}
},
"required": [
"name",
"schedule_time",
"schedule_period"
],
"example": {
"name": "string",
"schedule_time": "string",
"schedule_period": "string",
"surveys": "array"
}
}
CreateExternalMessage
{
"type": "object",
"properties": {
"message": {
"type": "string"
},
"sent_to": {
"type": "string"
},
"Contact": {
"type": "number"
},
"receiver_first_name": {
"type": "string"
},
"receiver_last_name": {
"type": "string"
},
"expires": {
"type": "string"
},
"total_views": {
"type": "number"
},
"total_downloads": {
"type": "number"
},
"extra_auth": {
"type": "number"
},
"subject": {
"type": "string"
},
"display_credentials": {
"type": "number"
},
"attachments": {
"type": "array"
}
},
"required": [
"message",
"sent_to",
"Contact",
"receiver_first_name",
"receiver_last_name",
"expires",
"total_views",
"total_downloads"
],
"example": {
"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"
}
}
Create_Appointment
{
"type": "object",
"properties": {
"appointment_type_id": {
"type": "number"
},
"patient_id": {
"type": "number"
},
"office_id": {
"type": "number"
},
"location_id": {
"type": "number"
},
"appointment_date": {
"type": "string"
},
"appointment_timezone": {
"type": "string"
},
"waiting_room_id": {
"type": "number"
}
},
"required": [
"appointment_type_id",
"patient_id",
"office_id",
"location_id",
"appointment_date",
"appointment_timezone",
"waiting_room_id"
],
"example": {
"appointment_type_id": "6623",
"patient_id": "3949",
"office_id": "8054",
"location_id": "8319",
"appointment_date": "timestamp",
"appointment_timezone": "string",
"waiting_room_id": "9286"
}
}
Create_Patient
{
"type": "object",
"properties": {
"program_uuid": {
"type": "number"
},
"patient_uuid": {
"type": "number"
}
},
"required": [
"program_uuid",
"patient_uuid"
],
"example": {
"program_uuid": "9718",
"patient_uuid": "2672"
}
}
LoginUser
{
"type": "object",
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"email",
"password"
],
"example": {
"email": "string",
"password": "string"
}
}
PostContactContactTag
{
"type": "object",
"properties": {
"contact_uuid": {
"type": "string"
},
"contact_tag_uuid": {
"type": "string"
}
},
"required": [
"contact_uuid",
"contact_tag_uuid"
],
"example": {
"contact_uuid": "7770",
"contact_tag_uuid": "9145"
}
}
PostContactTag
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string"
}
},
"required": [
"name",
"color"
],
"example": {
"name": "string",
"color": "string"
}
}
Purchase_Available_Number
{
"type": "object",
"properties": {
"number": {
"type": "number"
},
"type": {
"type": "string"
},
"chat_id": {
"type": "string"
}
},
"required": [
"number",
"type",
"chat_id"
],
"example": {
"number": 785,
"type": "string",
"chat_id": "6047"
}
}
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string"
}
},
"required": [
"name",
"color"
],
"example": {
"name": "string",
"color": "string"
}
}
Put_5_Minute_Checkin
{
"type": "object",
"properties": {
"teleheath_5_minute_check_in": {
"type": "boolean"
},
"teleheath_5_minute_check_in_type": {
"type": "string"
}
},
"required": [
"teleheath_5_minute_check_in",
"teleheath_5_minute_check_in_type"
],
"example": {
"teleheath_5_minute_check_in": "boolean",
"teleheath_5_minute_check_in_type": "string"
}
}
RefreshUserToken
{
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
],
"example": {
"token": "string"
}
}
Save_FaxNumber
{
"type": "object",
"properties": {
"number": {
"type": "number"
},
"chat_id": {
"type": "string"
}
},
"required": [
"number",
"chat_id"
],
"example": {
"number": 871,
"chat_id": "3523"
}
}
{
"type": "object",
"properties": {
"number": {
"type": "number"
},
"chat_id": {
"type": "string"
}
},
"required": [
"number",
"chat_id"
],
"example": {
"number": 959,
"chat_id": "7160"
}
}
Send_Appointment_SMS
{
"type": "object",
"properties": {
"template_id": {
"type": "number"
},
"message": {
"type": "string"
},
"review_user_id": {
"type": "number"
}
},
"required": [
"template_id",
"message",
"review_user_id"
],
"example": {
"template_id": "5345",
"message": "string",
"review_user_id": "9145"
}
}
Store_Event
{
"type": "object",
"properties": {
"program_uuid": {
"type": "number"
},
"patient_uuid": {
"type": "number"
},
"step_uuid": {
"type": "number"
}
},
"required": [
"program_uuid",
"patient_uuid",
"step_uuid"
],
"example": {
"program_uuid": "6688",
"patient_uuid": "3673",
"step_uuid": "5816"
}
}
Store_Tracked_data
{
"type": "object",
"properties": {
"patient_uuid": {
"type": "number"
},
"provider_uuid": {
"type": "number"
},
"user_uuid": {
"type": "number"
},
"icd_lex_code": {
"type": "number"
},
"items": {
"type": "array"
}
},
"required": [
"patient_uuid",
"provider_uuid",
"user_uuid",
"icd_lex_code",
"items"
],
"example": {
"patient_uuid": "5226",
"provider_uuid": "5341",
"user_uuid": "2291",
"icd_lex_code": 102,
"items": "array"
}
}
TokboxSession_Invite
{
"type": "object",
"properties": {
"email": {
"type": "string"
},
"patient_id": {
"type": "number"
},
"emailOrSms": {
"type": "string"
},
"phone": {
"type": "number"
},
"orgOrDocsinkNumber": {
"type": "string"
}
},
"required": [
"email",
"patient_id",
"emailOrSms",
"phone",
"orgOrDocsinkNumber"
],
"example": {
"email": "string",
"patient_id": "7868",
"emailOrSms": "string",
"phone": 645,
"orgOrDocsinkNumber": "string"
}
}
Update_Appointment
{
"type": "object",
"properties": {
"appointment_type_id": {
"type": "number"
},
"patient_id": {
"type": "number"
},
"appointment_date": {
"type": "string"
},
"appointment_timezone": {
"type": "string"
},
"office_id": {
"type": "number"
},
"location_id": {
"type": "number"
},
"waiting_room_id": {
"type": "number"
},
"type": {
"type": "number"
},
"office": {
"type": "number"
},
"location": {
"type": "number"
},
"user[]": {
"type": "number"
}
},
"required": [
"appointment_type_id",
"patient_id",
"appointment_date",
"appointment_timezone",
"office_id",
"location_id",
"waiting_room_id",
"type",
"office",
"location",
"user[]"
],
"example": {
"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
}
}
Update_Tracked_data
{
"type": "object",
"properties": {
"patient_uuid": {
"type": "number"
},
"provider_uuid": {
"type": "number"
},
"user_uuid": {
"type": "number"
},
"icd_lex_code": {
"type": "number"
},
"items": {
"type": "array"
}
},
"required": [
"patient_uuid",
"provider_uuid",
"user_uuid",
"icd_lex_code",
"items"
],
"example": {
"patient_uuid": "6393",
"provider_uuid": "8776",
"user_uuid": "4705",
"icd_lex_code": 134,
"items": "array"
}
}
Upload_Image
{
"type": "object",
"properties": {
"file": {
"type": "string"
}
},
"required": [
"file"
],
"example": {
"file": "file"
}
}
UserAppointment_POST
{
"type": "object",
"properties": {
"user_id": {
"type": "integer"
},
"appointment_id": {
"type": "integer"
}
},
"required": [
"user_id",
"appointment_id"
],
"example": {
"user_id": "8204",
"appointment_id": "3185"
}
}
UserAppointment_PUT
{
"type": "object",
"properties": {
"appointment_id": {
"type": "integer"
}
},
"required": [
"appointment_id"
],
"example": {
"appointment_id": "9325"
}
}
waiting_rooms_Invite
{
"type": "object",
"properties": {
"emailOrSms": {
"type": "string"
},
"orgOrDocsinkNumber": {
"type": "string"
}
},
"required": [
"emailOrSms",
"orgOrDocsinkNumber"
],
"example": {
"emailOrSms": "string",
"orgOrDocsinkNumber": "string"
}
}