Additional Data Standard Schemas

Schema Recommendations

The following is a set of recommended schemas for additional data associated with various emergency types. Service providers for the following emergency types are recommended to deliver the associated data, however, data outside the recommended fields can be added with approval from RapidSOS.

Please note that the additional data fields indicated below are not included as part of an alert.new event from the WebSocket Event API.
To retrieve additional data, an integration must query the RAD-E API using the alert_id received through the WebSocket Event API connection.

RapidSOS works closely with public safety to ensure all data is optimized for usability by public safety telecommunicators.

To view full RAD-E API documentation, click Here

Security and Fire

None of the following fields are required; however, they are listed in order of importance and will often be provided where available.

Field	Type	Description
Description	string	A short, human-readable and informative overview of the alarm i.e. "Glass Break Detected"
Visually Verified	Boolean	Someone has visually confirmed the alarm as not false.
Zone/Sensor	string	The name assigned to the zone such as “Back door”. If this is not informational, such as “Zone 3”, it is preferred that it is not included.
Alarm Permit Number	String	Required for some jurisdictions that reject alarms from repeat false alarm offenders
Instructions	string	Special note such as pets, gate key/code, and cross streets
Site Phone	string	If there is a landline
Emergency Contacts	array	See the emergency contacts section for details.

mPERS (Medical, non-base station)

The following is a recommended list for mobile/GPS-based medical devices. Medical profile information may differ depending on the application.

Field	Type	Description
Description	string	A short, human-readable and informative overview of the emergency (i.e. "Low blood oxygen detected" or "Fall detection").
Zone/Sensor	String	The name assigned to the sensor/device such as “Medical pendant”. If this is not informational, such as “Zone 3”, it is preferred that it is not included.
Instructions	string	Special note such as pets, gate key/code, directions, cross streets
Patient Name	string	Name/Preferred name
Gender	string	Male, Female, non-binary, prefer not to say.
Date of birth	string	Patient's date of birth, used to determine their age.
Medical Conditions	string	List of conditions
Medications	string	List of medications
Allergies	string	List of allergies
Site Phone	string	If there is a landline
Emergency contacts	array	See the emergency contacts section for details.

Emergency Contacts

An array of emergency contacts can be added to any emergency type. Typically, the data includes no more than 3 contacts in addition to the primary homeowner, keyholder (premises-based alerts) or user (PERS, panic etc.) though this may not always be the case.

Field (*Required)	Type	Description
Name*	string	The emergency contact's full name
Phone*	string	The emergency contact's phone number
Relationship	string	Their relationship to the indivdual or premises. The first emergency contact will be assumed the primary user or keyholder, however, including this information here is helpful.
Language	string	Preferred language for this emergency contact. Leave blank for English (default)