Data Dictionary - SarahJChong/emergency-duress-app GitHub Wiki

Also refer to Database Design.md for the database schema with a complete list of fields.

Display name	Description	DB/field name	Field type	Format of field	Comments and Notes
Closed by	Name of Security Responder that closed a distress call record	closedBy	Text - single line	Same as "Name" field below
Closure note	Notes Security Responder enter when closing a distress call record	closureNotes	Text - multi line	Free text, length: 2-1000
Contact number	Contact number of user	contactNumber	Text - single line	Phone number, length: TBC	Only Australian numbers (+61)
Date called	Date & time when End user made duress call	dateCalled	Date & Time	Based on locale settings, timezone for WA (AWST)
Date closed	Date & time when End user cancels request, or Security responder closes call	dateClosed	Date & Time	Based on locale settings, timezone for WA (AWST)
Duration	How long it took from issue being raised to it being closed / cancelled	N/A - computed in app logic	Hours Minutes	HH:MM	Calculation: Duration = Data closed - Date called
Email	Email address of user	email	Text - single line	Email address, length: 8-100
Global default number	Default phone number used for "Guest" mode calls (i.e. unauthenticated users)	N/A - Env. variable in the frontend web application	Text - single line	Phone number, length: TBC
GPS coordinates	GPS coordinates of location of user during distress call	gpsCoordinates	GeoJSON Object	Format - Decimal degrees (DD)
ID	Unique ID for distress call record	_id	Text - single line	Field length & format - TBC
Location	Location of user	locationId	Dropdown list, single select	Dropdown options: as setup by Admin	Each "Location" must be unique - i.e. no duplicates
Location default number	Default phone number for a given location	defaultPhoneNumber	Text - single line	Phone number, length: TBC
Location default email	Default email address for a given location	defaultEmail	Text - single line	Email address, length: 8-100
Name	Name of user	name	Text - single line	Free text, length: 2-100
Reason for cancellation	Reason End User wants to cancel a distress call record	cancellationReason	Text - multi line	Free text, length: 2-1000
Room number	Room number of user	roomNumber	Text - single line	Free text, length: 1-100
Status	Status of distress call	status	Dropdown list, single select	Dropdown options: Open, Closed, Cancelled