{"id":21651803,"url":"https://github.com/dev-vivekkumarverma/hl7v2.5-parser","last_synced_at":"2026-05-11T04:57:04.362Z","repository":{"id":243191033,"uuid":"811716169","full_name":"dev-vivekkumarverma/hl7v2.5-Parser","owner":"dev-vivekkumarverma","description":"This repository contains a Python-based parser for HL7v2.5 medical record files, capable of converting these files into JSON format. This tool has been tested against the Redox engine, demonstrating superior performance in various scenarios.","archived":false,"fork":false,"pushed_at":"2024-06-07T07:41:53.000Z","size":21,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-25T05:43:02.233Z","etag":null,"topics":["hl7v2","hl7v2-message","parser","python3","v2"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dev-vivekkumarverma.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-07T06:49:37.000Z","updated_at":"2024-06-21T10:07:26.000Z","dependencies_parsed_at":"2024-06-07T09:09:31.445Z","dependency_job_id":null,"html_url":"https://github.com/dev-vivekkumarverma/hl7v2.5-Parser","commit_stats":null,"previous_names":["dev-vivekkumarverma/hl7v2.5-parser"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-vivekkumarverma%2Fhl7v2.5-Parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-vivekkumarverma%2Fhl7v2.5-Parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-vivekkumarverma%2Fhl7v2.5-Parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-vivekkumarverma%2Fhl7v2.5-Parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dev-vivekkumarverma","download_url":"https://codeload.github.com/dev-vivekkumarverma/hl7v2.5-Parser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244547606,"owners_count":20470103,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hl7v2","hl7v2-message","parser","python3","v2"],"created_at":"2024-11-25T07:49:36.194Z","updated_at":"2026-05-11T04:57:04.338Z","avatar_url":"https://github.com/dev-vivekkumarverma.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HL7v2.5 Parser\n\nThis repository contains a Python-based parser for HL7v2.5 medical record files, capable of converting these files into JSON format. This tool has been tested against the Redox engine, demonstrating superior performance in various scenarios.\n\n## Features\n\n- **Parse HL7v2.5 files to JSON:** Converts HL7v2.5 medical records into a structured JSON format for easier processing and integration.\n- **Detailed breakdown:** Breaks down HL7 messages into segments, data fields, components, and sub-components for detailed analysis.\n- **Validation:** Tested extensively to ensure accuracy and reliability.\n\n## Requirements\n\n- Python 3.11\n\n## Getting Started\n\nTo use this parser, simply clone this repository and follow the steps below:\n\n```bash\ngit clone https://github.com/dev-vivekkumarverma/hl7v2.5-Parser.git\n```\n\n**Note:** Do not add the extension of the input file (defaults to `.txt`).\n\nOpen the `.ipynb` file in Jupyter Notebook and follow the instructions provided in the markdown cells to parse your HL7v2.5 files.\n\n## Important Points\n\n### Structure:\n\n- **Trigger Event:** The event that takes place which generates the message.\n- **Segments:** Data-field delimiter separated (e.g., `\u003ccr\u003e`), identified by a three-letter code (e.g., MHS, PID).\n  - **Data-fields:** Data between the data-field separator (`|`). For example: `|A01|20150601135823+0100|`. Datafields can also repeat with the data field seperator (\"|\") using the repetition seperator character ('~').\n    - **Components:** Data inside a data-field separated by component separator delimiter (`^`). For example: `|23432^Smith^Gordon^Denny^Jr^MD^^^AssignAuth\u00261.2.3.4.5.6\u0026ISO^L^9^1000^DN^ AssignFac\u00261.2.3.4.5.7\u0026ISO^^G^20100101000000+0100^20330101000000+0100^doctor|`.\n      - **Sub-components:** Parts of the components separated by sub-component separator delimiter (`\u0026`) if present. For example: `^AssignFac\u00261.2.3.4.5.7\u0026ISO^`.\n\n### Example Usage\n\nHere's a brief example of how to use the parser:\n- After cloning the repository change the directory with following command\n  ```bash\n      cd hl7v2.5-Parser\n  ```\n  then change the `input_file_name` in the `Hl7v2.ipynb` file:\n  \n```python\ninput_file_name='hl7v2_test'  # replace with your hl7v2.5 file path\n```\nthen run the entire notebook. Your output files will be stored in `output_folder` with format `{input_file_name}_output_{date}.json`\n\n## Advantages\n\n- **Transparency:** The parser provides detailed keys in the output JSON, allowing for easy cross-referencing with HL7 definitions.\n- **Customizable:** Easy to modify and extend for specific use cases.\n\nFor reference, use [this recommended site](https://hl7-definition.caristix.com/v2/HL7v2.5.1/) to look up HL7 data fields and structures.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdev-vivekkumarverma%2Fhl7v2.5-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdev-vivekkumarverma%2Fhl7v2.5-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdev-vivekkumarverma%2Fhl7v2.5-parser/lists"}