ABCDEFGHIJKLMNOPQRSTUVWXYZ
1
Simple Data Dictionary
2
3
4
This sheet enumerates the tables of Simple Server's data model. It lists each 's meaning, type, possible values, and other useful information. These datas are the building blocks that power Simple's dashboard and reporting capabilities.
5
6
7
ModelFieldTypeConstraintsDefinition
8
9
addressesPatient address details
10
iduuidUnique patient address ID
11
street_addressstringPatient street address
12
village_or_colonystringPatient village, colony, etc.
13
districtstringPatient district, upazila, etc.
14
zonestringPatient zone, block, etc.
15
statestringPatient state
16
countrystringPatient country
17
pinstringPatient pin, zip code, postal code, etc.
18
created_atdatetimenull: falseWhen the address was first created on the server
19
updated_atdatetimenull: falseWhen the address was last updated on the server
20
device_created_atdatetimenull: falseWhen the address was first created in the mobile app
21
device_updated_atdatetimenull: falseWhen the address was last updated in the mobile app
22
deleted_atdatetimeWhen the address was deleted. Blank if not deleted.
23
24
appointmentsAppointments when patients are expected to return for follow up
25
iduuidUnique patient appointment ID
26
patient_iduuidnull: falseAppointment for this patient ID
27
facility_iduuidnull: falseAppointment to show up at this facility ID
28
scheduled_datedatenull: falseWhen the appointment is scheduled
29
statusstringAppointment status ("scheduled", "canceled", "visited")
30
cancel_reasonstringWhy the appointment was canceled. Blank if not canceled.
31
remind_ondateWhen to start reminding patients to return
32
agreed_to_visitbooleanWhether or not the patient agreed to visit (after being reminded)
33
appointment_typestringnull: falseHow the appointment was created ("manual" or "automatic")
34
user_iduuidUser ID who created the appointment
35
creation_facility_iduuidFacility ID where the appointment was created
36
created_atdatetimenull: falseWhen the appointment was first created on the server
37
updated_atdatetimenull: falseWhen the appointment was last updated on the server
38
device_created_atdatetimenull: falseWhen the appointment was first created in the mobile app
39
device_updated_atdatetimenull: falseWhen the appointment was last updated in the mobile app
40
deleted_atdatetimeWhen the appointment was deleted. Blank if not deleted.
41
42
audit_logsDEPRECATED
43
iduuidDeprecated
44
actionstringnull: falseDeprecated
45
auditable_typestringnull: falseDeprecated
46
auditable_iduuidnull: falseDeprecated
47
user_iduuidnull: falseDeprecated
48
created_atdatetimenull: falseDeprecated
49
updated_atdatetimenull: falseDeprecated
50
deleted_atdatetimeDeprecated
51
52
blood_pressuresBlood pressure recording for a patient
53
iduuidUnique blood pressure recording ID
54
systolicintegernull: falseSystolic BP
55
diastolicintegernull: falseDiastolic BP
56
patient_iduuidnull: falseBlood pressure for this patient ID
57
facility_iduuidnull: falseFacility ID where the blood pressure was recorded
58
user_iduuidUser ID that recorded the blood pressure
59
recorded_atdatetimeWhen the blood pressure was actually measured
60
created_atdatetimenull: falseWhen the blood pressure was first created on the server
61
updated_atdatetimenull: falseWhen the blood pressure was last updated on the server
62
device_created_atdatetimenull: falseWhen the blood pressure was first created in the mobile app
63
device_updated_atdatetimenull: falseWhen the blood pressure was last updated in the mobile app
64
deleted_atdatetimeWhen the blood pressure was deleted. Blank if not deleted.
65
66
blood_sugarsBlood sugar recording for a patient
67
iduuidUnique blood sugar recording ID
68
blood_sugar_typestringnull: falseType of blood sugar measurement ("random", "post-prandial", "fasting", "hba1c")
69
blood_sugar_valuedecimalnull: falseValue of blood sugar measurement (in mg/dL if random, post-prandial or fasting, DCCT % if hba1c)
70
patient_iduuidnull: falseBlood sugar for this patient ID
71
user_iduuidnull: falseUser ID that recorded the blood sugar
72
facility_iduuidnull: falseFacility ID where the blood sugar was recorded
73
device_created_atdatetimenull: falseWhen the blood sugar was first created in the mobile app
74
device_updated_atdatetimenull: falseWhen the blood sugar was last updated in the mobile app
75
created_atdatetimenull: falseWhen the blood sugar was first created on the server
76
updated_atdatetimenull: falseWhen the blood sugar was last updated on the server
77
recorded_atdatetimenull: falseWhen the blood sugar was actually measured
78
deleted_atdatetimeWhen the blood sugar was deleted. Blank if not deleted.
79
80
call_logsLogs of phone calls made by Simple App users to patients
81
session_idstringExotel session ID for the call
82
resultstringThe result of the call ('queued', 'ringing', 'in_progress', 'completed', 'failed', 'busy', 'no_answer', 'canceled', 'unknown')
83
durationintegerThe duration of the phone call
84
callee_phone_numberstringnull: falsePhone number of the patient that received the call
85
caller_phone_numberstringnull: falsePhone number of the Simple user that initiated the call
86
start_timedatetimeWhen the phone call started
87
end_timedatetimeWhen the phone call ended
88
created_atdatetimenull: falseWhen the call log was first created on the server
89
updated_atdatetimenull: falseWhen the call log was last updated on the server
90
deleted_atdatetimeWhen the call log was deleted. Blank if not deleted.
91
92
communications
93
iduuidUnique communication ID
94
appointment_iduuidnull: falseAppointment ID of the appointment that the user was following up with the patient for
95
user_iduuidUser ID of the Simple user that made the communication
96
communication_typestringThe type of communication made to the patient ('voip_call', 'manual_call', 'missed_visit_sms_reminder')
97
detailable_typestringThe type of detail record that describes the outcome of the communication (eg. TwilioSmsDeliveryDetail)
98
detailable_idbigintThe ID of the detail record that describes the outcome of the communication
99
created_atdatetimenull: falseWhen the communication was first created on the server
100
updated_atdatetimenull: falseWhen the communication was last updated on the server