documentation

This commit is contained in:
Steve Nyemba 2020-10-01 22:24:23 -05:00
parent 99d5804c9e
commit 41d75012ab
1 changed files with 21 additions and 16 deletions

View File

@ -1,33 +1,38 @@
## About Parse-Edi ## About Healthcare/IO Parser
**parse-edi** 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) The Halthcare/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)
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 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
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. 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.
## Features ##
| Features | |
|----------|-|
## Installation ## Installation
pip install git+https://hiplab.mc.vanderbilt.edu/git/lab/parse-edi.git pip install --upgrade git+https://hiplab.mc.vanderbilt.edu/git/lab/parse-edi.git
## Usage ## Usage
**Commandline :** **cli :**
# signup to get parsing configuration
healthcare-io.py --signup <email> [--store <mongo|sqlite>]
#
# start parsing claims in a folder
healthcare-io.py --parse <claims|remits> --folder <path> [--batch <n>] [--resume]
python edi --config <path> --folder <path> --store <[mongo|disk|couch]> --<db|path]> <id|path>
with : with :
--scope <claims|remits> --parse tells the engine what to parse claims or remits
--config path of the x12 to be parsed i.e it could be 835, or 837 --folder location of the claims|remits
--folder location of the files (they must be decompressed) --batch number of processes to spawn to parse the files
--store data store could be disk, mongodb, couchdb --resume tells the parser to resume parsing
--db|path name of the folder to store the output or the database name if all files weren't processed or new files were added into the folder
**dashboard**
There is a built-in dashboard that has features
healthcare-io.py --server <port> [--context <name>]
**Embedded in Code :** **Embedded in Code :**
Use **parse-edi** within your code base as a library and handle storing data in a data store of choice Use **parse-edi** within your code base as a library and handle storing data in a data store of choice