Civic Location Module

FAQ | Cheat Sheet | Specification | Incident Modules | Shared Modules | Type Values | Terminology

 

Civic Location Module

Overview

  

Alternative Views

View	Description
Data Dictionary	Data dictionary details on the data, types.
Examples	Examples of the data, and how to use it.

    

All Fields in Module

All of the fields in the module, presented together.

Field / Group	Type	Description
nl_structure, cldxf_named_location	Text	A built feature which has a vertical dimension, including both conventional buildings which have walls, doors, and a roof, and other kinds of infrastructure such as cell towers, transformer stations, fuel tanks, and so on.
nl_subsite, cldxf_named_location	Text	Name of a sub-area within a larger area specified either by site name, by a thoroughfare address, or both.
nl_site, cldxf_named_location	Text	Name of an exterior area which is publicly known and unique within a given place. A site may contain one or more structures and/or sub-sites.
nl_wing, cldxf_named_location	Text	Designated part of a structure which spans one or many floors, typically including more than one unit or room and representing a significant portion of the structure floor area.
nl_floor, cldxf_named_location	Text	Standardized identifier for a story or level within a structure, wing, or unit.
nl_unit_pre_type, cldxf_named_location	Text	Part of the complete unit identifier that precedes the Unit Value and indicates the kind of unit.
nl_unit_value, cldxf_named_location	Text	Part of the complete unit identifier that uniquely identifies a particular unit.
nl_room, cldxf_named_location	Text	Single, distinctly identified, enclosed space within a structure.
nl_section, cldxf_named_location	Text	Identified, unenclosed area within a structure, wing, unit, or room.
nl_row, cldxf_named_location	Text	Identified linear feature, such as a linear arrangement of seats, workstations, equipment, or storage, within a structure, wing, unit, or room.
nl_seat, cldxf_named_location	Text	Identified seat, desk, workstation, or similar precise location within a structure, wing, unit, room, section, or row.
nl_additional_info, cldxf_named_location	Text	Information that relates to location but does not meet the definition of any other named location elements.
nl_marker, cldxf_named_location	Text	Uniquely identified and indivisible infrastructure component, smaller than a structure, which exists either within a structure or exterior to any structure, such as an alarm box, a utility pole, a callbox, or other similar feature.
an_prefix, cldxf_address_number	Text	Identifier in the portion of the complete address number that precedes the integer Address Number in order to further specify a location along a thoroughfare or within a defined area.
an_number, cldxf_address_number	Integer	Integer identifier of a location along a thoroughfare or within a defined community.
an_suffix, cldxf_address_number	Text	Identifier in the portion of the complete address number that follows the integer Address Number in order to further specify a location along a thoroughfare or within a defined area.
an_complete, cldxf_address_number	Text	Address Number Complete includes the Address Number Prefix (if any), the Address Number, Address Number Suffix (if any), and any formatting or separator characters needed to display the official version of the complete address number. The Address Number Complete precedes the complete street name to identify a location along a thoroughfare or within a defined area.
an_distance_marker, cldxf_address_number	Text	Distance travelled along a route such as a road or highway, indicated by a distance marker sign, typically a post or other marker indicating the distance in miles/kilometers from or to a given point.
sn_pre_modifier, cldxf_street_name	Text	Word or phrase that precedes and modifies the Street Name element but is separated from it by a Street Name Pre Type or a Street Name Pre Directional or both.
sn_pre_dir, cldxf_street_name	Text	Word preceding the Street Name element that indicates the direction taken by the street from an arbitrary starting point or line, or the sector where it is located.
sn_pre_type, cldxf_street_name	Text	Word or phrase that precedes the Street Name element and identifies a type of thoroughfare in a complete street name.
sn_pre_type_separator, cldxf_street_name	Text	Preposition or prepositional phrase between the Street Name Pre Type and the Street Name.
sn_street_name, cldxf_street_name	Text	Element of the complete street name that identifies the particular street (as opposed to any street types, directionals, and modifiers).
sn_post_type, cldxf_street_name	Text	Word or phrase that follows the Street Name element and identifies a type of thoroughfare in a complete street name.
sn_post_directional, cldxf_street_name	Text	Word following the Street Name element that indicates the direction taken by the street from an arbitrary starting point or line, or the sector where it is located.
sn_post_modifier, cldxf_street_name	Text	Word or phrase that follows and modifies the Street Name element and is either separated from it by a Street Name Post Type and/or a Street Name Post Directional.
sn_dir_of_travel, cldxf_street_name	Text	Word which follows all other street name elements and is used only as needed to indicate direction of travel on a divided roadway and associated frontage roads.
csop_postal_comm, cldxf_country_state_and_other_place_name	Text	City name for the ZIP Code of an address, as given in the USPS City State file.
csop_neighborhood_comm, cldxf_country_state_and_other_place_name	Text	Name of an unincorporated neighborhood, subdivision or area, either within an incorporated municipality, or in an unincorporated portion of a county or both, where the address is located.
csop_unincorporated_comm, cldxf_country_state_and_other_place_name	Text	Name of an unincorporated community, either within an incorporated municipality or in an unincorporated portion of a county, or both, where the address is located.
csop_incorporated_muni, cldxf_country_state_and_other_place_name	Text	Name of the incorporated municipality or other general-purpose local governmental unit (if any) where the address is located.
csop_county, cldxf_country_state_and_other_place_name	Text	Name of the county or county-equivalent where the address is located. A county (or its equivalent) is the primary legal division of a state or territory.
csop_state, cldxf_country_state_and_other_place_name	Text	Name of a state or state equivalent, represented by the two- letter UPPER CASE abbreviation given in USPS Publication 28 [15], Appendix B. A state is a primary governmental division of the United States.
csop_postal_code, cldxf_country_state_and_other_place_name	Text	System of 5-digit codes that identifies the individual USPS Post Office or metropolitan area delivery station associated with an address.
csop_postal_code_ext, cldxf_country_state_and_other_place_name	Text	System of 4-digit codes that are used after the 5-digit ZIP Code to specify a range of USPS delivery addresses.
csop_country, cldxf_country_state_and_other_place_name	Text	Name of a country represented by its two-letter ISO 3166-1[14] English country alpha-2 code elements in UPPER CASE letters.
place, cldxf_address_descriptor	Text	Type of feature identified by the address.
additional_attributes, neris_addition	JSONB	JSON string of structure address elements which the transmitter wishes to include.
cross_street, neris_addition.cross_street	Array[Array[Text, Text]]	Array of (Street name + optional address number) for the nearest intersection.
type_cross_street, neris_addition.cross_street	Array[Text]	Modifier of the cross street, such as ‘nearest’ or ‘second nearest’

  

