Skip to main content

FHIR PIT: an open software application for spatiotemporal integration of clinical data and environmental exposures data



Informatics tools to support the integration and subsequent interrogation of spatiotemporal data such as clinical data and environmental exposures data are lacking. Such tools are needed to support research in environmental health and any biomedical field that is challenged by the need for integrated spatiotemporal data to examine individual-level determinants of health and disease.


We have developed an open-source software application—FHIR PIT (Health Level 7 Fast Healthcare Interoperability Resources Patient data Integration Tool)—to enable studies on the impact of individual-level environmental exposures on health and disease. FHIR PIT was motivated by the need to integrate patient data derived from our institution’s clinical warehouse with a variety of public data sources on environmental exposures and then openly expose the data via ICEES (Integrated Clinical and Environmental Exposures Service). FHIR PIT consists of transformation steps or building blocks that can be chained together to form a transformation and integration workflow. Several transformation steps are generic and thus can be reused. As such, new types of data can be incorporated into the modular FHIR PIT pipeline by simply reusing generic steps or adding new ones. We validated FHIR PIT in the context of a driving use case designed to investigate the impact of airborne pollutant exposures on asthma. Specifically, we replicated published findings demonstrating racial disparities in the impact of airborne pollutants on asthma exacerbations.


While FHIR PIT was developed to support our driving use case on asthma, the software can be used to integrate any type and number of spatiotemporal data sources at a level of granularity that enables individual-level study. We expect FHIR PIT to facilitate research in environmental health and numerous other biomedical disciplines.

Peer Review reports


Researchers and healthcare practitioners across fields of biomedicine acknowledge the tremendous impact that environmental exposures have on health and disease. For example, airborne pollutant exposures have been linked to diseases as diverse as asthma [1,2,3,4,5,6], diabetes [7,8,9], cardiovascular disease [10], dementia [11], mental health disorders [12], obesity [13], liver disease [14], and premature mortality [15]. Yet, informatics tools to study the interaction between environmental exposures and health outcomes at the level of the individual are largely non-existent. For instance, the fields of epidemiology and environmental health focus primarily on population-based correlations between trends in spatiotemporal exposures and population-level health outcomes [15]. Longitudinal clinical studies likewise are limited in their ability to collect subject-level data on environmental exposures, typically relying on survey-based self-report [5] or expensive personal monitors [6]. Electronic health record (EHR)–based research also is limited because such records do not contain data on environmental exposures apart from basic demographics.

Herein, we present FHIR PIT (Health Level 7 Fast Healthcare Interoperability Resources Patient data Integration Tool) as an open-source software application designed to overcome challenges in environmental health research and related fields and provide an innovative solution to enable investigation into the impact of individual-level environmental exposures on health and disease.


This work was conducted under a study protocol that was approved by the Institutional Review Board at the University of North Carolina at Chapel Hill.


