NERIS Technical References

This page provides technical resources for working with NERIS, including data schemas, API documentation, integration requirements, and supporting tools. It is designed for fire departments, developers, and partners who need detailed reference materials to interact with the platform.

Technical References

NERIS Data Schemas

The NERIS data schemas exist as two sets of elements. The first is the NERIS Core Schema. The core schema establish the data elements that define a fire department entity as well the data elements that define an incident dispatch and response. These schema are available for download in XLSX format here: [Core NERIS Schemas - xlsx]

The secondary set of NERIS schemas includes three focus areas: incident analysis, community risk reduction (CRR), and health and wellness. These schemas are also available in XLSX format here: [Secondary NERIS Schemas - xlsx]

Both sets of schemas are also available in our public Github as yml files and csv files. Github can be accessed [here].

Note: No matter what format you access the schemas in, the overall structure is the same. The schemas are composed of module files, which establish the questions being asked within NERIS, and type files which set the applicable choice selections for the respective questions. A underlying goal of the NERIS structure is to leverage choice selections to minimize free text entry and to minimize the number of available choices in a selection list.

NERIS Developer Resources

For vendors developing 3rd party software to integrate with NERIS, the latest API documentation can be found here: [Swagger UI]. The API is built in python utilizing the FastAPI specification. For those who are interested, a NERIS API client was built in python can be found here: [pypi package] with the source code here: [API Client Repo]

A DRAFT version of the NERIS Technical Reference Guide can be found here: [Draft Technical Guide]

NERIS Data Exchange Capability

For vendors to connect to the NERIS platform, their software must be able to meet a baseline set of technical requirements for secure data transfer utilizing the NERIS API. The technical requirements include:

• Request a [vendor account] and create an integration (Client ID / Client Secret). Select Create Vendor Account.
• Submit an [enrollment] to the FSRI Fire Department. Select Request Enrollment for NERIS Compatibility Badge.
• Create a valid incident from that integration connection.
• Using the UID of the submitted record submit an update to the record.
• Create a new station in the FSRI Fire Department
• Add a unit to that created station.
• Submit a [request] to check compatibility. Select Request Compatibility Check.

Software that meet these technical requirements are considered to be Version 1 Data Exchange Compatible.

Data Dictionary

To support users and developers working with core schemas, the NERIS data dictionary provides definitions for the terms as well as their supporting choice lists (e.g. enumerated values). The data dictionary can be found here: [Data Dictionary].

Additional Resources

• [NERIS FAQs]
• [NERIS Helpdesk]
• [NERIS Training Videos]