Outbound Configurations
An outbound configuration is an object created for results from a particular device type downloaded from particular locations. It provides the appropriate Panels in the outgoing HL7 message that carry the result’s values. The configuration also instructs the service on how to match the result’s Sample ID, whether a patient needs to be identified, and whether an order needs to be matched.
Jump to a heading on this page:
Institution Access
Adding
Editing
Cloning
Deactivating or Deleting
Fields
Institution Access
Outbound configurations are system-wide resources.
Adding
Outbound configurations can be added by customer support. See Add Fields for more information.
Editing
Outbound configurations can be edited by customer support. See View or Edit Details Fields for more information.
Cloning
Outbound configurations can be cloned by customer support. All values will be copied, except:
| Field | Notes |
|---|---|
| Name | The RALS™ SYSTEM will prompt you to enter a new one |
| Assigned Locations | Assigned locations are not copied |
Deactivating or Deleting
Outbound configurations can be deactivated by customer support. Deactivated configurations will not be considered for matching to a result.
Fields
Outbound configuration fields are located in the following places in the RALS™ SYSTEM:
Data Table Fields
When viewing outbound configurations in a data table, the fields are defined as follows:
| Field | Notes |
|---|---|
| General | |
| Name | Name of the outbound configuration |
| Device Type | Device type associated with the outbound configuration; select one from all enabled device types in system |
| Interface Type | Should Outbound process this configuration’s results? If so, should they have an order? |
| Match Multiple Panels | If disabled, only matches a single panel; if enabled, allows multiple panel matches |
| Enforce Notification Policy | If disabled, only matches a single panel; if enabled, allows multiple panel matches |
| HL7 Mode | Type of acknowledgement from LIS |
| Commit Ack Timeout | Number of seconds that the RALS™ SYSTEM waits for LIS acknowledgements |
| Outgoing Connection | Host and port where the RALS™ SYSTEM sends outgoing messages to Mirth |
| Incoming Connection | Port where the RALS™ SYSTEM listens for application acknowledges from Mirth |
| Assigned Locations | |
| Assigned Locations | Outbound will attempt to match this configuration to results downloaded from the locations assigned to it |
| Sample ID Format | |
| Medical Record Format | The regular expression (regex) that defines the format that the Medical Record should take |
| Account Format | The regular expression (regex) that defines the format that the Account should take |
| Visit Format | The regular expression (regex) that defines the format that the Visit should take |
| Episode Format | The regular expression (regex) that defines the format that the Episode should take |
| Order Format (Solicited only) | The regular expression (regex) that defines the format that the Order should take |
| Patient and Orders Matching | |
| Ignore ADT | If enabled, ADT Verification is not performed and other things |
| Time Before ADT Verification Failure | Number of minutes that the RALS™ SYSTEM allows for a valid patient history event before declaring the result Upload Failed |
| Include Inpatient | Should inpatient history events be considered when matching and ADT record to a result? |
| Include Outpatient | Should inpatient history events be considered when matching and ADT record to a result? |
| Include Units Other Than Result Location | If disabled, only includes units in result location; if enabled, doesn’t filter units other than result location |
| Include Discharged | If disabled, discharged history events are filtered out prior to matching a patient history event; if enabled, discharged history events are considered |
| Include NPOC Units | If disabled, NPOC Unit history events are filtered out prior to matching a patient history event; if enabled, NPOC Unit history events are considered |
| Minutes to Look Ahead for ADT Events | If an appropriate history event cannot be found before the result was run, how far in the future should we look for one? |
| Fail Discharged Patients | If disabled, allows matching to a discharged history event; if enabled, fail results matched to a discharged history event |
| Require Patient Status | Should we fail a result based on the inpatient/outpatient status of the matched history event? |
| Require Patient Location | Should we fail a result based on the history event’s unit relative to the result’s location? |
| Additional Institutions in Hospital | When matching a result to a history event that is required to be In Hospital, consider all institutions selected here as being in the hospital in addition to the result’s institution |
| Match Past Orders | Number of minutes before the result’s date/time that the RALS™ SYSTEM looks for a matching order |
| Match Future Orders | If no matching order exists before the result, how far in the future do we look for a matching order? |
| Patient ID Mapping | |
| Patient ID 1 – 4 | For each of the four patient identifier fields in the outgoing HL7 message, specify here the type of identifier the field should contain; if the system does not find an identifier of the specified type, the field will be blank |
| Comments | |
| Device ID | If enabled, Device ID comments will be sent with the outbound result; automatically populated by the outbound service |
| Operator ID | If enabled, Operator ID comments will be sent with the outbound result; automatically populated by the outbound service |
| Operator Name | If enabled, Operator Name comments will be sent with the outbound result; automatically populated by the outbound service |
| LIS Comment | If enabled, LIS comments will be sent with the outbound result |
| Chartable Comment | If enabled, chartable comments will be sent with the outbound result |
| Freetext and Non-Chartable Comments | If enabled, freetext and non-chartable comments will be sent with the outbound result |
| Result Value Comment | If enabled, result value comments will be sent with the outbound result |
| Material Lot | If enabled, material lot comments will be sent with the outbound result |
| Material Expiration Date | If enabled, material expiration date comments will be sent with the outbound result |
| NTEs | |
| NTE Handling | How the RALS™ SYSTEM handles multiple NTEs |
| NTE Delimiter | Character used between each individual comment when the RALS™ SYSTEM is configured to send multiple comments as a single NTE |
| Panels | |
| Panel Count | The number of panels on the outbound configuration |
| Notes | |
| Notes | Open text field that can be used at your discretion |
Add Fields
When adding an outbound configuration, the fields are defined as follows:
| Field | Notes |
|---|---|
| General | |
| Name | Name of the outbound configuration |
| Device Type | Device type associated with the outbound configuration; select one from all enabled device types in system |
| Interface Type | Should Outbound process this configuration’s results? If so, should they have an order? |
| Match Multiple Panels | If disabled, only matches a single panel; if enabled, allows multiple panel matches |
| Enforce Notification Policy | If disabled, only matches a single panel; if enabled, allows multiple panel matches |
| HL7 Mode | Type of acknowledgement from LIS; select one: Original Mode Acknowledgement (CA); Enhanced Mode Acknowledgement (AA) |
| Commit Ack Timeout (Seconds) | Number of seconds that the RALS™ SYSTEM waits for LIS acknowledgements |
| Outgoing Connection | Host and port where the RALS™ SYSTEM sends outgoing messages to Mirth |
| Incoming Connection | Port where the RALS™ SYSTEM listens for application acknowledges from Mirth |
| Assigned Locations | |
| Assigned Locations | Outbound will attempt to match this configuration to results downloaded from the locations assigned to it; note that if any Assigned Institutions are selected, all locations within those institutions are automatically assigned to this configuration, even if unselected in the location picker tree below; if a location has been assigned to a different configuration, it will not be available to assign to this one (except the RALS™ SYSTEM will allow assignment to one Solicited and one Unsolicited) |
| Sample ID Format | |
| Medical Record Format | The regular expression (regex) that defines the format that the Medical Record should take |
| Account Format | The regular expression (regex) that defines the format that the Account should take |
| Visit Format | The regular expression (regex) that defines the format that the Visit should take |
| Episode Format | The regular expression (regex) that defines the format that the Episode should take |
| Order Format (Solicited only) | The regular expression (regex) that defines the format that the Order should take |
| Patient and Orders Matching | |
| Ignore ADT | If enabled, ADT Verification is not performed and other things |
| Time Before ADT Verification Failure | Number of minutes that the RALS™ SYSTEM allows for a valid patient history event before declaring the result Upload Failed |
| Include Inpatient | Should inpatient history events be considered when matching and ADT record to a result?; select one: include → Inpatient history events are considered, unless outpatient history events are preferred and available; exclude → Inpatient history events are filtered out prior to matching a patient history event; prefer → Inpatient history events are considered |
| Include Outpatient | Should inpatient history events be considered when matching and ADT record to a result?; select one: include → Outpatient history events are considered, unless inpatient history events are preferred and available; exclude → Outpatient history events are filtered out prior to matching a patient history event prefer → Outpatient history events are considered |
| Include Units Other Than Result Location | If disabled, only includes units in result location; if enabled, doesn’t filter units other than result location |
| Include Discharged | If disabled, discharged history events are filtered out prior to matching a patient history event; if enabled, discharged history events are considered |
| Include NPOC Units | If disabled, NPOC Unit history events are filtered out prior to matching a patient history event; if enabled, NPOC Unit history events are considered |
| Minutes to Look Ahead for ADT Events | If an appropriate history event cannot be found before the result was run, how far in the future should we look for one? |
| Fail Discharged Patients | If disabled, allows matching to a discharged history event; if enabled, fail results matched to a discharged history event; unchecked → allow matching to a discharged history event; checked → fail results matched to a discharged history event |
| Require Patient Status | Should we fail a result based on the inpatient/outpatient status of the matched history event? |
| Require Patient Location | Should we fail a result based on the history event’s unit relative to the result’s location? |
| Additional Institutions in Hospital | When matching a result to a history event that is required to be In Hospital, consider all institutions selected here as being in the hospital in addition to the result’s institution |
| Match Past Orders | Number of minutes before the result’s date/time that the RALS™ SYSTEM looks for a matching order |
| Match Future Orders | If no matching order exists before the result, how far in the future do we look for a matching order? |
| Patient ID Mapping | |
| Patient ID 1 – 4 | For each of the four patient identifier fields in the outgoing HL7 message, specify here the type of identifier the field should contain; if the system does not find an identifier of the specified type, the field will be left blank; select one: None - for fields that are not intended to ever be populated; Sample ID - system will populate the identifier with whatever the result’s Sample ID field contains; Episode; Visit; Account; Medical Record |
| Comments | |
| Device ID | If enabled, Device ID comments will be sent with the outbound result; automatically populated by the outbound service |
| Operator ID | If enabled, Operator ID comments will be sent with the outbound result; automatically populated by the outbound service |
| Operator Name | If enabled, Operator Name comments will be sent with the outbound result; automatically populated by the outbound service |
| LIS Comment | If enabled, LIS comments will be sent with the outbound result |
| Chartable Comment | If enabled, chartable comments will be sent with the outbound result |
| Freetext and Non-Chartable Comments | If enabled, freetext and non-chartable comments will be sent with the outbound result |
| Result Value Comment | If enabled, result value comments will be sent with the outbound result |
| Material Lot | If enabled, material lot comments will be sent with the outbound result |
| Material Expiration Date | If enabled, material expiration date comments will be sent with the outbound result |
| NTEs | |
| NTE Handling | How the RALS™ SYSTEM handles multiple NTEs; select one: Multiple NTEs, Single Delimited NTE |
| NTE Delimiter | Character used between each individual comment when the RALS™ SYSTEM is configured to send multiple comments as a single NTE |
| Panels | |
| Panels | List of the configuration’s panels by name in priority order; see Panels |
| Notes | |
| Notes | Open text field that can be used at your discretion |
View or Edit Details Fields
When viewing or editing an outbound configuration’s details, the fields are defined as follows:
| Field | Notes |
|---|---|
| General | |
| Name | Name of the outbound configuration |
| Device Type | Device type associated with the outbound configuration; select one from all enabled device types in system |
| Interface Type | Should Outbound process this configuration’s results? If so, should they have an order? |
| Match Multiple Panels | If disabled, only matches a single panel; if enabled, allows multiple panel matches |
| Enforce Notification Policy | If disabled, only matches a single panel; if enabled, allows multiple panel matches |
| HL7 Mode | Type of acknowledgement from LIS; select one: Original Mode Acknowledgement (CA); Enhanced Mode Acknowledgement (AA) |
| Commit Ack Timeout (Seconds) | Number of seconds that the RALS™ SYSTEM waits for LIS acknowledgements |
| Outgoing Connection | Host and port where the RALS™ SYSTEM sends outgoing messages to Mirth |
| Incoming Connection | Port where the RALS™ SYSTEM listens for application acknowledges from Mirth |
| Assigned Locations | |
| Assigned Locations | Outbound will attempt to match this configuration to results downloaded from the locations assigned to it; note that if any Assigned Institutions are selected, all locations within those institutions are automatically assigned to this configuration, even if unselected in the location picker tree below; if a location has been assigned to a different configuration, it will not be available to assign to this one (except the RALS™ SYSTEM will allow assignment to one Solicited and one Unsolicited) |
| Sample ID Format | |
| Medical Record Format | The regular expression (regex) that defines the format that the Medical Record should take |
| Account Format | The regular expression (regex) that defines the format that the Account should take |
| Visit Format | The regular expression (regex) that defines the format that the Visit should take |
| Episode Format | The regular expression (regex) that defines the format that the Episode should take |
| Order Format (Solicited only) | The regular expression (regex) that defines the format that the Order should take |
| Patient and Orders Matching | |
| Ignore ADT | If enabled, ADT Verification is not performed and other things |
| Time Before ADT Verification Failure | Number of minutes that the RALS™ SYSTEM allows for a valid patient history event before declaring the result Upload Failed |
| Include Inpatient | Should inpatient history events be considered when matching and ADT record to a result?; select one: include → Inpatient history events are considered, unless outpatient history events are preferred and available; exclude → Inpatient history events are filtered out prior to matching a patient history event; prefer → Inpatient history events are considered |
| Include Outpatient | Should inpatient history events be considered when matching and ADT record to a result?; select one: include → Outpatient history events are considered, unless inpatient history events are preferred and available; exclude → Outpatient history events are filtered out prior to matching a patient history event prefer → Outpatient history events are considered |
| Include Units Other Than Result Location | If disabled, only includes units in result location; if enabled, doesn’t filter units other than result location |
| Include Discharged | If disabled, discharged history events are filtered out prior to matching a patient history event; if enabled, discharged history events are considered |
| Include NPOC Units | If disabled, NPOC Unit history events are filtered out prior to matching a patient history event; if enabled, NPOC Unit history events are considered |
| Minutes to Look Ahead for ADT Events | If an appropriate history event cannot be found before the result was run, how far in the future should we look for one? |
| Fail Discharged Patients | If disabled, allows matching to a discharged history event; if enabled, fail results matched to a discharged history event; unchecked → allow matching to a discharged history event; checked → fail results matched to a discharged history event |
| Require Patient Status | Should we fail a result based on the inpatient/outpatient status of the matched history event? |
| Require Patient Location | Should we fail a result based on the history event’s unit relative to the result’s location? |
| Additional Institutions in Hospital | When matching a result to a history event that is required to be In Hospital, consider all institutions selected here as being in the hospital in addition to the result’s institution |
| Match Past Orders | Number of minutes before the result’s date/time that the RALS™ SYSTEM looks for a matching order |
| Match Future Orders | If no matching order exists before the result, how far in the future do we look for a matching order? |
| Patient ID Mapping | |
| Patient ID 1 – 4 | For each of the four patient identifier fields in the outgoing HL7 message, specify here the type of identifier the field should contain; if the system does not find an identifier of the specified type, the field will be left blank; select one: None - for fields that are not intended to ever be populated; Sample ID - system will populate the identifier with whatever the result’s Sample ID field contains; Episode; Visit; Account; Medical Record |
| Comments | |
| Device ID | If enabled, Device ID comments will be sent with the outbound result; automatically populated by the outbound service |
| Operator ID | If enabled, Operator ID comments will be sent with the outbound result; automatically populated by the outbound service |
| Operator Name | If enabled, Operator Name comments will be sent with the outbound result; automatically populated by the outbound service |
| LIS Comment | If enabled, LIS comments will be sent with the outbound result |
| Chartable Comment | If enabled, chartable comments will be sent with the outbound result |
| Freetext and Non-Chartable Comments | If enabled, freetext and non-chartable comments will be sent with the outbound result |
| Result Value Comment | If enabled, result value comments will be sent with the outbound result |
| Material Lot | If enabled, material lot comments will be sent with the outbound result |
| Material Expiration Date | If enabled, material expiration date comments will be sent with the outbound result |
| NTEs | |
| NTE Handling | How the RALS™ SYSTEM handles multiple NTEs; select one: Multiple NTEs, Single Delimited NTE |
| NTE Delimiter | Character used between each individual comment when the RALS™ SYSTEM is configured to send multiple comments as a single NTE |
| Panels | |
| Panels | List of the configuration’s panels by name in priority order; see Panels |
| Notes | |
| Notes | Open text field that can be used at your discretion |