Module Fields by Group

The same fields as above, but presented in groups.

cldxf_named_location

Field	Description
nl_structure	A built feature which has a vertical dimension, including both conventional buildings which have walls, doors, and a roof, and other kinds of infrastructure such as cell towers, transformer stations, fuel tanks, and so on.
nl_subsite	Name of a sub-area within a larger area specified either by site name, by a thoroughfare address, or both.
nl_site	Name of an exterior area which is publicly known and unique within a given place. A site may contain one or more structures and/or sub-sites.
nl_wing	Designated part of a structure which spans one or many floors, typically including more than one unit or room and representing a significant portion of the structure floor area.
nl_floor	Standardized identifier for a story or level within a structure, wing, or unit.
nl_unit_pre_type	Part of the complete unit identifier that precedes the Unit Value and indicates the kind of unit.
nl_unit_value	Part of the complete unit identifier that uniquely identifies a particular unit.
nl_room	Single, distinctly identified, enclosed space within a structure.
nl_section	Identified, unenclosed area within a structure, wing, unit, or room.
nl_row	Identified linear feature, such as a linear arrangement of seats, workstations, equipment, or storage, within a structure, wing, unit, or room.
nl_seat	Identified seat, desk, workstation, or similar precise location within a structure, wing, unit, room, section, or row.
nl_additional_info	Information that relates to location but does not meet the definition of any other named location elements.
nl_marker	Uniquely identified and indivisible infrastructure component, smaller than a structure, which exists either within a structure or exterior to any structure, such as an alarm box, a utility pole, a callbox, or other similar feature.

