HL7Reader reads data in HL7® version 2 format. ^[1]

All HL7® v2 versions from 2.1 to 2.9 are supported.

HL7Reader propagates metadata on both output ports.

Metadata on optional input port must contain string, byte or cbyte field.

Metadata on first output port have to have first field of the type variant.

Metadata on first output port can use Autofilling Functions.

HL7Reader reads data from HL7® version 2 files using SAX technology.

HL7Reader reads entire input file with the HL7® version 2 structure to structured variant field. All data types in the variant field will be string type.

Version and message type of the HL7® v2 standard are auto-detected. You can override auto-detection of version and message type by using external schema.

HL7Reader can use user defined external schema. This schema has to have a XML structure defined internally in CloverDX Designer.

You can modify already existing message schema. Schema XML files are stored in jar file hl7v2schema-[version].jar which can be found in CloverDX Designer installation dir in path plugins/com.cloveretl.gui.commercial_[version]/lib/plugins/org.jetel.component.commercial/lib.

Schema files are organized in directories named by HL7® v2 version and each filename contains HL7® v2 message structure type. You can unpack required schema XML file, modify it and directly use it with HL7Reader. These files contain description of content and structure of particular HL7® v2 message. Content and structure of HL7® v2 segments is stored in segments.xml.

When modifying a schema the names of elements and attributes must stay the same, but their values can be changed.

When creating a new HL7® v2 segment the attribute name has to follow naming convention defined by HL7® standards.

Group segment is segment which serves as a logical group of segments. It’s never present in HL7® v2 message and unlike standard segments its name can be longer than 3 characters. For example PATIENT.

Standard HL7®v2 segment has to have an name in a form of 3 capital letters or numbers. For example EVN, PID or PV1.

When modifying segment structure in segments.xml its elements field, component and subcomponent has to be on a proper level since there can be only 3 levels. Field attribute name doesn’t have any fixed naming convention.