# Injury Summary Generator
This project automates the process of creating a demand letter for a client based on medical records in PDF format. It extracts relevant information from medical records and generates a "Summary of Injuries" section in a table format.
## Data Source
The ICD-10 codes used in this project are sourced from the Centers for Medicare & Medicaid Services (CMS) website. You can find the official ICD-10 code lists at:
https://www.cms.gov/medicare/coordination-benefits-recovery/overview/icd-code-lists
This authoritative source ensures that our project uses up-to-date and accurate ICD-10 codes for classifying diagnoses.
## Features
- **PDF Processing**: Reads multiple PDF files containing medical records and extracts text.
- **Information Extraction**: Extracts key information such as visit dates, diagnoses, and page numbers.
- **ICD-10 Code Determination**: Determines appropriate ICD-10 codes for extracted diagnoses.
- **PDF Generation**: Creates a summary PDF with a formatted table of extracted information.
## Installation
You can install the Injury Summary Generator using pip:
```bash
pip install injury-summary-generator
```
## Usage
After installation, you can run the Injury Summary Generator using the following command:
```bash
injury-summary-generator <input_folder> <output_folder>
```
Where:
- `<input_folder>` is the path to the folder containing the medical record PDF files.
- `<output_folder>` is the path where the output summary PDF will be saved.
To check the version of the installed package, use:
```bash
injury-summary-generator --version
```
## Project Structure
- `generate_summary_of_injuries/`: Main package directory.
- `__init__.py`: Package initialization file.
- `_metadata.py`: Package metadata.
- `main.py`: Entry point for the command-line interface.
- `processor.py`: Main processing logic.
- `pdf_reader.py`: Handles reading PDF files and extracting text.
- `date_extractor.py`: Extracts dates from text.
- `diagnosis_extractor.py`: Extracts diagnoses from text.
- `icd_code_determiner.py`: Determines ICD-10 codes based on diagnoses.
- `pdf_creator.py`: Creates the final summary PDF.
- `data/`: Contains data files used by the project.
- `icd10_codes.csv`: CSV file containing ICD-10 codes and descriptions.
- `tests/`: Contains unit tests for the project.
- `setup.py` and `setup.cfg`: Configuration files for packaging and distribution.
- `requirements.in` and `requirements.txt`: Lists Python dependencies for the project.
- `MANIFEST.in`: Specifies additional files to include in the package.
- `README.md`: Provides information about the project and how to use it.
- `.gitignore`: Specifies files and directories to be ignored by Git.
## Development
To set up the development environment:
1. Clone the repository: `git clone https://github.com/yourusername/injury-summary-generator.git`
2. Create a virtual environment: `python -m venv venv`
3. Activate the virtual environment:
- On Windows: `venv\Scripts\activate`
- On macOS and Linux: `source venv/bin/activate`
4. Install dependencies: `pip install -r requirements.txt`
5. Install the package in editable mode: `pip install -e .`
## Testing
To run the tests, use the following command:
```bash
pytest
```
## Contributing
Contributions to this project are welcome. Please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name`).
3. Make your changes and commit them (`git commit -am 'Add some feature'`).
4. Push to the branch (`git push origin feature/your-feature-name`).
5. Create a new Pull Request.
## Releasing
To create a new release:
1. Update the version number in `setup.py`.
2. Create a new tag with the version number: `git tag v1.0.0`
3. Push the tag to GitHub: `git push origin v1.0.0`
4. Create a new release on GitHub, describing the changes and new features.
5. Build and upload the package to PyPI:
```
python setup.py sdist bdist_wheel
twine upload dist/*
```
## License
This project is licensed under the MIT License - see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/izgorodin/generate_summary_of_injuries",
"name": "injury-summary-generator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "medical, pdf, summary, injury, demand-letter",
"author": "Eduard Izgorodin",
"author_email": "edizgorodin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0b/9d/2d5af31d6d1e0f860d7cdcf497de0028b56d91f68428108a2d27da0fa059/injury_summary_generator-1.1.0.tar.gz",
"platform": null,
"description": "# Injury Summary Generator\n\nThis project automates the process of creating a demand letter for a client based on medical records in PDF format. It extracts relevant information from medical records and generates a \"Summary of Injuries\" section in a table format.\n\n## Data Source\n\nThe ICD-10 codes used in this project are sourced from the Centers for Medicare & Medicaid Services (CMS) website. You can find the official ICD-10 code lists at:\n\nhttps://www.cms.gov/medicare/coordination-benefits-recovery/overview/icd-code-lists\n\nThis authoritative source ensures that our project uses up-to-date and accurate ICD-10 codes for classifying diagnoses.\n\n## Features\n\n- **PDF Processing**: Reads multiple PDF files containing medical records and extracts text.\n- **Information Extraction**: Extracts key information such as visit dates, diagnoses, and page numbers.\n- **ICD-10 Code Determination**: Determines appropriate ICD-10 codes for extracted diagnoses.\n- **PDF Generation**: Creates a summary PDF with a formatted table of extracted information.\n\n## Installation\n\nYou can install the Injury Summary Generator using pip:\n```bash\npip install injury-summary-generator\n```\n\n## Usage\n\nAfter installation, you can run the Injury Summary Generator using the following command:\n\n```bash\ninjury-summary-generator <input_folder> <output_folder>\n```\n\nWhere:\n- `<input_folder>` is the path to the folder containing the medical record PDF files.\n- `<output_folder>` is the path where the output summary PDF will be saved.\n\nTo check the version of the installed package, use:\n\n```bash\ninjury-summary-generator --version\n```\n\n## Project Structure\n\n- `generate_summary_of_injuries/`: Main package directory.\n - `__init__.py`: Package initialization file.\n - `_metadata.py`: Package metadata.\n - `main.py`: Entry point for the command-line interface.\n - `processor.py`: Main processing logic.\n - `pdf_reader.py`: Handles reading PDF files and extracting text.\n - `date_extractor.py`: Extracts dates from text.\n - `diagnosis_extractor.py`: Extracts diagnoses from text.\n - `icd_code_determiner.py`: Determines ICD-10 codes based on diagnoses.\n - `pdf_creator.py`: Creates the final summary PDF.\n - `data/`: Contains data files used by the project.\n - `icd10_codes.csv`: CSV file containing ICD-10 codes and descriptions.\n- `tests/`: Contains unit tests for the project.\n- `setup.py` and `setup.cfg`: Configuration files for packaging and distribution.\n- `requirements.in` and `requirements.txt`: Lists Python dependencies for the project.\n- `MANIFEST.in`: Specifies additional files to include in the package.\n- `README.md`: Provides information about the project and how to use it.\n- `.gitignore`: Specifies files and directories to be ignored by Git.\n\n## Development\n\nTo set up the development environment:\n\n1. Clone the repository: `git clone https://github.com/yourusername/injury-summary-generator.git`\n2. Create a virtual environment: `python -m venv venv`\n3. Activate the virtual environment:\n - On Windows: `venv\\Scripts\\activate`\n - On macOS and Linux: `source venv/bin/activate`\n4. Install dependencies: `pip install -r requirements.txt`\n5. Install the package in editable mode: `pip install -e .`\n\n## Testing\n\nTo run the tests, use the following command:\n\n```bash\npytest\n```\n\n## Contributing\n\nContributions to this project are welcome. Please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature/your-feature-name`).\n3. Make your changes and commit them (`git commit -am 'Add some feature'`).\n4. Push to the branch (`git push origin feature/your-feature-name`).\n5. Create a new Pull Request.\n\n## Releasing\n\nTo create a new release:\n\n1. Update the version number in `setup.py`.\n2. Create a new tag with the version number: `git tag v1.0.0`\n3. Push the tag to GitHub: `git push origin v1.0.0`\n4. Create a new release on GitHub, describing the changes and new features.\n5. Build and upload the package to PyPI:\n ```\n python setup.py sdist bdist_wheel\n twine upload dist/*\n ```\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A tool to generate summaries of injuries from PDF medical records",
"version": "1.1.0",
"project_urls": {
"Bug Reports": "https://github.com/izgorodin/generate_summary_of_injuries/issues",
"Homepage": "https://github.com/izgorodin/generate_summary_of_injuries",
"Source": "https://github.com/izgorodin/generate_summary_of_injuries"
},
"split_keywords": [
"medical",
" pdf",
" summary",
" injury",
" demand-letter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "301c8344e2c51e7d859795f886b219f57bbec8cde5ca982ec23acc7f5f55479c",
"md5": "3789a847c1d33f2da80f5231e9ec134f",
"sha256": "019bef6f84f84dcd7eb71424efa0e493d84ce2496bcc08302762e8ddf3823ac7"
},
"downloads": -1,
"filename": "injury_summary_generator-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3789a847c1d33f2da80f5231e9ec134f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 1438493,
"upload_time": "2024-09-27T14:24:36",
"upload_time_iso_8601": "2024-09-27T14:24:36.840577Z",
"url": "https://files.pythonhosted.org/packages/30/1c/8344e2c51e7d859795f886b219f57bbec8cde5ca982ec23acc7f5f55479c/injury_summary_generator-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b9d2d5af31d6d1e0f860d7cdcf497de0028b56d91f68428108a2d27da0fa059",
"md5": "e22f455147adc6ae31131141fb181aa0",
"sha256": "de1d62ac5161eb45911327d90dd4c13d867d4b89e47b9df4edadea2f4219d2ac"
},
"downloads": -1,
"filename": "injury_summary_generator-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e22f455147adc6ae31131141fb181aa0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 859879,
"upload_time": "2024-09-27T14:24:40",
"upload_time_iso_8601": "2024-09-27T14:24:40.708616Z",
"url": "https://files.pythonhosted.org/packages/0b/9d/2d5af31d6d1e0f860d7cdcf497de0028b56d91f68428108a2d27da0fa059/injury_summary_generator-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-27 14:24:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "izgorodin",
"github_project": "generate_summary_of_injuries",
"github_not_found": true,
"lcname": "injury-summary-generator"
}
JSON
