Locations Hierarchy CSV API
Covered by this topic
The following page defines data and fields that may be imported into MIE systems (WebChart, Enterprise Health) using the Locations Hierarchy CSV API.
The Locations Hierarchy is defined as a hierarchy that structures locations, such as establishment, clinical locations, outside locations, and work locations, in parent-child relationships. This CSV API is intended for populating locations for usage of workflows or features involving OSHA reporting, incident/case management, and/or for a client’s locations interface.
Audience
The abstract that follows should be presented to decision-makers or stakeholders interested in a general explanation of the Locations Hierarchy CSV API. Technical details are provided in the remaining sections.
Abstract
Locations hierarchy is typically used in the context of OSHA reporting, incident/case management, and locations interface. The Locations Hierarchy CSV API is used to import information related to a specific location and/or the relationships between said location. Locations can be differentiated by type, such as establishment, outside location, clinic location, and work location.
Use cases for different locations include the following:
- Establishment - the top-level organization.
- Clinic location - specific clinical facility (e.g. primary care clinic, testing clinic).
- Work location - place of employment.
- Outside location - non-clinical external location where services are provided.
Workflow Considerations
What columns do I need to populate to define specific locations (establishment, clinic, outside, and/or work location)?
In the file, the following criteria is used to define specific types of locations:
- Establishment locations -
establishment_flagshould be set to 1, else 0 - Clinic locations -
clinical_location_flagshould be set to 1, else 0 - Outside locations -
outside_location_flagshould be set to 1, else 0 - Work locations -
work_location_flagshould be set to 1, else 0
How can I create parent-child relationships for different hierarchies in the file?
If there is either an existing location code or a code that exists in the file concurrently with their child location, the locations_hierarchy_parent_code column is used to populate the location’s code.
Column Definition
The locations hierarchy column definition shall contain all columns listed below regardless of whether there is a value or not:
- R = required
- O = optional
| Column Name | Type | Required | Comments |
| locations_code | varchar(10) | R | |
| locations_description | varchar(60) | R | |
| locations_acronym | varchar(30) | O | |
| locations_place_of_service_code | varchar(8) | O | Default is 11 |
| locations_alias | varchar(255) | O | |
| locations_address1 | varchar(50) | O | |
| locations_address2 | varchar(50) | O | |
| locations_address3 | varchar(50) | O | Locations will include address3 with address2, patients will have a separate address3 field |
| locations_city | varchar(30) | O | |
| locations_county | varchar(50) | O | |
| locations_state | varchar(4) | O | |
| locations_postal_code | varchar(11) | O | |
| locations_country | varchar(50) | O | |
| locations_tz_name | varchar(64) | O | |
| locations_phone_number | varchar(30) | O | |
| locations_fax_number | varchar(30) | O | |
| locations_account_number | varchar(30) | O | |
| pev_naics_description | varchar(100) | O | Conditionally required if there is |
| pev_location_naics | int(10) | O | Default is 0 |
| pev_location_sic | int(10) | O | Default is 0 |
| pev_total_employees | int(10) | O | Default is 0 |
| pev_total_hours | int(10) | O | Default is 0 |
| locations_active | tinyint(3) | O | Default is 1 |
| establishment_flag | tinyint(3) | R | |
| clinical_location_flag | tinyint(3) | O | Default is 0 |
| work_location_flag | tinyint(3) | O | Default is 0 |
| outside_location_flag | tinyint(3) | O | Default is 0 |
| org_level | varchar(30) | O | |
| locations_act_date | datetime | O | |
| locations_deact_date | datetime | O | |
| site_safety_rep | varchar(30) | O | |
| site_safety_rep_type | varchar(20) | O | Default is `part:MR` |
| locations_hierarchy_parent_code | varchar(30) | O | |
| related_to_pat_id | int(10) | O |
.
Enterprise Health Documentation
Last Updated:
Last Build:
Mon, 08 Dec 2025 20:24:09 UTC
WikiGDrive Version: v2.15.30