Minimal Simple Data Dictionary

	A	B	C	D	E	F
1	Minimal Simple Data Dictionary This is a version of the Simple Data Dictionary with the minimal set of elements required for our reporting pipeline. Green = Required for our reporting dashboard. Yellow = used in our dashboard, but not essential for reports. These fields enumerate the minimal data attributes needed to generate our dashboard's most important reports.
2	Model	Field	Type	Constraints	Definition	Comments

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