parser/README.md

98 lines
3.8 KiB
Markdown
Raw Normal View History

2020-10-02 03:24:23 +00:00
## About Healthcare/IO Parser
2019-11-06 20:36:32 +00:00
2020-10-02 04:30:55 +00:00
The Healthcare/IO **parser** is an Electronic Data Interchange (EDI) parser developed at Vanderbilt University Medical Center during Khanhly Nguyen's summer internship 2019. Built in a healthcare setting, the parser focuses (for now) on x12 claims (837) and remittances (835)
2019-11-06 20:38:13 +00:00
2019-11-07 07:55:52 +00:00
This code is intended to extract x12 837 and 835 and format them into portable and human readable format (JSON). This allows the claims to be stored in document data stores such as Mongodb, couchdb or databases that have support for JSON like PostgreSQL
2019-11-12 17:51:22 +00:00
We wrote this frame to be used in both command line or as a library within in your code. The framework is driven by configurations that derviced from X12 standards.
2020-10-02 04:30:55 +00:00
## Features
| Features | |
| -------- | --- |
|X12 claims/remits| parsing of {x12} claims/remittances into JSON format with human readible attributes|
|Multi Processing| capable of processing multiple files simultaneously to speed up processing|
|Analytics support| descriptive statistical analytics : distribution, various counts|
|Process Recovery| capable of recovering interrupted runs|
2019-11-06 20:38:13 +00:00
## Installation
2020-10-02 03:24:23 +00:00
pip install --upgrade git+https://hiplab.mc.vanderbilt.edu/git/lab/parse-edi.git
2019-11-06 20:38:13 +00:00
## Usage
2020-10-02 03:24:23 +00:00
**cli :**
2019-11-06 20:38:13 +00:00
2020-10-02 04:30:55 +00:00
1. signup to get parsing configuration
The parser is driven by a configuration file that specifies fields to parse and how to parse them. You need by signing up, to get a copy of the configuration file.
2020-10-02 03:24:23 +00:00
healthcare-io.py --signup <email> [--store <mongo|sqlite>]
2. check version
Occasionally the attributes in the configuration file may change, This function will determine if there is a new version available.
healthcare-io.py --check-update
3. parsing data in a folder
The parser will recursively traverse a directory with claims and or remittances
2020-10-02 04:30:55 +00:00
healthcare-io.py --parse --folder <path> [--batch <n>] [--resume]
2019-11-07 07:40:16 +00:00
2019-11-06 20:38:13 +00:00
with :
2020-10-02 03:24:23 +00:00
--parse tells the engine what to parse claims or remits
--folder location of the claims|remits
--batch number of processes to spawn to parse the files
--resume tells the parser to resume parsing
if all files weren't processed or new files were added into the folder
4. export data to a relational data-store
The parser will export data into other data-stores as a relational tables allowing users to construct views to support a variety of studies.
healthcare-io.py --export <835|837> --config <path-export.json>
with:
--config configuration to support data-store
2020-10-02 04:30:55 +00:00
2021-01-12 19:48:04 +00:00
The configuration file template for exports is as follows :
{"provider":"<postgresql|redshift|mysql|mariadb>","db":"mydatabase",["host":"server-name","port":5432,"user":"me","password":"!@#z4qm","schema":"target-schema"]}
**parameters:**
provider postgresql,redshift,mysql or mariadb (supported providers)
db name of the database
**optional:**
schema name of the target schema. If not provided we will assume the default
host host of the database. If not provided assuming localhost
port port value of the database if not provided the default will be used
user database user name. If not provided we assume security settings to trust
password password of database user. If not set we assume security settings to trust
2019-11-06 20:38:13 +00:00
**Embedded in Code :**
2020-10-02 06:47:28 +00:00
The Healthcare/IO **parser** can be used within your code base as a library and handle storing data in a data store of choice
2019-11-06 20:38:13 +00:00
2020-10-02 06:47:28 +00:00
import healthcareio
2019-11-07 07:28:56 +00:00
2019-11-07 07:40:16 +00:00
## Credits
2019-11-07 07:50:55 +00:00
2019-11-12 17:47:44 +00:00
* [Khanhly Nguyen] (<khanhly.t.nguyen@gmail.com>)
2020-10-02 06:47:28 +00:00
* [Gaylon Stanley] (<gaylon.stanley@vumc.org>)
2019-11-12 17:47:44 +00:00
* [Cheng Gao] (<cheng.gao@vanderbilt.edu>)
* [Brad Malin] (brad.malin@vanderbilt.edu)
2020-10-02 06:47:28 +00:00
* [Steve L. Nyemba] (<steve.l.nyemba@vumc.org>)
2019-11-12 17:47:44 +00:00
2019-11-07 07:40:16 +00:00