Sending Messages with Repeating Fields - HL7 Module - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Premier - Standard - Essential

HL7 Module
Platform
OnBase
Product
HL7 Module
Release
Foundation 23.1
License
Premier
Standard
Essential

Repeating fields allow outbound messages to send multiple Keyword Values for a single Keyword Type. For example, if the trigger document has values A, B, and C for a Keyword Type, then the HL7 message triggered by that document can send all three values using a repeating field:

|A~B~C|

To allow a field to repeat in outbound messages, you must designate the field as repeating. If the field contains multiple components, enable the Repeating setting for the first component.

Note: Only loose keywords can be sent as repeating fields, when there are multiple instances of the keyword indexed on the document.
Note: Keywords in a Multi-Instance Keyword Type Group (MIKG) can only be sent as repeating segments when there are multiple instances of the MIKG indexed on the document.

Example:

OBX|123^ABC^20231212

OBX|456^DEF^20231213

OBX|789^GHI^20231214

To configure a repeating field for outbound messages:

  1. Select Medical | HL7 | Message Template.
  2. Select the template for outbound messages and click Segments.
  3. Select the segment and click Fields.
  4. Locate the field that should be allowed to repeat.
  5. If applicable, select the first component in the field. (For example, select field ID 3.1 as opposed to 3.2; select 5.1 as opposed to 5.3.) If the field has only one component, select that component.
  6. Click Settings.
  7. Ensure a Keyword Type is selected from the Keyword Type drop-down.
    Note:

    You must assign a Keyword Type to the first component in the field in order for the Repeating option to be respected. The field will repeat only if the trigger document has multiple values for this Keyword Type.

  8. Under Value Requirements, select Repeating.

    For fields with multiple components, the Repeating option is respected only if it is set on the first component. Selecting Repeating on the first component will allow the entire field to repeat.

  9. Click Save.