FHIR PIT is a complex, custom, open-source software application that uses geocodes and time stamps of varying resolution (e.g., hour, day, year) to automatically integrate multiple sources of spatiotemporal data, irrespective of the degree to which the data depend on space and time. FHIR PIT was motivated by our research and development of the Integrated Clinical and Environmental Exposures Service [ICEES [16]. ICEES was developed as part of the Biomedical Data Translator program in response to a need to openly expose clinical data that have been integrated at the patient and visit level with environmental exposures data [17, 18]. FHIR PIT provides the integrated clinical and environmental exposures data to support ICEES.

Implementation overview and spatiotemporal data sources

For initial research and development of FHIR PIT, clinical data on patients from UNC Health Care System were integrated with a variety of public data on environmental exposures, including: airborne pollutant exposures from the US Environmental Protection Agency; roadway exposures from the Federal Highway Administration’s Highway Patrol Monitoring System, within the US Department of Transportation; roadway exposures from the US Census Bureau’s Topologically Integrated Geographic Encoding and Referencing system; and socio-environmental exposures from the US Census Bureau’s American Community Survey. (A graphical overview of the FHIR PIT integration pipeline can be found in Fig. 1. A list of currently available feature variables can be found in Supplementary Table 1. This table and additional documentation are maintained and regularly updated on the ICEES OpenAPI.) Importantly, the integration step is conducted within a secure environment and under a protocol that was approved by our institution’s Institutional Review Board because data integration necessitates the use of patient geocodes (i.e., primary home residence), date/time stamps, and patient identifiers—data elements that are considered Protected Health Information under the Health Insurance Portability and Accountability Act (HIPAA).

Fig. 1
figure 1

An overview of the integration steps embedded in the FHIR PIT software application pipeline. API = application programming interface; FHIR = Health Level 7 Fast Healthcare Interoperability Resources; ICEES = Integrated Clinical and Environmental Exposures Service; UI = user interface; US Census ACS = US Census Bureau’s American Community Survey; US Census Bureau TIGER = US Census Bureau’s Topologically Integrated Geographic Encoding and Referencing system; US EPA conUS CMAQ = US Environmental Protection Agency’s conUS Community Multiscale Air Quality modeling data; US DOT FHWA HPMS = US Department of Transportation, Federal Highway Administration, Highway Patrol Monitoring System. Red color = sensitive, fully identified clinical data; dark blue color = public data on environmental exposures; light blue color = secure, firewall- and Institutional Review Board–protected integration steps; dark green color = de-identified, binned integrated feature tables; light green color = ICEES OpenAPI. (Note that data from the National Center for Education Statistics have not yet been integrated using FHIR PIT, but an approach is under development to integrate data on school exposures with home exposures data and clinical data, thereby addressing issues related to patient mobility and differential exposures. A simplified version of the FHIR PIT pipeline was published in JAMIA 2019;26(1):1064–1073 and is reprinted in adapted form here with full permission from the publisher. In contrast to the simplified version of the FHIR PIT pipeline, the version shown here includes and clearly distinguishes all of the data sources and integration steps that are assembled by the current version of the pipeline.)

Multiple integration steps are required to harmonize across these data sources, which vary in spatiotemporal resolution and format of geocodes and time stamps. For example, patient primary home residence is coded as latitude and longitude in the patient data, whereas the American Community Survey data are provided at the Census block level. Airborne pollutant exposures are available at hourly estimates, daily estimates, or annual averages, depending on the exposure entity and source year. Roadway data are provided as GIS shape files, with latitudes and longitudes in WGS84 decimal format, which is the World Geodetic System for expressing latitude and longitude. Separate software code is required to convert the spatiotemporal representation of the data used by each data source into a common format that allows integration across data sources. In addition, separate mappings are required to link patient identifiers and geocodes with each non-clinical data source, thereby supporting the final integration step that merges the different data sources.

The final product of the FHIR PIT software pipeline is a set of “integrated feature tables”, with feature variables binned or recoded and data de-identified according to §164.514(b) of HIPAA for subsequent open access via the ICEES OpenAPI.

Implementation details

FHIR PIT consists of several transformation steps or building blocks that can be chained together to form a transformation and integration workflow. Several of these transformation steps are generic, such that they can take in any data that conform to a certain format. Thus, the incorporation of new types of data amounts to adding new transformation steps or reusing generic steps. FHIR PIT is implemented using Apache Spark. Spark is used to easily parallelize and distribute the data transformation steps. A Python script is used to simplify the application interface to the transformation steps. FHIR PIT supports building containers in both Singularity and Docker. This feature allows the application to run on different machines and platforms with portability.

Each block in FHIR PIT is implemented as a plugin consisting of a set of Scala classes that can be plugged into the pipeline. FHIR PIT is configured using a YAML file, and steps can be switched on or off for rapid re-execution of the pipeline. The plugins consist of both generic building blocks such as joining of tables and data set–specific building blocks such as preprocessing of environmental data (Table 1). The input and output of each plugin can be configured so that the output of the previous step in a pipeline configuration can be fed as input for the next step.

Table 1 FHIR PIT plugin names and functionalities

One of our goals for implementation of the pipeline is to enable automatic and rapid re-execution. Given the extensible number of input files and parameters, we use the Dhall configuration language to author configuration files and avoid code duplication. Dhall code is converted to a YAML file that is then read by the pipeline. An example YAML configuration of a step in the FHIR PIT pipeline is provided below, with fields defined in Table 2.

Table 2 FHIR PIT field names and functionality
figure a

Writing the entire FHIR PIT pipeline configuration in YAML would necessitate rewriting the pipeline for every new calendar year and every new data set. With Dhall, we are able to create a function in the configuration that can be instantiated for each new calendar year or data set. A simplified version of this function to address additional years is shown below.

figure b

To instantiate this for calendar year 2012, we simply need to specify the following parameter:

envDataSourceStep False "2012"

To extend this function for multiple calendar years, we specify an additional parameter:

List/map ["2012", "2013", "2014"] (envDataSourceStep False)

Here, the List/map function takes a list of terms and a function, applies the function to each element in the list, and returns a list of values.

Execution of the FHIR PIT pipeline generates a report of skipped tasks, succeeded tasks, failed tasks, and errors from failed tasks.


We validated FHIR PIT in the context of our driving use case for research and development of ICEES: impact of airborne pollutant exposures on asthma. The validation data set consisted of ~ 160,000 patients with “asthma-like” conditions from UNC Health Care System and the environmental data sources depicted in Fig. 1, focusing initially on data from calendar year 2010 [19,20,21]. FHIR PIT was used to integrate the clinical and environmental data and then de-identify the data and bin feature variables before openly exposing the integrated data using ICEES. ICEES was queried using the following input parameters:

figure c

ICEES returned the following JSON output, which is also displayed in graphical form in Fig. 2.

Fig. 2
figure 2

Racial disparities in the impact of airborne pollutant exposures on asthma exacerbations. Sample sizes are: N = 6379 African American patients; and N = 13,176 Caucasian patients. PM2.5 = particulate matter < 2.5-μm in diameter. Levels of PM2.5 exposure were binned in FHIR PIT using pandas qcut and expressed as ranges. X2 = 28.2841, P < 0.0001 for African Americans; X2 = 47.0133, P < 0.0001 for Caucasians

figure d

These results indicate that the proportion of patients with two or more annual emergency department or inpatient visits for respiratory issues was higher among patients exposed to relatively high average daily levels of particulate matter < 2.5-μm in diameter (PM2.5) than among those exposed to relatively low average daily levels of PM2.5. Moreover, asthma exacerbations, as defined by two or more annual emergency department or inpatient visits for respiratory issues, were more common among African Americans than among Caucasians.

We then examined prednisone use in relation to asthma exacerbations among African Americans and Caucasians. The ICEES query is shown below.

figure e

ICEES returned the following results, which are shown in tabular form in Table 3.

Table 3 Relationship between prednisone use and asthma exacerbations, defined as two or more annual ED or inpatient visits for respiratory issues, among African Americans and Caucasians
figure f

These results indicate that prednisone use was more common among patients with asthma exacerbations than among those without asthma exacerbations, as expected given that prednisone is generally reserved for patients with severe disease [22]. While this finding was true for both African Americans and Caucasian, the effect was more pronounced among African Americans than among Caucasians.

In sum, we successfully applied FHIR PIT to integrate clinical and environmental data and then openly expose the data for interrogation via ICEES, thereby replicating and extending published literature demonstrating the impact of exposure to airborne particulate matter on asthma (e.g., 4) and the existence of racial disparities in asthma exacerbations [23].


We developed FHIR PIT as an open-source spatiotemporal data integration tool. We are currently using FHIR PIT to generate integrated clinical and environmental data for open exposure and interrogation via ICEES. While FHIR PIT was developed and validated in the context of a driving use case designed to evaluate the impact of airborne pollutant exposures on asthma, the software application has broad applicability in any use case that requires integrated spatiotemporal data for individual-level analysis. Indeed, we are currently extending FHIR PIT to support investigations into the impact of environmental exposures on primary ciliary dyskinesia, drug-induced liver injury, and several additional conditions. We believe that FHIR PIT will facilitate research in environmental health and many other biomedical disciplines.

FHIR PIT is under active development, with new data types and sources planned for the use cases noted above and others. The modular design of FHIR PIT will allow us to rapidly adapt the pipeline for these new data types and sources and automatically execute the pipeline to generate new ICEES integrated feature tables, thus providing flexibility and extensibility. These features will facilitate the adoption and adaptation of FHIR PIT for use in other applications and at other institutions.

Availability and requirements

  • Project name: FHIR PIT

  • Project home page: Software code and instructions for downloading FHIR PIT can be found at:

  • Operating system(s): Linux

  • Programming language: Scala, Python

  • Other requirements: Java 8 or higher

  • License: MIT

  • Any restrictions to use by non-academics: none

Availability of data and materials

The data that were used to validate FHIR PIT are openly available via ICEES at



Application programming interface


Emergency department


HL7 Health Level 7 Healthcare Interoperability Resources


Health Level 7 Fast Healthcare Interoperability Resources Patient data Integration Tool


Integrated Clinical and Environmental Exposures Service

PM2.5 :

particulate matter < 2.5-μm in diameter


User interface

US Census ACS:

US Census Bureau’s American Community Survey

US Census Bureau TIGER:

US Census Bureau’s Topologically Integrated Geographic Encoding and Referencing system


US Department of Transportation, Federal Highway Administration, Highway Patrol Monitoring System


US Environmental Protection Agency’s conUS Community Multiscale Air Quality modeling data


  1. Delfino RJ, Coate BD, Zeiger RS, Seltzer JM, Street DH, Koutrakis P. Daily asthma severity in relation to personal ozone exposure and outdoor fungal spores. Am J Respir Crit Care Med. 1996;154(3 Pt 1):633–41. Available from:

  2. Saha C, Riner ME, Liu G. Individual and neighborhood-level factors in predicting asthma. Arch Pediatr Adolesc Med [Internet]. 2005;159(8):759–63. Available from:

  3. Schildcrout JS, Sheppard L, Lumley T, Slaughter JC, Koenig JQ, Shapiro GG. Ambient air pollution and asthma exacerbations in children: an eight-city analysis. Am J Epidemiol. 2006;164(6):505–17. Available from:

  4. Mirabelli MC, Vaidyanathan A, Flanders WD, Qin X, Garbe P. Outdoor PM2.5, Ambient air temperature, and asthma symptoms in the past 14 days among adults with active asthma. Environ Health Perspect. 2016;124(12):1882–90. Available from:

  5. Schurman SH, Bravo MA, Innes CL, Jackson WB 2nd, McGrath JA, Miranda ML, et al. Toll-like receptor 4 pathway polymorphisms interact with pollution to influence asthma diagnosis and severity. Sci Rep. 2018;8(1):12713. Available from:

  6. Rabinovitch N, Adams CD, Strand M, Koehler K, Volckens J. Within-microenvironment 711 exposure to particulate matter and health effects in children with asthma: a pilot study 712 utilizing real-time personal monitoring with GPS interface. Environ Health. 2016;15(1):96. Available from:

  7. Krämer U, Herder C, Sugiri D, Strassburger K, Schikowski T, Ranft U, et al. Traffic-related air pollution and incident type 2 diabetes: results from the SALIA cohort study. Environ Health Perspect. 2010;118(9):1273–9. Available from:

  8. Weinmayr G, Hennig F, Fuks K, Nonnemacher M, Jakobs H, Möhlenkamp S, et al. Long-term exposure to fine particulate matter and incidence of type 2 diabetes mellitus in a cohort study: effects of total and traffic-specific air pollution. Environ Health. 2015;19:14–53. Available from:

  9. Jagai JS, Krajewski AK, Shaikh S, Lobdell DT, Sargis RM. Association between environmental quality and diabetes in the USA. J Diabetes Investig. 2019; Available from:

  10. Hennig F, Fuks K, Moebus S, Weinmayr G, Memmesheimer M, Jakobs H, et al. Association between source-specific particulate matter air pollution and hs-CRP: local traffic and industrial emissions. Environ Health Perspect. 2014;122(7):703–10. Available from:

  11. Chen H, Kwong JC, Copes R, Tu K, Villeneuve PJ, van Donkelaar A, et al. Living near major roads and the incidence of dementia, Parkinson’s disease, and multiple sclerosis: a population-based cohort study. Lancet. 2017;389(10070):718–26. Available from:.

    Article  PubMed  Google Scholar 

  12. Bernardini F, Attademo L, Trezzi R, Gobbicchi C, Balducci PM, Del Bello V, et al. Air pollutants and daily number of admissions to psychiatric emergency services: evidence for detrimental mental health effects of ozone. Epidemiol Psychiatr Sci. 2019;6:1–7. Available from:

  13. McConnell R, Gilliland FD, Goran M, Allayee H, Hricko A, Mittelman S. Does near-roadway air pollution contribute to childhood obesity? Pediatr Obes. 2016;11:1–3. Available from:

  14. Kim JW, Park S, Lim CW, Lee K, Kim B. The role of air pollutants in initiating liver disease. Toxicol Res. 2014;30:65–70. Available from:

  15. Chang SY, Vizuete W, Serre M, Vennam LP, Omary M, Isakov V, et al. Finely resolved on-road PM 2.5 and estimated premature mortality in central north carolina. Risk Anal. 2017;37(12):2420–34. Available from:

  16. Fecho K, Pfaff E, Xu H, Champion J, Cox S, Stillwell L, et al. A novel approach for exposing and sharing clinical data: the translator integrated clinical and environmental exposures service. J Am Med Inform Assoc. 2019;26(10):1064–73. Available from:

  17. Biomedical Data Translator Consortium. The biomedical data translator program: conception, culture, and community. Clin Transl Sci 2019;12(2):91–94. Available from:

  18. Biomedical Data Translator Consortium. Toward a universal biomedical data translator. Clin Transl Sci 2019;12(2):86–90. Available from:

  19. Ahalt SC, Chute CG, Fecho K, Glusman G, Hadlock J, Taylor CO, et al. Clinical data: sources and types, regulatory constraints, applications. Clin Transl Sci. 2019;12(4):329–33. Available from:

  20. Fecho K, Ahalt SC, Arunachalam S, Champion J, Chute CG, Davis S, et al. Sex, obesity, diabetes, and exposure to particulate matter among patients with severe asthma: Scientific insights from a comparative analysis of open clinical data sources during a five-day hackathon. J Biomed Inform. 2019;100:103325. Available from:

  21. Pfaff ER, Champion J, Bradford RL, Clark M, Xu H, Fecho K, et al. Fast healthcare interoperability resources (FHIR) as a meta model to integrate common data models: development of a tool and quantitative validation study. JMIR Med Inform. 2019;7(4):e15199. Available from:

  22. WebMD Medical Reference. L. Chang, Reviewer. Prednisone and Asthma. July 5, 2018. Available from:

  23. Keet CA, McCormack MC, Pollack CE, Peng RD, McGowan E, Matsui EC. Neighborhood poverty, urban residence, race/ethnicity, and asthma: rethinking the inner-city asthma epidemic. J Allergy Clin Immunol. 2015;135(3):655–62. Available from:

Download references


The authors acknowledge Sarav Arunachalam for provisioning the airborne pollutant exposures data, Stephen Appold for provisioning the socio-environmental exposures data, and Alejandro Valencia Aria for assistance with the roadway exposures data. The authors also acknowledge the clinical expertise provided by David B. Peden. The authors wish to thank Marian Mersmann for proofreading and the Carolina Data Warehouse for Health Oversight Committee at the University of North Carolina at Chapel Hill for their guidance and support of the work described in this manuscript.


This work has been supported by the National Center for Advancing Translational Sciences, National Institutes of Health [grant numbers OT3TR002020, UL1TR002489]. The funder had no role in the design of the study; the collection, analysis, and interpretation of data; or the writing of the manuscript.

Author information

Authors and Affiliations



HX is the lead software designer, developer, and implementer of FHIR PIT; SC, LS, and KF contributed to the design of FHIR PIT; LS contributed expertise on GIS files; EP and JC provisioned the patient data and contributed to the design of FHIR PIT; KF led the validation and analysis of FHIR PIT; SCA provided overall leadership and direction for research and development of FHIR PIT; HX and KF led development of the manuscript and prepared the first draft. All authors reviewed the manuscript, provided critical input, and approved the final submission.

Corresponding author

Correspondence to Karamarie Fecho.

Ethics declarations

Ethics approval and consent to participate

The research described in this manuscript was conducted under a study protocol that was approved by the Institutional Review Board at the University of North Carolina at Chapel Hill with a waiver of informed consent (protocol #16–2978, title “Carolina Biomedical Data Translator”, principal investigator SCA, created November 21, 2016, most recent annual approval received in September 20, 2019).

Consent for publication

Not applicable.

Competing interests

The authors declare that they have no competing interests.

Additional information

Publisher’s Note

Springer Nature remains neutral with regard to jurisdictional claims in published maps and institutional affiliations.

Supplementary information

Additional file 1: Supplementary Table 1.

ICEES integrated feature variable tables (v1.0.0, v2.0.0): variable names, descriptions, and binning strategy.*

Rights and permissions

Open Access This article is distributed under the terms of the Creative Commons Attribution 4.0 International License (, which permits unrestricted use, distribution, and reproduction in any medium, provided you give appropriate credit to the original author(s) and the source, provide a link to the Creative Commons license, and indicate if changes were made. The Creative Commons Public Domain Dedication waiver ( applies to the data made available in this article, unless otherwise stated.

Reprints and Permissions

About this article

Check for updates. Verify currency and authenticity via CrossMark

Cite this article

Xu, H., Cox, S., Stillwell, L. et al. FHIR PIT: an open software application for spatiotemporal integration of clinical data and environmental exposures data. BMC Med Inform Decis Mak 20, 53 (2020).

Download citation

  • Received:

  • Accepted:

  • Published:

  • DOI: