A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | Model | Field | Type | Constraints | Definition | |||||||||||||||||||||
8 | ||||||||||||||||||||||||||
9 | addresses | Patient address details | ||||||||||||||||||||||||
10 | id | uuid | Unique patient address ID | |||||||||||||||||||||||
11 | street_address | string | Patient street address | |||||||||||||||||||||||
12 | village_or_colony | string | Patient village, colony, etc. | |||||||||||||||||||||||
13 | district | string | Patient district, upazila, etc. | |||||||||||||||||||||||
14 | zone | string | Patient zone, block, etc. | |||||||||||||||||||||||
15 | state | string | Patient state | |||||||||||||||||||||||
16 | country | string | Patient country | |||||||||||||||||||||||
17 | pin | string | Patient pin, zip code, postal code, etc. | |||||||||||||||||||||||
18 | created_at | datetime | null: false | When the address was first created on the server | ||||||||||||||||||||||
19 | updated_at | datetime | null: false | When the address was last updated on the server | ||||||||||||||||||||||
20 | device_created_at | datetime | null: false | When the address was first created in the mobile app | ||||||||||||||||||||||
21 | device_updated_at | datetime | null: false | When the address was last updated in the mobile app | ||||||||||||||||||||||
22 | deleted_at | datetime | When the address was deleted. Blank if not deleted. | |||||||||||||||||||||||
23 | ||||||||||||||||||||||||||
24 | appointments | Appointments when patients are expected to return for follow up | ||||||||||||||||||||||||
25 | id | uuid | Unique patient appointment ID | |||||||||||||||||||||||
26 | patient_id | uuid | null: false | Appointment for this patient ID | ||||||||||||||||||||||
27 | facility_id | uuid | null: false | Appointment to show up at this facility ID | ||||||||||||||||||||||
28 | scheduled_date | date | null: false | When the appointment is scheduled | ||||||||||||||||||||||
29 | status | string | Appointment status ("scheduled", "canceled", "visited") | |||||||||||||||||||||||
30 | cancel_reason | string | Why the appointment was canceled. Blank if not canceled. | |||||||||||||||||||||||
31 | remind_on | date | When to start reminding patients to return | |||||||||||||||||||||||
32 | agreed_to_visit | boolean | Whether or not the patient agreed to visit (after being reminded) | |||||||||||||||||||||||
33 | appointment_type | string | null: false | How the appointment was created ("manual" or "automatic") | ||||||||||||||||||||||
34 | user_id | uuid | User ID who created the appointment | |||||||||||||||||||||||
35 | creation_facility_id | uuid | Facility ID where the appointment was created | |||||||||||||||||||||||
36 | created_at | datetime | null: false | When the appointment was first created on the server | ||||||||||||||||||||||
37 | updated_at | datetime | null: false | When the appointment was last updated on the server | ||||||||||||||||||||||
38 | device_created_at | datetime | null: false | When the appointment was first created in the mobile app | ||||||||||||||||||||||
39 | device_updated_at | datetime | null: false | When the appointment was last updated in the mobile app | ||||||||||||||||||||||
40 | deleted_at | datetime | When the appointment was deleted. Blank if not deleted. | |||||||||||||||||||||||
41 | ||||||||||||||||||||||||||
42 | audit_logs | DEPRECATED | ||||||||||||||||||||||||
43 | id | uuid | Deprecated | |||||||||||||||||||||||
44 | action | string | null: false | Deprecated | ||||||||||||||||||||||
45 | auditable_type | string | null: false | Deprecated | ||||||||||||||||||||||
46 | auditable_id | uuid | null: false | Deprecated | ||||||||||||||||||||||
47 | user_id | uuid | null: false | Deprecated | ||||||||||||||||||||||
48 | created_at | datetime | null: false | Deprecated | ||||||||||||||||||||||
49 | updated_at | datetime | null: false | Deprecated | ||||||||||||||||||||||
50 | deleted_at | datetime | Deprecated | |||||||||||||||||||||||
51 | ||||||||||||||||||||||||||
52 | blood_pressures | Blood pressure recording for a patient | ||||||||||||||||||||||||
53 | id | uuid | Unique blood pressure recording ID | |||||||||||||||||||||||
54 | systolic | integer | null: false | Systolic BP | ||||||||||||||||||||||
55 | diastolic | integer | null: false | Diastolic BP | ||||||||||||||||||||||
56 | patient_id | uuid | null: false | Blood pressure for this patient ID | ||||||||||||||||||||||
57 | facility_id | uuid | null: false | Facility ID where the blood pressure was recorded | ||||||||||||||||||||||
58 | user_id | uuid | User ID that recorded the blood pressure | |||||||||||||||||||||||
59 | recorded_at | datetime | When the blood pressure was actually measured | |||||||||||||||||||||||
60 | created_at | datetime | null: false | When the blood pressure was first created on the server | ||||||||||||||||||||||
61 | updated_at | datetime | null: false | When the blood pressure was last updated on the server | ||||||||||||||||||||||
62 | device_created_at | datetime | null: false | When the blood pressure was first created in the mobile app | ||||||||||||||||||||||
63 | device_updated_at | datetime | null: false | When the blood pressure was last updated in the mobile app | ||||||||||||||||||||||
64 | deleted_at | datetime | When the blood pressure was deleted. Blank if not deleted. | |||||||||||||||||||||||
65 | ||||||||||||||||||||||||||
66 | blood_sugars | Blood sugar recording for a patient | ||||||||||||||||||||||||
67 | id | uuid | Unique blood sugar recording ID | |||||||||||||||||||||||
68 | blood_sugar_type | string | null: false | Type of blood sugar measurement ("random", "post-prandial", "fasting", "hba1c") | ||||||||||||||||||||||
69 | blood_sugar_value | decimal | null: false | Value of blood sugar measurement (in mg/dL if random, post-prandial or fasting, DCCT % if hba1c) | ||||||||||||||||||||||
70 | patient_id | uuid | null: false | Blood sugar for this patient ID | ||||||||||||||||||||||
71 | user_id | uuid | null: false | User ID that recorded the blood sugar | ||||||||||||||||||||||
72 | facility_id | uuid | null: false | Facility ID where the blood sugar was recorded | ||||||||||||||||||||||
73 | device_created_at | datetime | null: false | When the blood sugar was first created in the mobile app | ||||||||||||||||||||||
74 | device_updated_at | datetime | null: false | When the blood sugar was last updated in the mobile app | ||||||||||||||||||||||
75 | created_at | datetime | null: false | When the blood sugar was first created on the server | ||||||||||||||||||||||
76 | updated_at | datetime | null: false | When the blood sugar was last updated on the server | ||||||||||||||||||||||
77 | recorded_at | datetime | null: false | When the blood sugar was actually measured | ||||||||||||||||||||||
78 | deleted_at | datetime | When the blood sugar was deleted. Blank if not deleted. | |||||||||||||||||||||||
79 | ||||||||||||||||||||||||||
80 | call_logs | Logs of phone calls made by Simple App users to patients | ||||||||||||||||||||||||
81 | session_id | string | Exotel session ID for the call | |||||||||||||||||||||||
82 | result | string | The result of the call ('queued', 'ringing', 'in_progress', 'completed', 'failed', 'busy', 'no_answer', 'canceled', 'unknown') | |||||||||||||||||||||||
83 | duration | integer | The duration of the phone call | |||||||||||||||||||||||
84 | callee_phone_number | string | null: false | Phone number of the patient that received the call | ||||||||||||||||||||||
85 | caller_phone_number | string | null: false | Phone number of the Simple user that initiated the call | ||||||||||||||||||||||
86 | start_time | datetime | When the phone call started | |||||||||||||||||||||||
87 | end_time | datetime | When the phone call ended | |||||||||||||||||||||||
88 | created_at | datetime | null: false | When the call log was first created on the server | ||||||||||||||||||||||
89 | updated_at | datetime | null: false | When the call log was last updated on the server | ||||||||||||||||||||||
90 | deleted_at | datetime | When the call log was deleted. Blank if not deleted. | |||||||||||||||||||||||
91 | ||||||||||||||||||||||||||
92 | communications | |||||||||||||||||||||||||
93 | id | uuid | Unique communication ID | |||||||||||||||||||||||
94 | appointment_id | uuid | null: false | Appointment ID of the appointment that the user was following up with the patient for | ||||||||||||||||||||||
95 | user_id | uuid | User ID of the Simple user that made the communication | |||||||||||||||||||||||
96 | communication_type | string | The type of communication made to the patient ('voip_call', 'manual_call', 'missed_visit_sms_reminder') | |||||||||||||||||||||||
97 | detailable_type | string | The type of detail record that describes the outcome of the communication (eg. TwilioSmsDeliveryDetail) | |||||||||||||||||||||||
98 | detailable_id | bigint | The ID of the detail record that describes the outcome of the communication | |||||||||||||||||||||||
99 | created_at | datetime | null: false | When the communication was first created on the server | ||||||||||||||||||||||
100 | updated_at | datetime | null: false | When the communication was last updated on the server |