HL7 v2 integration plugin for Apache Hop, powered by the BerryWorks EDIReader Framework.
Version 0.2.0-rc1
is available as a public pre-release. It reads HL7 v2 messages into structured
rows for use in Hop pipelines. The admission demonstration (ADT^A01) extracts
patient context, procedures, and insurance groups.
Requires Apache Hop 2.19.0 and Java 21 or later. Installation and the Quick Start have been tested with Hop 2.19.0 and Java 21.
Import the BerryWorks HL7 repository once to make this plugin appear in Hop Marketplace. It is not included in Hop's default catalog.
-
Open Tools → Marketplace and select Repositories.
-
Click Import from URL… and paste:
https://raw.githubusercontent.com/BerryWorksSoftware/hop-hl7/main/hop-marketplace-repo.yaml -
Review the preview: BerryWorks HL7, a GitHub release download template, the catalog URL in this repository, and one plugin. Confirm with OK, then Save. Apache Repository can remain primary.
-
Select Plugins, click Refresh, and search for
BerryWorks. -
Select BerryWorks HL7 Input, version 0.2.0-rc1, and click Install.
-
Close Marketplace and restart Hop after installation succeeds.
-
Find HL7 Input under BerryWorks HL7 and try the Quick Start below.
This Marketplace installation workflow was verified with Hop 2.19.0 and
0.2.0-rc1. If the status is Present on disk, Hop has found a manually
installed copy. To test a fresh Marketplace installation, stop Hop, move the
plugins/transforms/hop-hl7-plugin/ folder outside the Hop installation, then
restart Hop and install through Marketplace.
Explore the HL7 admission Quick Start, which includes
an entirely synthetic ADT^A01 message, a YAML model, a Hop pipeline, and expected
CSV results for procedures and insurance plans. Running it requires the separate HL7 Input
release candidate described below.
Download hop-hl7-plugin-0.2.0-rc1.zip and its .sha256 checksum file from the
0.2.0-rc1 pre-release.
- Verify the ZIP against the supplied SHA-256 checksum.
- Stop Hop GUI and other Hop processes using the installation.
- If replacing an earlier HL7 candidate, remove its
plugins/transforms/hop-hl7-plugin/folder before extraction. - Extract the ZIP into the Hop installation root, the folder containing
hop-gui.shorhop-gui.bat. It createsplugins/transforms/hop-hl7-plugin/. - Restart Hop. Find HL7 Input under BerryWorks HL7.
- Run the admission Quick Start and compare its
two output CSVs with the files in its
expectedfolder.
The EDI plugin may remain installed: the HL7 transform has a separate ID and
installation folder. The candidate bundles an ADT_A01/2.5.1 YAML model under
plugins/transforms/hop-hl7-plugin/models/. The Quick Start uses its own copy.
The first candidate demonstrates parsing synthetic ADT_A01 admissions, including procedure and insurance groups, into structural and business rows. It does not provide full HL7 compliance validation or clinically validated patient mappings. ORU loop detection is outside this candidate's supported scope.
The package includes the unchanged public BerryWorks EDIReader parser, a reduced
and obfuscated proprietary BerryWorks framework runtime, and SnakeYAML. See the
bundled NOTICE.txt and licenses/ directory for component terms.
This is the public home for the plugin's documentation, examples, release information, and downloads as they become available. Development source is maintained separately in the shared BerryWorks Hop plugin codebase.
The HL7 plugin and the BerryWorks EDI plugin for Apache Hop have separate public identities and share underlying BerryWorks technology. The EDI plugin's existing 0.1.0 preview does not include HL7 support.
Use this repository's issue tracker for questions, feature requests, and feedback. For parsing issues, include the message type and HL7 version, relevant error details, and a small synthetic example. Do not include patient information or other sensitive data.