diff --git a/README.md b/README.md index eee9d4e..3f6ad80 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,22 @@ ## About Healthcare/IO Parser -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) +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) 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. -## Features ## - | Features | | - |----------|-| +## 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| + + + ## Installation pip install --upgrade git+https://hiplab.mc.vanderbilt.edu/git/lab/parse-edi.git @@ -17,11 +25,12 @@ We wrote this frame to be used in both command line or as a library within in yo **cli :** - # signup to get parsing configuration +1. signup to get parsing configuration + healthcare-io.py --signup [--store ] - # - # start parsing claims in a folder +2. parsing claims in a folder + healthcare-io.py --parse --folder [--batch ] [--resume] with : @@ -31,8 +40,11 @@ We wrote this frame to be used in both command line or as a library within in yo --resume tells the parser to resume parsing 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 [--context ] + + healthcare-io.py --server [--context ] + **Embedded in Code :** Use **parse-edi** within your code base as a library and handle storing data in a data store of choice