HL7apy is a lightweight Python package to intuitively handle HL7 v2 messages according to HL7 specifications.

The main features includes:

• Message parsing
• Message creation
• Message validation following the HL7 xsd specifications
• Access to elements by name, long name or position
• Support to all simple and complex datatypes
• Encoding chars customization
• Message encoding in ER7 format and compliant with MLLP protocol
• Support to message profile
• Support to Z-Elements
• Simple MLLP server implementation

Currently supported HL7 versions are: 2.1, 2.2, 2.3, 2.3.1, 2.4, 2.5, 2.5.1, 2.6, 2.7, 2.8, 2.8.1, 2.8.2

Current version is 1.3.4

This project is not affiliated with the HL7 organization: the library is just consistent with their specification.

Documentation can be found here.

HL7apy is platform independent and supports Python 2.7 and Python 3.[4-12]

To install it get the latest release from GitHub and launch the following command:

  python setup.py install

Alternatively you can use pip to install it from PyPI

  pip install hl7apy

Michael Sarfati wrote an interesting 2-parts article on his blog about HL7apy with useful examples and tutorials. You can read it here. Thanks a lot Michael for your contribution.

HL7apy is released under the MIT License.

Copyright (c) 2012-2018, CRS4

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.