<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: HL7 Sensor

The HL7 sensor monitors the availability of Health Level 7 (HL7) interfaces. It sends an HL7 message to the target device and checks for a valid response.

i_round_blueYou can define your own messages in HL7 format as .hl7 files in the PRTG program directory. The sensor sends them to the HL7-capable system with each scanning interval.

HL7 Sensor

HL7 Sensor

i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

  • Dutch: HL7
  • French: HL7
  • German: HL7
  • Japanese: HL7
  • Portuguese: HL7
  • Russian: HL7
  • Simplified Chinese: HL7
  • Spanish: HL7

Remarks

  • This sensor requires Microsoft .NET 4.7.2 or later on the probe system.
  • This sensor supports the IPv6 protocol.
  • This sensor has a medium performance impact.
  • This sensor uses lookups to determine the status values of one or more channels. This means that possible states are defined in a lookup file. You can change the behavior of a channel by editing the lookup file that the channel uses. For details, see section Define Lookups.

Detailed Requirements

Requirement

Description

.NET 4.7.2 or later

This sensor requires .NET 4.7.2 or later to be installed on the probe system (on every cluster node, if on a cluster probe).

i_round_redIf the framework is missing, you cannot create this sensor.

i_square_cyanFor more information, see the Knowledge Base: Which .NET version does PRTG require?

Add Sensor

The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. You can change nearly all settings on the sensor's Settings tab after creation.

HL7 Message Specific

Setting

Description

HL7 Messages

Select an .hl7 file from the list. The sensor sends it to the target device with every scanning interval.

The list shows all files that are available in the \Custom Sensors\hl7 subfolder of the PRTG program directory on the probe system. For files to appear in this list, store them in this subfolder with the extension .hl7.

i_round_redTo be accepted by the HL7 interface, your files must have the expected HL7 message format. PRTG comes with two sample .hl7 message files that you can use to test your HL7 monitoring and to have a look at the expected format. These files are in the \Custom Sensors\hl7 subfolder.

i_round_blueYou can override certain headers using the Message Header sensor setting.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

Sensor Name

Enter a name to identify the sensor.

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe.

i_round_blueThis setting is for your information only. You cannot change it.

Tags

Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited.

i_round_blueIt is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).

i_round_blueFor performance reasons, it can take some minutes until you can filter for new tags that you added.

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

  • dicom
  • hl7

Priority

Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority (i_priority_1) to the highest priority (i_priority_5).

i_round_blueUsually, a sensor connects to the IP Address/DNS Name of the parent device. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings.

HL7 Connection

HL7 Connection

HL7 Connection

Setting

Description

Port

Enter the port of the HL7 interface that the sensor uses for the connection.

Timeout (Sec.)

Enter a timeout in seconds for the request. Enter an integer. The maximum timeout value is 900 seconds (15 minutes).

i_round_blueIf the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message.

HL7 Message Specific

HL7 Message Specific

HL7 Message Specific

Setting

Description

Message Header

Define if you want to use the default message header (MSH) as defined in the selected .hl7 message file or if you want to override certain headers:

  • Default message header: Send the MSH as defined in the .hl7 message file.
  • Override message header: Define a custom MSH below that overrides the MSH in the .hl7 message file.

Sending Application

This setting is only visible if you select Override message header above. Enter the name of the sending application, for example, PRTG. It overrides the default value in the message. Enter a string.

Sending Facility

This setting is only visible if you select Override message header above. Enter the name of the sending facility. It overrides the default value in the message. Enter a string.

Receiving Application

This setting is only visible if you select Override message header above. Enter the name of the receiving application. It overrides the default value in the message. Enter a string.

Receiving Facility

This setting is only visible if you select Override message header above. Enter the name of the receiving facility. It overrides the default value in the message. Enter a string.

HL7 Message

Shows the .hl7 message file that the sensor uses to send the message with each scanning interval.

i_round_bluePRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

  • Discard result: Do not store the sensor result.
  • Store result: Store the last sensor result in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file names are Result of Sensor [ID].txt, Result of Sensor [ID].Data.txt, and Result of Sensor [ID].log. This setting is for debugging purposes. PRTG overwrites these files with each scanning interval.

i_podThis option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.

i_round_blueIn a cluster, PRTG stores the result in the PRTG data directory of the master node.

Sensor Display

Sensor Display

Sensor Display

Setting

Description

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.

i_round_blueYou can set a different primary channel later by clicking b_channel_primary below a channel gauge on the sensor's Overview tab.

Graph Type

Define how different channels are shown for this sensor:

  • Show channels independently (default): Show a graph for each channel.
  • Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
    i_round_redYou cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This setting is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are stacked on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.

Inherited Settings

By default, all of these settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

Scanning Interval

Scanning Interval

i_square_cyanFor more information, see section Root Group Settings, section Scanning Interval.

Schedules, Dependencies, and Maintenance Window

i_round_blueYou cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.

Schedules, Dependencies, and Maintenance Window

Schedules, Dependencies, and Maintenance Window

i_square_cyanFor more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.

Access Rights

Access Rights

Access Rights

i_square_cyanFor more information, see section Root Group Settings, section Access Rights.

Channel List

i_round_blueWhich channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.

Channel

Description

ACK Status

Acknowledgment (ACK) status

  • Up status: Accept
  • Down status: Error, Reject

Downtime

In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status in percent.

Message Control ID OK

The message control ID status

  • Up status: Yes
  • Down status: No

Response Time

The response time in msec

i_round_blueThis channel is the primary channel by default.

More

i_square_blueKnowledge Base

Which .NET version does PRTG require?

What security features does PRTG include?