HL7 paths

To define specific elements within a message, path naming can use the location of an element within an HL7 message. Path names are used to specify groups, repetition counts, segment IDs and fields.

This also applies to X12 Configurator, XML Package Manager, and UN/EDIFACT Configurator.

This is a sample HL7 message:

MSH|^~\&|HIS||||19930603090227||ADT^A03|19930603090227|P|2.1|||

This is a group of segment definitions:

MSH
EVN
{PID}
[PV1]
{[Z01]}

The first two segments, MSH and EVN, display exactly once. These are required.

The PID segment must display at least once, but more instances can be used. This segment is also required. The curly braces define this segment as repetitive.

The PV1 segment is an optional segment defined by the square brackets.

    • These are all in one group.
    • A 0-based numbering system is used.
    • These segments are all in group 0.

The Z01 segment is an optional segment defined by the square brackets. One to many instances are permitted.

Because groups, segments, and fields can repeat, a 0-based instance (a repetition count) is included for each object in a field path that repeats.

For example:

0(0).MSH(0).00013

The repetition count displays in parentheses if the object is a repeating item. If it does not repeat, then an instance is not noted.