HL7

Front

itemlists_hl7output

Version (not available for return type of Version)
Enter the HL7 version for which return the selected valid items, or click on the Variables button on the right, to select a variable which will contain the version.

Return type
Select which list you want to have returned. You can choose either:

  • Version
  • Message
  • Segment
  • Field

Store

Output type
Select the target output type to use during the HL7 message creation. You can choose either:

  • Pipe messages

Based on the selected type specific fields will be available.

Version
Enter the HL7 version for the output message to be compatible with, or click on the Variables button on the right, to select a variable which will contain the version.

Path
Enter an output path manually, or select Browse to browse to the right folder. You may also insert variables by selecting the Variable button on the right. This is the target path where the output HL7 pipe messages will be created.

Info

For network paths specify the full UNC path starting with \\. Mapped drives are not allowed because Scanshare is running inside services and Mapped Drives are not existing in services context.

Info

For the network authentication and allowing authentication on virtual UNC shares you would use \# before your UNC path. e.g.: \#YOUR_UNC_PATH.

Filename
Enter the filename for the output HL7 pipe message, or click on the Variables button on the right, to select a variable which will contain the filename.

Info

The extension of the file will be always .hl7.

If file already exists
Choose here what to do when the file already exists. Available options are:

  • Abort
  • Overwrite

Use variables
If enable create the HL7 message automatically based on the available HL7 variables in the current workflow, otherwise the Message field will be enabled where a manual message can be composed.

Make sure that all variables to create a valid HL7 message are existing otherwise an error will be generated on the message validation.

The variables notation needs to respect the following structure (created automatically when using HL7 Input capture module):

  • HL7_ : Starting prefix always for all HL7 variables
  • HL7_MESSAGE_SEGMENT_COUNT : The number of segments existing in this message
  • HL7_MESSAGE_SEGMENT_X_NAME: Name of the segment number X
  • HL7_MESSAGE_SEGMENT_X_FIELD_COUNT: The number of the fields existing in the current segment number X
  • HL7_MESSAGE_SEGMENT_X_FIELD_Y: Value of the field number Y for the segment number X
  • HL7_MESSAGE_SEGMENT_X_FIELD_Y_DELIMITER: Specify a value of 1 if the value of the field number Y for the segment number X will contains any delimiter to be parsed and escaped
  • HL7_MESSAGE_SEGMENT_X_FIELD_Y_COMPONENT_COUNT: The number of components, if existing, in the current field number Y of the current segment number X
  • HL7_MESSAGE_SEGMENT_X_FIELD_Y_COMPONENT_Z: Value of the component number Z for the field number Y of the segment number X
  • HL7_MESSAGE_SEGMENT_X_FIELD_Y_COMPONENT_Z_SUBCOMPONENT_COUNT: The number of subcomponents, if existing, in the current component number Z of the current field number Y of the current segment number X
  • HL7_MESSAGE_SEGMENT_X_FIELD_Y_COMPONENT_Z_SUBCOMPONENT_K: Value of the subcomponent number K for the component number Z of the field number Y of the segment number X

Message
If Use variables is disabled compose here the HL7 message to create in output. You may also use any workflow variables inside the message body.

By writing a custom message is written the complete HL7 message structure needs to be inserted according the specified HL7 version above.

HL7 custom message format is composed by the HL7 header separated with a ; (semicolon) by the HL7 body message in this form:

HL7HEADER;HL7BODY

If this format is not respected a message parsing error will be generated.

The HL7HEADER is composed by the HL7 MSH header as per HL7 standards and according the selected version. All fields (exactly 8) of the header are separated by a , (colon) in this form:

MSH1,MSH2,MSH3,MSH4,MSH5,MSH6,MSH7,MSH8

If not all 8 MSH header fields are provided a message format error will be generated.

The 8 MSH mandatory fields are, in order:

  • Sending application
  • Sending facility
  • Receiving application
  • Receiving facility
  • Security
  • Message type
  • Message control ID
  • Processing ID

MSH header example:

ADT1,MCM,LABADT,MCM,SECURITY,ADT^A01,198808181126,MSG00001-

The HL7BODY is composed by a list of messages to insert into the HL7 message separated by , (colon). Every message will be furthermore a string of components separated by = (equal), here components must be always in the number of 2 (name and value of the component) otherwise a parsing error will be generated.

A message line example:

PID.3.1=PATID1234

Permissions

Username and Password
Enter a username and password (if needed) or select a variable to access the network output folder.

Warning

Authentication is not required on local folders (e.g. starting with a local drive letter). If you specify credentials in such case an error will be generated during storing because Scanshare will attempt to obtain the UNC root authentication point.

Previous Article

Greenlight CRM

Next Article

HR2day