FiReDMX

This document and the FiRe and Rescue Service data model (FiReDMX) is issued under the following licence agreement. FiReDMX is intended to provide a free to use data schema from which providers and consumers of data within and to the UK Fire Sector can exchange data in a common format.

The details of the Open Licence are provided below:

Steve Allen of Love That Penguin (SA-LTP) is making the FiReDMX Data Model (DM) available to enquirers without charge, subject to the no-signature licence incorporated below.

To signify your agreement to the licence and to order FiReDMX DM please use the link at the end of this page.

Terms and Conditions table of contents.

TERMS AND CONDITIONS FOR USING, COPYING, DISTRIBUTING AND MODIFYING FiReDMX-DM

NOTICES: This Licence Agreement ("the Licence") is a legal agreement between you (either as an individual or as any other legal entity) and Steve Allen, LoveThatPenguin.com (“SA-LTP") for use of the FiReDMX -Data Model ("FiReDMX-DM") and related documentation provided with FiReDMX-DM. By opening, copying or otherwise using these FiReDMX-DM files you agree to be bound by the terms of the Licence. If you do not agree to the terms of the Licence, do not open or use FiReDMX-DM.

FiReDMX is a trade name of the SA-LTP ("the FiReDMX Trade Name") and the SA-LTP has applied to register FiReDMX as a trade mark in the UK and will be making applications to register FiReDMX as a trade mark in certain other countries including the USA. Nothing in the Licence shall entitle you to use the FiReDMX Trade Mark in connection with any goods or services created or distributed by you without formal permission from the SA-LTP as set out below in the Licence. The SA-LTP has also applied for patents ("the SA-LTP Patent") on certain aspects of the metadata structure.

To the extent only, that the particular version of FiReDMX-DM which you open infringes this patent you are granted a royalty-free perpetual licence to use this patent for certain specific acts in accordance with the Licence. Nothing in the Licence shall entitle you to a general Licence under the SA-LTP Patent nor shall this Licence entitle you to imply that your products are FiReDMX-compliant.


1. GRANT OF RIGHTS 1.1 On condition that you conform with the terms and conditions of this Licence, the SA-LTP grants to you the non-exclusive, non-transferable right throughout the World to:
	1.1.1 use FiReDMX-DM or any part thereof on any number of systems; 1.1.2 copy FiReDMX-DM; 1.1.3 to re-distribute FiReDMX-DM to third parties provided that:
		1.1.3.1 you ensure that all copies which you re-distribute include and are subject to this Licence; 1.1.3.2 that all copies which you re-distribute include a clear notice stating: "FiReDMX-DM Copyright SA-LTP ® 2013" "FiReDMX” is a trade name of “SA-LTP"; 1.1.3.3 that no charge is made for FiReDMX-DM, save that you may recover your reasonable costs of re-distribution and may charge in accordance with normal commercial practice for products or services created or distributed by you which incorporate FiReDMX-DM.
	1.1.4 to modify FiReDMX-DM subject to compliance with the provisions of clause 4.


	4. MODIFICATION OF FiReDMX-DM 4.1 You may modify your copy or copies of FiReDMX-DM or any portion of it, thus forming a work based on FiReDMX-DM, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of the following conditions:
		4.1.1 You must cause the modified data models to carry prominent notices stating that you changed the data models and the date of any change. 4.1.2 You must cause any work that you distribute or publish, that in whole or in part contains or is derived from FiReDMX-DM or any part thereof, to be licenced as a whole at no charge in perpetuity and non-exclusively to SA-LTP its subsidiaries and joint ventures substantially in the same terms (and for the avoidance of doubt under terms that are no less favourable) as under this Licence.
	4.2 These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from FiReDMX-DM, and can be reasonably considered independent and separate works in themselves, then this Licence, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on FiReDMX-DM, the distribution of the whole must be on the terms of this Licence, 4.3 Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to ensure that SA-LTP is entitled to use, copy, distribute and modify without charge derivative or collective works based on FiReDMX-DM. This would not include tangible product, but rather the underlying data models or designs comparable with FiReDMX-DM. 4.4 In addition, mere aggregation of another work not based on FiReDMX-DM with FiReDMX-DM (or with a work based on FiReDMX-DM) on a volume of a storage or distribution medium does not bring the other work under the scope of this Licence.

To signify your agreement to the licence and to order FiReDMX-DM please send an email quoting "FiReDMX-DM" in the subject field, and giving the following details in the body of the email, to FiReDMX@lovethatpenguin.com.

Your name
Your contact details
Your organisation and type (e.g. supplier, broadcaster)
Reason for your enquiry, and potential usage
Case tool in use
Modelling language in use
That you agree to the licence

2. Documents Referenced

UK - Electronic Government Interoperability Framework (e-GIF)

UK - Data Transfer Format 7.3 for the National Land and Property Gazetteer, DTF 7.3 Version 3.1, February 2012, Third Edition

UK – Chief Fire Officers Association (CFOA) / FiReControl Ways of Working Products and Outcomes

NSW, Australia – New South Wales Fire Brigade, Natural Disasters Mitigation Program (NDMP) Data Dictionary Project

UK – BBC Open Source Media Data Model.

UK – Fire Services Act 2004

UK – Fire Services National Framework 2012

UK – Civil Contigencies Act 2004

UK – Water UK Memorandum of Understanding

UK – British Standard 28601

UK – British Standard 7666

International - IETF RFC2822

3. Background to FiReDMX

FiReDMX has been created in order to assist the Fire Sector (primarily within the UK) to provide an efficient and effective information transfer data schema between systems and organisations.

It has been evident for a long time, is certainly the case today and for the future, that the drive for the Public Safety sector to collaborate and share information internally within an organisation (between systems) and externally (between organisations) has and will continue to increase. The number of systems involved in the transfer and consumption of information continues to increase with little or no compatibility between systems and organisations evident. The Fire Sector in particular is required to share information through a number of pressures and / or drivers including statutory duties, recommendations or identified best practice, this within a very demanding financial environment. It is also clear that issues will continue to be identified within the information sharing environment for example legacy and newly procured systems will nearly always create compatibility issues with common data exchange formats and information sharing. A Fire Service may have to employ a number of technical solutions or workarounds to accommodate the various compatibility issues and allow the business to continue day-to-day operations. Additional systems, technology workarounds, disparate and varied systems outputs to accommodate incompatibility with regard to sharing information add significant additional cost, resource and time to the adoption of common platforms within which information can be readily shared or exchanged. FiReDMX looks to create an XML language specifically for use within the Fire Sector, in doing so, it is hoped that the FiReDMX Data Model and its continue iterations will provide a format for which suppliers and users of systems can be confident that where FiReDMX is adopted, the burden and impact in sharing information between systems and organisations will be significantly reduced.

4. Construction and Description of the Data Schema

The Core data sets that are required to exchange data in a common format are. Each core data sets is broken down further within the data model and explained within this document.

The Core Data Sets are described below and outlined in Figure 1 – Core Data Sets

Figure 1- Core Data Sets

4.1. Party Class

Identifies a person, organisation or the provision of a service associated to the owning organisation, this may be an Officer within a FRS or a Water Authority that covers a number of FRS areas

4.2. Activity Class

Identifies the activity that a Party class is undertaking

4.3. Asset Class

Identifies an asset or a piece of equipment that belongs to a Party and is part of an activity e.g an Officer allocated to a Fire Station within an FRS and currently on duty.

4.4. Location Class

A location for which a Party, Activity or Asset is currently associated to

4.5. System Class

Data needed by the schema to maintain a database and not necessarily needed to exchange data between organisations

5. Description of the data and table headings

The table below is an example of the common table format used within the data model, it also provides the descriptions expected for each part of the common table format.

Describes the name of the data entity

Describes where the data entity exists in the schema

Description of the data entity

Data Attribute

Data Type

Primary Key

Unique

Record

Foreign Key

FK linked to

Mandatory / Optional

Data Dictionary Description

(Name of the field)

(field construction)

Yes or No

In most instances this is an auto generated number

Yes or No

The data entity and field within that entity that the FK links to

Whether an entry is required or not

6. FiReDMX Data Schema

6.1. Core Data Set

6.1.1. Party Class

This data set describes an organisation, sub organisation, service or person e.g an FRS, a command area, a utility or a Firefighter

6.1.1.1. Party Conceptual Data Model

6.1.1.2. Party Class – Physical Data Model

6.1.1.2.1. Party

See Party (Section 4.1) for an explanation of this core data set

Data Entity - Party		Top level – Core data set					Core Data Set – Provides a link to all organisational and person data
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
party_id	Integer	Y	Y	N	N	Mandatory	Provides a unique key for all organisational and person data
Party_alias	Varchar(80)	N	N	N	N	Optional	Allows the allocation of an Alias to organisational and person data
Party_type_id	Integer	N	N	Y	party_type	Mandatory	The unique ID of the party type

6.1.1.2.1.1. Party Type

Data Entity – party_type		sub level data set					Provides and defines the reference data for the type of party
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
party_type_id	Integer	N	N	N	N	Mandatory	Party Type Reference Data
party_name	Varchar(80)	N	N	N	N	Mandatory	The name for the party
party_description	text	N	N	N	N	Optional	Free text description of the party type

6.1.1.2.1.1.1. Party Type Reference Data

The data described in this table identifies the type of person or organisation for the party class record

party_type_id (integer)	Party_name (vchar80)	Definition (text)
1	Mobilisable Person	A person that can be attached to an incident
2	Non-Mobilisable Person	A person that cannot be attached to an incident
3	Officer	An Officer
4	Internal Organisation	An Internal Organisation

6.1.1.2.2. Person Conceptual Data Model

6.1.1.2.2.1. Person Physical Data Model

Records the person detail for a party record, person records follow the e-gif standard when describing a person in a data schema

Data Entity - Person		Sub level data set					Defines a person within the Party Data Class Collection of information describing someone's name (BS 8766:2004)
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
party_id	Integer	Y	Y	N	party_id	Mandatory	Provides a unique link to the person party primary key
Person_Family_name	Varchar(35)	N	N	N		Mandatory	That part of a person's name which is used to describe family, clan, tribal group, or marital association.
Person_Given_name	Varchar(35)	N	N	N		Mandatory	The forename or given name of a person.
Person_title	Integer	N	N	Y	Person_title_id	Mandatory	Standard form of address used to precede a person's name.
Person_type	Integer	N	N	Y	Person_type_id	Mandatory
Person_comment	Text	N	N	N		Optional	Free text comment area for the person being described

6.1.1.2.2.1.1. Person Type

Identifies the main role of the person being describes in the person record

Data Entity – Person_type		Sub level data set					Defines the type of person within person
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
Person_type_id	integer	N	N	N		Mandatory	Person Type Reference Data
Person_type_code	Char(4)	N	Y	N		Mandatory	Short code for the person type
description	text	N	N	N		Optional	Description of the person type

6.1.1.2.2.1.1.1. Person Type Reference data

Describes the key / high level roles within a Fire Service that a person falls into – Also describe in the CFOA Ways of Working document

person_type_id (integer)	person_type_code (char4)	Definition (text)
1	OF	Officer
2	Ff	Firefighter
3	SU	Support
4	OP	Other Personnel

6.1.1.2.2.1.1. Person Title

The full available range of generally recognised titles is permitted. However if any of the following are used then the value input must conform to the following format. Follows the e-gif standard when describing a person in a data schema

Data Entity – Person_title		Sub level data set of person					Defines a type of person within person
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
Person_title_id	integer	Y	Y	N		Mandatory	Person Type Reference Data
Person_title_name	vchar(6)	N	Y	N		Mandatory	Standard form of address used to precede a person's name.
description	text	N	N	N		Optional	Description of the person title

6.1.1.2.2.1.1.1. Person Title Reference data

Uses the BSEN 28601 standard as described in the e-gif standard for a person’s title

person_title_id (integer)	person_title_code (vchar6)	Definition (text)
1	Mr	BSEN 28601
2	Mrs	BSEN 28601
3	Miss	BSEN 28601
4	Ms	BSEN 28601
5	Dr	BSEN 28601
6	Rev	BSEN 28601
7	Sir	BSEN 28601
8	Lady	BSEN 28601
9	Lord	BSEN 28601

6.1.1.2.3. Organisation Conceptual Data Model

An overview of the organisation data model within the Party Core Data Class is described in the figure below -

6.1.1.2.3.1. Organisation – Physical Data Model

Creates an organisation within the Party Core Data set (see section 4.1), an organisation can exist on its own or have assets, locations, activities or other parties associated to it

Data Entity – organisation_name		Sub level data set					The name by which an organisation wishes to be known or the official name given to an organisation.
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
party_id	integer	N	N	Y	party_id	Mandatory
organisation_name	integer	Y	Y	N		Mandatory	The name of the organisation 1. Any allowable character from UNICODE set of characters. 2. Each element of the name must be separated by a space. 3. Consecutive spaces are not allowed.
organisation_type_id	integer	N	N	Y	Organisation_type	Mandatory	Describes the type of organisation sing the reference date from organisation_type
organisation_internal	Char(1) (Y) or (N)	N	N	N		Mandatory	Describes an internal organisational structure to the FRS e.g Fire Station Set to (Y) Yes. If an external organisation to the FRS e.g Police Authority Set to (n) No
Organisation_comment	text	N	N	N		Optional	Allows a comment to be placed against this organisations record
Organisation_ref	Vchar(8)	N	Y	N		Optional	A unique reference number allocated by the Registrar of Companies to a limited liability company or unlimited company at the time of first registration of that company. 1. Exactly 8 numerical digits OR 2. The first part must be two characters within the set: AC, FC, GE, GN, GS, IC, IP, LP, NA, NF, NI, NL, NO, NP, NR, NZ, OC, RC, SA, SC, SF, SI, SL, SO, SP, SR, SZ, ZC or the single character R. The second part is exactly 6 numerical digits.

6.1.1.2.3.1.1. Organisation Type

The organisational reference data provides the ability to identify or provide relational links e.g an FRS type can allow a polygon to be linked to a sub area within that FRS

Data Entity – organisation_name		Sub level data set					The name by which an organisation wishes to be known or the official name given to an organisation.
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
organisation_type_id	integer	N	N	N		Mandatory	Organisation Type Reference Data
Organisation_type_name	vchar60	N	N	N		Mandatory	The name of the organisation type
Organisation_type_description	Text	N	N	N		Optional	A description of the organisation type

6.1.1.2.3.1.1.1. Organisation Type Reference Data

An organisation requires to be describe as a type within the part Core Data Class, this is used within the data model to describe the organisational link or relationship to that party

Organisation_type_id (integer)	Organisation_type (vchar60)	Description (text)
1	FRS	The organisation is one that wholly involves the FRS e.g FRS area
2	FRS Sub Area	The organisation is one that is within an FRS and further devolved e,g an FRS command area
3	Station	The organisation is an FRS station
4	External	The organisation is external to the FRS

6.1.1.2.4. Station Add Info Conceptual Data Model

6.1.1.2.4.1. Station Physical Data Model

An FRS station due to its specific nature within the FRS nearly always contains additional information from which systems triggers, connectivity, nodal information or linking data are required, this additional information can be recorded in the station record. Where organisation_type_id equals station (3) then the party_id will also link to a station record

Data Entity – station_addinfo		Sub level data set					Provides further detail for an FRS Fire Station
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
Party_id	integer	N	N	Y	Party_id	Mandatory	Unique link / identfier to Party
Station_duty_type_id	Integer	N	N	Y	Station_duty_type_id	Mandatory	Provides the duty type for the station
Station_core	Char(1)	N	N	N		Mandatory	Identifies if the station is a core station and requires to be covered when home fire appliances are absent e.g protected incident
Station_crewed_from	datetime	N	N	N		Mandatory	Identifies the time from which the station is crewed by on station personnel
Station_crewed_until	datetime	N	N	N		Mandatory	Identifies the time until which the station is crewed by on station personnel

6.1.1.2.4.1.1. Station Duty Type

Records the type of FRS station for systems that use the station to determine communication methods or duty types rather than individual records or geographical areas as the source for determining information pertaining to alerter methods or resource dispositions

Data Entity – station_duty_type		Sub level data set					Provides further detail for an FRS Fire Station
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
station_duty_type_id	integer	N	N	N		Mandatory	Station Duty Type Reference Data
Station_duty_type_name	Vchar(20)	N	N	N		Mandatory	The duty type for this instance that is in use at the station
Station_duty_type_description	text	N	N	N		Optional	Free Text description as required

6.1.1.2.4.1.2. Station_duty_type Reference Data

A station can be only one of the below at any point in time e.g for day crewed station (1) Shift would apply during the time that shift duty system personnel were on the station until such time as they left then (2) RDS would apply.

Station_duty_type_id (integer)	Station_duty_type_name (vchar20)	Definition
1	Shift	Shift Duty Station (station wholly crewed 24 hours a day by shift duty system personnel )
2	RDS	Retained Station (station wholly crewed by on call retained duty system personnel)
3	Mixed	Shift and Retained Station (A watch of shift duty system personnel crewed 24 hours a day and an on call retained duty system personnel element)
4	Nucleus	A day crewed Shift Duty Station augmented with on call Retained duty personnel whilst on duty. an RDS element either operates at all other times

6.1.2. Location Conceptual Data Model

6.1.3. Location physical Data Model

6.1.3.1. Location

Records the basic location details for the party and follows the BS 7666 Address formats as defined in e-gif standards for “Address”. It is assumed that either the National Property and Land Gazetteer or Ordnance Survey Address Based Premium is the default corporate gazetteer, only the UPRN is recorded within FiReDMX to avoid unnecessary duplication and to ensure the mastering of the data source is maintained at its source

Data Entity – location_address		Location_class					Provides an address reference for all FiReDMX locations
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
Location_id	integer	Y	Y	N		Mandatory	Unique ID
Party_id	integer	N	N	Y	Party_id	Mandatory	Unique Party ID
UPRN	Integer(12)	N	N	N		Mandatory	Unique Property Reference Number from either Ordnance Survey Address Base Premium or the National Land and Property Gazetteer. The UPRN is defined within the E-GIF standard as a positive integer minimum length of 1 digit and maximum length of 12, Range 1- 999999999999
location_type_id	vchar(20)	N	N	Y	location_type_id	Mandatory
Location_restricted	char(1)	N	N	N		Mandatory	Defines if the record should be public to all (N)No or restricted to just authorised system users (Y) Yes, default is (Y) Yes
Location_comment	text	N	N	N		Optional	Allows a comment to be placed against the address detail
Location_northing	decimal(9,2)	N	N	N		Mandatory	Uses the BLPU National Grid Reference Grid (Northing)
Location_easting	decimal(9,2)	N	N	N		Mandatory	Uses the BLPU National Grid Reference Grid (Easting)

6.1.3.1.1.1.1. Location Type

Allow as descriptive element for the location to be place against the party record to provide context

Data Entity – location_type		Sub level data set					Provides further detail for an FRS Fire Station
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
Location_type_id	Integer	Y	Y	N		Mandatory	Location Type Reference Data
Location_type_name	Vchar(15)	N	Y	N		Mandatory	Describes the address in an organisational context
Location_type_descriptor	Text	N	N	N		Optional	Free text description

6.1.3.1.1.1.1. Location Type Reference Data

Location_type_id (integer)	Location_type_name (vchar15)	Definition
1	Home	An address used by a party or resource as a private address not normally considered part of the organisation e.g. private address
2	Work	An address for the party or resource that is part of an organisation e.g Headquarters
3	Registered	A registered address of an organisation e.g. Head Office
4	Temporary	A temporary address that has a short validity less than 1 month e.g temporary fire station.

6.1.4. Activity

The Activity Data set provides the ability to set an activity against a party, an activity can been seen as the provision of a function, service or task set against a party. The activity can be set against a responsible and / or current party. This enables the ability to exchange data regarding out postings or differing duty contracts. Activities also require a geographical area to describe where the activity occurs. The activity table is in effect a linking table to a number of sub data sets.

6.1.4.1. Activity – Conceptual Data Model

6.1.4.2. Activity – Physical Data Model

Data Entity - Activity		Top level - Core data set					Provides the ability to link a particular activity to a person or organisation i.e role, service or a function of a party
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
activity_id	Integer	Y	Y	N	N	Mandatory	Unique table key
activity_type_id	Integer	N	N	Y	activity_type activity type_id	Mandatory	The type of activity the party is undertaking
activity_frs_id		N	N	Y	party party_id	Optional	An FRS external id for the party e.g
activity_to	Integer	N	N	Y	organisation organisation_id	Optional	The organisation the party is assigned to carry out this activity e.g RDS & Shift Duty contracts held be a single person i.e party
activity_from	Integer	N	N	Y	organisation organisation_id	Optional	The organisation the party is assigned from to carry out this activity e.g RDS & Shift Duty contracts held be a single person i.e party
activity_area	Integer	N	N	Y	polygon polygon_id	Optional	The ID of the geographic area that this activity is being carried out within
party_id	Integer	N	N	Y	party party_id	Mandatory	The unique ID from the party table that describes the owner of this activity

6.1.4.2.1. Activity Type

Data Entity – activity_type		Mid level - sub data set					Provides the reference activity types for the data model
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
activity_type_id	integer	Y	N	N		Mandatory	Activity Type Reference Data
activity_description	text	N	N	N		Optional	Free text description of the activity type

6.1.4.2.2. Activity Type Reference Types

Activity_type_id	activity_name	definition
1	National	The activity is a national activity e.g a utility that covers the whole FRS
2	FRS	The activity is one that wholly involves the FRS e.g FRS duty officer
3	FRS Sub Area	The activity is one in an FRS and further devolved e,g an FRS command area
4	Station	The activity belongs to an FRS station

6.1.4.3. Activity Communications route

Data Entity – activity_comms_route		Mid level - sub data set					Provides the ability to identify whether a party and activity will be displayed in a directory
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
directory_flag	Char (1)	N	N	N		Mandatory	Y –identifies that the communication route for the activity can be shown in a directory, N – identifies that the communication route for the activity cannot be shown in a directory
activity_id	Integer	N	N	Y	activity_id	Mandatory	Unique table key

6.1.4.4. Appliance Communication route

Data Entity – appliance_comms_route

Mid level - sub data set

Provides the ability to link a particular communication method to an appliance

Data Attribute

Data Type

Primary Key

Unique

Record

Foreign Key

FK linked to

Mandatory / Optional

Data Dictionary Description

Appliance_id

Integer

Appliance

Appliance_id

Mandatory

Unique table key

6.1.4.5. Availability Type

Data Entity – availability_type		Mid level - sub data set					Provides the reference activity types for the data model
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
availability_id	integer	Y	N	N		Mandatory	Activity unique id
availability_description	text	N	N	N		Optional	Free text description of the activity type

6.1.4.5.1. Availability Type Reference Types

availability_id	availability_name	definition
1	ODO	On Duty - Officer
2	ODS	On Duty – Shift Duty System
3	ODR	On Duty – Retained Duty System
4	OC	On Duty – On Call
5	OD	Off Duty

6.1.4.1. Communication Route Conceptual Data Model

6.1.4.2. Communication Route Physical Data Model

Links the contact method to a party, vehicle, activity or pod record

Data Entity – communication_route		Mid level - sub data set					Identifies how a party should be contacted
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
communication_route_id	integer	Y	Y	N			Unique ID
communication_method_id	integer	N	N	Y	communication_method_id	Mandatory
communication_route_description	text	N	N	N		Optional	A descriptor of the communication method
communication_route_restriction	char(1)	N	N	N		Mandatory	Identifies if the the current communication method can be made public
communication_route_in_use	char(1)	N	N	N		Mandatory	Identifies if the the current communication method in is use
Party_id	integer	N	N	Y	Party_id	Optional	One of
Activity_id	integer	N	N	Y	Activity_id	Optional	One of
Vehicle_id	integer	N	N	Y	Vehicle_id	Optional	One of
Pod_id	integer	N	N	Y	Pod_id	Optional	One of
Contact_preference	Tinyint	N	N	N		Mandatory	Used to define the contact method sequence where more than one contact is recorded against a party, activity or vehicle recorded as a number (1),(2),(3)……… (1) being the highest preference at that point in time (2) being the fallback communication route should (1) not be contactable and so on.

6.1.4.3. Communication Method

Provides the communication methods for the Party Data Model

Data Entity – communication_method		Mid level - sub data set					Provides the reference activity types for the data model
Data Attribute	Data Type	Primary Key	Unique Record	Foreign Key	FK linked to	Mandatory / Optional	Data Dictionary Description
communication_method_id	integer	Y	N	N		Mandatory
communication_method_type_id	integer	N	N	Y			Communication Method Types Reference Data
communication_method_description	text	N	N	N		Optional	A descriptor of the communication method
communication_method_restriction	char(1)	N	N	N		Mandatory
communication_method_in_use	char(1)	N	N	N		Mandatory	Identifies the current communication method for the activity
Communication_method_detail	Vchar(40)	N	N	N		Mandatory	Where communication_method_type_id is one of Phone, email, Radio or pager then a validity check / mask is used to match the communication_method_type recorded, these are – Email – From IETF RFC2822: An email address is a specific Internet identifier that contains a locally interpreted string followed by the at-sign character ("@", ASCII value 64) followed by an Internet domain. The locally interpreted string is either a quoted-string or a dot-atom. Comments and enfolding white space SHOULD NOT be used around the "@" in the email address. (i.e. no space characters either side of the @ character)The domain portion identifies the point to which the mail is delivered. The local-part portion is a domain dependent string. In addresses, it is simply interpreted on the particular host as a name of a particular mailbox. Phone - defined in the e-gif standard as The complete telephone number should always be transferred for international operation and clarity as to which country ( in this case UK) the number belongs.E.g. +447710287657 . Note no leading zero after country code. Airwave Radio = Individual Short Subscriber Identity – (Identity number for a terminal) ISSI Number format 6 digit number Pager – The Radio Identity Code (RIC) TomTom – The devices serial number
Communication_
Communication

6.1.4.3.1. Communication Method Types Reference Data

Identifies the types of communication methods allowed within FiReDMX

communication_method_type_id	communication_name	definition
1	Home - Landline	Telephone number used for contact at a parties home address
2	Work - Landline	Telephone number used for contact at a parties work address
3	Mobile - Work	A business issued mobile phone for a party to use on behalf of an organisation
4	Mobile - Personal	A personal mobile phone for a party to use on behalf of an organisation or for emergency contact
5	Email - Work	A business mail contact phone for a party to use on behalf of an organisation or for emergency contact
6	Email - Home	A personal email contact phone for a party to use on behalf of an organisation or for emergency contact
7	Pager
8	Radio
9	TomTom