generate-summary-of-injuries


Namegenerate-summary-of-injuries JSON
Version 1.0.2 PyPI version JSON
download
home_pagehttps://github.com/izgorodin/generate_summary_of_injuries
SummaryAutomates the creation of demand letters based on medical PDF records.
upload_time2024-09-25 22:02:37
maintainerNone
docs_urlNone
authorEduard Izgorodin
requires_python>=3.6
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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 generate-summary-of-injuries
```

## Usage

Run the main script with the following command:

```bash
generate_summary_of_injuries <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.

## Project Structure

- `src/`: Contains the source code for the project.
  - `main.py`: Entry point for the application.
  - `generate_summary_of_injuries.py`: Main script that orchestrates the entire process.
  - `pdf_reader.py`: Handles reading PDF files and extracting text.
  - `date_extractor.py`: Extracts dates from PDF text.
  - `diagnosis_extractor.py`: Extracts diagnoses from PDF text.
  - `icd_code_determiner.py`: Determines ICD-10 codes based on diagnoses.
  - `pdf_creator.py`: Creates the final summary PDF.
- `tests/`: Contains unit tests for the project.
  - `test_main.py`: Tests for the main entry point.
  - `test_generate_summary_of_injuries.py`: Tests for the main summary generation.
  - `test_icd_code_determiner.py`: Tests for ICD code determination.
  - `test_pdf_reader.py`: Tests for PDF reading functionality.
  - `test_pdf_creator.py`: Tests for PDF creation functionality.
  - `test_dependencies.py`: Tests for project dependencies.
- `setup.py`: Configuration file for packaging the project.
- `requirements.txt`: Lists all Python dependencies for the project.
- `README.md`: Provides information about the project and how to use it.
- `.gitignore`: Specifies files and directories to be ignored by Git.

## 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.

## 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": "generate-summary-of-injuries",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Eduard Izgorodin",
    "author_email": "edizgorodin@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/30/28/4e6f8e6935c0ffd4531bb227cf8379925ad1a5e6a161ef6c4a01a72ada12/generate_summary_of_injuries-1.0.2.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\n```bash\npip install generate-summary-of-injuries\n```\n\n## Usage\n\nRun the main script with the following command:\n\n```bash\ngenerate_summary_of_injuries <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\n## Project Structure\n\n- `src/`: Contains the source code for the project.\n  - `main.py`: Entry point for the application.\n  - `generate_summary_of_injuries.py`: Main script that orchestrates the entire process.\n  - `pdf_reader.py`: Handles reading PDF files and extracting text.\n  - `date_extractor.py`: Extracts dates from PDF text.\n  - `diagnosis_extractor.py`: Extracts diagnoses from PDF text.\n  - `icd_code_determiner.py`: Determines ICD-10 codes based on diagnoses.\n  - `pdf_creator.py`: Creates the final summary PDF.\n- `tests/`: Contains unit tests for the project.\n  - `test_main.py`: Tests for the main entry point.\n  - `test_generate_summary_of_injuries.py`: Tests for the main summary generation.\n  - `test_icd_code_determiner.py`: Tests for ICD code determination.\n  - `test_pdf_reader.py`: Tests for PDF reading functionality.\n  - `test_pdf_creator.py`: Tests for PDF creation functionality.\n  - `test_dependencies.py`: Tests for project dependencies.\n- `setup.py`: Configuration file for packaging the project.\n- `requirements.txt`: Lists all Python dependencies for the project.\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## 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## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Automates the creation of demand letters based on medical PDF records.",
    "version": "1.0.2",
    "project_urls": {
        "Homepage": "https://github.com/izgorodin/generate_summary_of_injuries"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bbfe0d3ce827739305d97bd7405d5cb553ea315665cff3eb66a6c9194b1093c4",
                "md5": "c3ea4fe724b5c2784c55684503e77b52",
                "sha256": "cbcfa09ef459023c53ecdbc9bc8a4b5dbb9ab1d837bd4a658fef70b88f63df4e"
            },
            "downloads": -1,
            "filename": "generate_summary_of_injuries-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c3ea4fe724b5c2784c55684503e77b52",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 2980,
            "upload_time": "2024-09-25T22:02:36",
            "upload_time_iso_8601": "2024-09-25T22:02:36.057492Z",
            "url": "https://files.pythonhosted.org/packages/bb/fe/0d3ce827739305d97bd7405d5cb553ea315665cff3eb66a6c9194b1093c4/generate_summary_of_injuries-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "30284e6f8e6935c0ffd4531bb227cf8379925ad1a5e6a161ef6c4a01a72ada12",
                "md5": "f4a54016aaaf15d63740ef6625589321",
                "sha256": "6b8321c3e862360dfd06b5e68ebd43c11b11cd26c642e6eda69f7c676cdfaba1"
            },
            "downloads": -1,
            "filename": "generate_summary_of_injuries-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "f4a54016aaaf15d63740ef6625589321",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 9886,
            "upload_time": "2024-09-25T22:02:37",
            "upload_time_iso_8601": "2024-09-25T22:02:37.957022Z",
            "url": "https://files.pythonhosted.org/packages/30/28/4e6f8e6935c0ffd4531bb227cf8379925ad1a5e6a161ef6c4a01a72ada12/generate_summary_of_injuries-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-25 22:02:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "izgorodin",
    "github_project": "generate_summary_of_injuries",
    "github_not_found": true,
    "lcname": "generate-summary-of-injuries"
}
        
Elapsed time: 0.47100s