Extracts information from an HL7 (Health Level 7) formatted FlowFile and adds the information as FlowFile Attributes. The attributes are named as <Segment Name> <dot> <Field Index>. If the segment is repeating, the naming will be <Segment Name> <underscore> <Segment Index> <dot> <Field Index>. For example, we may have an attribute named "MHS.12" with a value of "2.1" and an attribute named "OBX_11.3" with a value of "93000^CPT4".


HL7, health level 7, healthcare, extract, attributes


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Character EncodingCharacter EncodingUTF-8The Character Encoding that is used to encode the HL7 data
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Use Segment Namesuse-segment-namesfalse
  • true
  • false
Whether or not to use HL7 segment names in attributes
Parse Segment Fieldsparse-segment-fieldsfalse
  • true
  • false
Whether or not to parse HL7 segment fields into attributes
Skip Validationskip-validationtrue
  • true
  • false
Whether or not to validate HL7 message values
HL7 Input Versionhl7-input-versionautodetect
  • autodetect
  • 2.2
  • 2.3
  • 2.3.1
  • 2.4
  • 2.5
  • 2.5.1
  • 2.6
The HL7 version to use for parsing and validation


successA FlowFile is routed to this relationship if it is properly parsed as HL7 and its attributes extracted
failureA FlowFile is routed to this relationship if it cannot be mapped to FlowFile Attributes. This would happen if the FlowFile does not contain valid HL7 data

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.