Locations Hierarchy CSV API

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_flag should be set to 1, else 0
  • Clinic locations - clinical_location_flag should be set to 1, else 0
  • Outside locations - outside_location_flag should be set to 1, else 0
  • Work locations - work_location_flag should 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 NameTypeRequiredComments
locations_codevarchar(10)R
locations_descriptionvarchar(60)R
locations_acronymvarchar(30)O
locations_place_of_service_codevarchar(8)ODefault is 11
locations_aliasvarchar(255)O
locations_address1varchar(50)O
locations_address2varchar(50)O
locations_address3varchar(50)OLocations will include address3 with address2,
patients will have a separate address3 field
locations_cityvarchar(30)O
locations_countyvarchar(50)O
locations_statevarchar(4)O
locations_postal_codevarchar(11)O
locations_countryvarchar(50)O
locations_tz_namevarchar(64)O
locations_phone_numbervarchar(30)O
locations_fax_numbervarchar(30)O
locations_account_numbervarchar(30)O
pev_naics_descriptionvarchar(100)OConditionally required if there is
pev_location_naicsint(10)ODefault is 0
pev_location_sicint(10)ODefault is 0
pev_total_employeesint(10)ODefault is 0
pev_total_hoursint(10)ODefault is 0
locations_activetinyint(3)ODefault is 1
establishment_flagtinyint(3)R
clinical_location_flagtinyint(3)ODefault is 0
work_location_flagtinyint(3)ODefault is 0
outside_location_flagtinyint(3)ODefault is 0
org_levelvarchar(30)O
locations_act_datedatetimeO
locations_deact_datedatetimeO
site_safety_repvarchar(30)O
site_safety_rep_typevarchar(20)ODefault is `part:MR`
locations_hierarchy_parent_codevarchar(30)O
related_to_pat_idint(10)O

.


Enterprise Health Documentation

Last Updated:

Last Build: Mon, 08 Dec 2025 20:24:09 UTC
WikiGDrive Version: v2.15.30