cldxf_address_number

Field	Description
an_prefix	Identifier in the portion of the complete address number that precedes the integer Address Number in order to further specify a location along a thoroughfare or within a defined area.
an_number	Integer identifier of a location along a thoroughfare or within a defined community.
an_suffix	Identifier in the portion of the complete address number that follows the integer Address Number in order to further specify a location along a thoroughfare or within a defined area.
an_complete	Address Number Complete includes the Address Number Prefix (if any), the Address Number, Address Number Suffix (if any), and any formatting or separator characters needed to display the official version of the complete address number. The Address Number Complete precedes the complete street name to identify a location along a thoroughfare or within a defined area.
an_distance_marker	Distance travelled along a route such as a road or highway, indicated by a distance marker sign, typically a post or other marker indicating the distance in miles/kilometers from or to a given point.

cldxf_street_name

Field	Description
sn_pre_modifier	Word or phrase that precedes and modifies the Street Name element but is separated from it by a Street Name Pre Type or a Street Name Pre Directional or both.
sn_pre_dir	Word preceding the Street Name element that indicates the direction taken by the street from an arbitrary starting point or line, or the sector where it is located.
sn_pre_type	Word or phrase that precedes the Street Name element and identifies a type of thoroughfare in a complete street name.
sn_pre_type_separator	Preposition or prepositional phrase between the Street Name Pre Type and the Street Name.
sn_street_name	Element of the complete street name that identifies the particular street (as opposed to any street types, directionals, and modifiers).
sn_post_type	Word or phrase that follows the Street Name element and identifies a type of thoroughfare in a complete street name.
sn_post_directional	Word following the Street Name element that indicates the direction taken by the street from an arbitrary starting point or line, or the sector where it is located.
sn_post_modifier	Word or phrase that follows and modifies the Street Name element and is either separated from it by a Street Name Post Type and/or a Street Name Post Directional.
sn_dir_of_travel	Word which follows all other street name elements and is used only as needed to indicate direction of travel on a divided roadway and associated frontage roads.

cldxf_country_state_and_other_place_name

Field	Description
csop_postal_comm	City name for the ZIP Code of an address, as given in the USPS City State file.
csop_neighborhood_comm	Name of an unincorporated neighborhood, subdivision or area, either within an incorporated municipality, or in an unincorporated portion of a county or both, where the address is located.
csop_unincorporated_comm	Name of an unincorporated community, either within an incorporated municipality or in an unincorporated portion of a county, or both, where the address is located.
csop_incorporated_muni	Name of the incorporated municipality or other general-purpose local governmental unit (if any) where the address is located.
csop_county	Name of the county or county-equivalent where the address is located. A county (or its equivalent) is the primary legal division of a state or territory.
csop_state	Name of a state or state equivalent, represented by the two- letter UPPER CASE abbreviation given in USPS Publication 28 [15], Appendix B. A state is a primary governmental division of the United States.
csop_postal_code	System of 5-digit codes that identifies the individual USPS Post Office or metropolitan area delivery station associated with an address.
csop_postal_code_ext	System of 4-digit codes that are used after the 5-digit ZIP Code to specify a range of USPS delivery addresses.
csop_country	Name of a country represented by its two-letter ISO 3166-1[14] English country alpha-2 code elements in UPPER CASE letters.

cldxf_address_descriptor

Field	Description
place	Type of feature identified by the address.

neris_addition

Field	Description
additional_attributes	JSON string of structure address elements which the transmitter wishes to include.

neris_addition.cross_street

Field	Description
cross_street	Array of (Street name + optional address number) for the nearest intersection.
type_cross_street	Modifier of the cross street, such as ‘nearest’ or ‘second nearest’

  

Need more NERIS help?

Need more help with NERIS, or not yet found what you are looking for? Please see if these help …