Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kara cleanup #11

Merged
merged 25 commits into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,26 @@

# FHIR PIT

FHIR Patient data Integration Tool (FHIR PIT) is an open-source tool that uses geocodes and time stamps of varying spatiotemporal resolution to integrate clinical data with environmental exposures data from multiple public sources before stripping the data of Protected Health Information (including geocodes and time stamps) and binning feature variables to create ICEES integrated feature tables. FHIR PIT is modular and extensible and can be adapted for virtually any type of data that requires geocodes and dates for integration with Personally Identifiable Information.

FHIR PIT was inspired by and currently supports the [Integrated Clinical and Environmental Exposures Service (ICEES)](https://pubmed.ncbi.nlm.nih.gov/31077269/). The tool was motivated by a need to integrate diverse sources of environmental exposures data with electronic health record (EHR) data at the patient level, effectively embedding estimates of environmental exposures such as airborne pollutant exposures within the EHR. ICEES has proven utility as an open-source tool for exploratory analysis of integrated clinical and environmental exposures data, with diverse use-case applications, including asthma and related common pulmonary disorders, primary ciliary dyskinesia and related rare pulmonary disorders, drug-induced liver injury, and coronavirus infection. ICEES is also an integral component of the [Biomedical Data Translator ("Translator") System](https://ncats.nih.gov/research/research-activities/translator/about), funded by the National Center for Advancing Translational Sciences. For additional information on ICEES, including peer-reviewed publications, please see https://github.com/NCATSTranslator/Translator-All/wiki/ICEES.

FHIR PIT (Patient data Integration Tool) uses geocodes and time stamps of varying resolution (e.g., hour, year) to integrate the clinical data with environmental exposures data from multiple sources before stripping the data of PHI (including the geocodes and time stamps) and binning feature variables to create ICEES tables. Of note, FHIR PIT is modular and extensible and can be adapted for virtually any type of data that requires geocodes and dates for integration with PII.
FHIR PIT consists of several transformation steps, which are building blocks that can be chained together or combined in parallel to form a transformation workflow. In addition, several of these transformation steps are generic such that they can take in any data that conform to a certain format. Adding new types of data amounts to adding new transformation steps or reusing generic steps.

FHIR PIT is implemented using Apache Spark, Python, and Singularity. Spark makes it easy to parallelize and distribute the data transformation. Python is used to simplify the application interface to the transformation steps. Singularity allows us to easily make the application run portably on different machines and platforms.

FHIR PIT consists of several transformation steps which are building blocks that can be chained together or combined in parallel to form a transformation workflow. In addition, several of these transformation steps are generic such that they can take in any data that conform to certain format. Adding new types of data amounts to adding new transformation steps or reusing generic steps.
For details regarding how to build and run FHIR PIT with sample data, refer to https://github.com/ExposuresProvider/FHIR-PIT/tree/demo-updated/spark.

For additional information on FHIR PIT, including an example use-case application, please see [Xu et al. 2020](https://bmcmedinformdecismak.biomedcentral.com/articles/10.1186/s12911-020-1056-9).

FHIR PIT is implemented using Apache Spark, Python, and Singularity. Spark makes it easy to parallelize and distribute the data transformation. Python is used to simplify the application interface to the transformation steps. Singularity allows us to easily make the application run on different machines and platforms portably.
Issues are welcome! We will work to resolve any issues as quickly as possible.

For details regarding how to build and run FHIR-PIT with sample data, refer to [this link](https://github.com/ExposuresProvider/FHIR-PIT/tree/demo-updated/spark).
# Funding Support

FHIR PIT is funded by the [National Center for Advancing Translational Sciences](https://ncats.nih.gov/), under a US PHS Other Transaction Award (OT2TR003430), with additional funding provided by the [Renaissance Computing Institute](https://renci.org/).

# Suggested Citation

If you use FHIR PIT, we thank you and kindly ask that you consider citing:

Xu H, Cox S, Stillwell L, Pfaff E, Champion J, Ahalt SC, Fecho K. FHIR PIT: an open software application for spatiotemporal integration of clinical data and environmental exposures data. BMC Med Inform Decis Mak. 2020;20(1):53. Published 2020 Mar 11. doi:10.1186/s12911-020-1056-9.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading