HL7 Lookups and Properties

The following tables list the properties specific to HL7 messages defined in a selector. Each property lists whether or not the property is applied to a message during HL7 processing, and the standard type(s) to which the data belongs.

Depending on your trading partner agreement(s), the properties defined may vary. However, the defined values must include all the possible properties that are available in the data files exchanged between trading partners.

Type	Description
Level	Specifies the level (batch or file)
Sending App	Specifies the value of FHS/BHS segment, element 03
Receiving App	Specifies the value of FHS/BHS segment, element 05
Sending Facility	Specifies the value of FHS/BHS segment, element 04
Receiving Facility	Specifies the value of FHS/BHS segment, element 06
Control ID	Specifies the value of FHS/ BHS segment, element 11
Encoding Characters	Specifies the value of FHS/BHS segment, element 02, such as ^,~,\,&
Segment Delimiter	Specifies the value of the segment delimiter, such as CR
Element Delimiter	Specifies the value of the element delimiter, such as |
Subelement delimiter	Specifies the value of the subelement delimiter, such as ^
Subcomponent delimiter	Specifies the value of the subcomponent delimiter, such as &
Release Character	Specifies the value of the release character, such as \
Repeating Separator	Specifies the value of the repeating separator, such as ~
Acknowledgement Type	Specifies the acknowledgements that are required to be returned in response to this message
Acknowledgement Option	Defines the Data Node for which an acknowledgment should be generated
Trading Partner Name	Specifies the trading partner name at the message level
Guideline	Specifies the guideline file name
Map	Specifies the map file location at the message level
Severity Config File	Path or content of severity config file to override system-wide error severity settings

The following tables list the properties specific to HL7 Transactions:

Type	Description
Environment	Specifies the message environment
Mode	Specifies the message mode
Message Version	Specifies the message version
Standard	Specifies the file/batch/message standard
Level	Specifies the file/batch level
Trigger Event	Specifies the trigger event message
Message Code	Specifies the message code
File Encoding Characters	Specifies the value of FHS segment, element 02
File Control ID	Specifies the value of FHS segment, element 11
Batch Encoding Characters	Specifies the value of the BHS segment, element 02
Batch Control ID	Specifies the value of the BHS segment, element 11
Message Encoding Characters	Specifies the value of the MHS segment, element 02
Message Control ID	Specifies the value of the MHS segment, element 11
Sending App	Specifies the value of the FHS segment, element 03.
Receiving App	Specifies the value of the FHS segment, element 05.
Sending Facility	Specifies the value of the FHS segment, element 04
Receiving Facility	Specifies the value of the FHS segment, element 06
Segment Delimiter	Specifies the value of the segment delimiter.
Element Delimiter	Specifies the value of the element delimiter.
Subelement Delimiter	Specifies the value of the sub-element delimiter.
Subcomponent Delimit	Specifies the value to use when there is XML data that matches one of the delimiters and the standard does not support the use of a release character.
Release Character	Specifies the value of the decimal character, such as "," for European countries.
Repeating Separator	Specifies the value of the repeating separator
Gudieline	Specifies the guideline file name
Severity Config	Specifies the type of acknowledgement document to be generated.
Map	Addition of custom name/value pairs is further enhanced with the fixed call to the selector done for each data node (DN). Selector is asked for TPInfo value. The value received is parsed into a set of name/value pairs that is also added to the DN list of properties. The syntax of the returned value includes all chars with ‘=’ and ‘;’ used as separators. Double entries of separators are used for escaping characters.
Acknowledgement Type
Acknowledgement Option	Specifies the map file location for the interchange level.
Trading Partner Name	Asked only if AcknowledgementType=X12Extended. Defines what type of Acknowledgements should be generated and the conditions. Note If Up One Level mode is set, only the Interchange level parameter is considered for acknowledgment creation.
Message Control Number	Incremental value to be used between the values in the sequence.