ReferralNet Agent - Configuring Receiving

The Agent's actions are the core of the application. Use this screen to instruct the Agent which messages require processing, and how to process them.

For the purposes of this guide, message refers to a set of attachments; similar in concept to an e-mail message. In the ReferralNet Client, each message corresponds to a row in your inbox. Attachment refers to an individual file that was sent within the message.

There are three important rules to consider when configuring the Agent:

Let's imagine that you have two actions configured:

• Rule One : Save any HL7 attachment to C:\HL7
• Rule Two : Save any HL7 attachment to C:\Temp

If a message is received with a HL7 attachment, in this scenario the HL7 attachment will be save to both C:\HL7 and C:\Temp.

Let's imagine that you have a single action configured:

• Save any HL7 attachment to C:\HL7

If a message is received that has a HL7 attachment and a Word document, the HL7 file will be saved to C:\Hl7, and the message will be removed from the ReferralNet inbox. The means the Word document will not be processed nor saved anywhere; it will be deleted. This will be logged in the agent's log file as "Ignoring filename".

Note: If there were any other actions that matched the Word document, those actions will still be applicable, and the Word document may not be deleted.

The "All other attachments" setting applies to messages that failed to match any action. Once an action matches any attachment in a message, no attachments from that message will be governed by the "all other attachments" setting.

If none of a message's attachments match an action, you can configure the Agent to either Leave on Server or Save to somewhere.

Leaving the messages on the server will allow you to view the messages with a different ReferralNet client, and is the recommended option.

If you opt to save the messages, the message will be downloaded, saved to the specified directory, and deleted from the ReferralNet server. When this option is enabled, you will not be able to read messages in the configured accounts with a different ReferralNet client.

If the message was unable to be processed, it will be saved to the path specified. If no path is specified, the failed message is deleted. Reasons for failure include failure to save to the destination directory due to permissions, and failure to decrypt the message.

If an SMTP server and email address has been configured on the Settings tab, you can opt to send an email to the administrator when failures occur.

We strongly recommend you always configure a directory to save failed messages

Configuring the Agent can be a complicated technical process. In order to provide some relief, the ReferralNet server have a collection of Presets, which describe commonly used actions.

To add an action using a preset, click on the Add button, select the preset, enter the path to save the files and click on Create.

There's three grouped elements that make up the definition of an action:

Each message that is sent through ReferralNet has a Message Classification which describes the type of message. For example, referrals are either urn:refnet:referral or urn:refnet::legacy-referral.

If you set the Message Classification selection criteria to anything that isn't – Any –, the attachment will only be matched if it is contained within a message with the specified classification.

The sender of a ReferralNet message can optionally classify each attachment. This is used, for example, to identify which attachment to display in the preview window when viewing a message.

When set to anything that isn't – Any –, the attachment will only be matched if it has that exact classification.

Each attachment in ReferralNet should have a filename. You can specify a wildcard (also known as a "filespec" or "glob") to select files.

Given the differences between operation systems and filenames, it's generally best to use the Attachment Content Type instead of the a filename wildcard.

Each attachment in ReferralNet must have a content type (also known as a MIME type). For example, all HL7 messages are expected to have a content type of text/hl7.

When set to anything that isn't – Any –, the attachment will only be matched if it has that exact content type.

If the attachment content type is set to text/hl7, you will be allowed to do filtering based on the HL7 Message Type and Trigger Event.

Some third party applications require the data to be modified before they are able to consume it. For example HL7 messages need to be slightly altered before Medical Director can consume it correctly.

If a transformation is selected, the attachment is decrypted, sent to the ReferralNet server (over an SSL encrypted connection), which then performs the required transformations.

The directory the attachment will be saved to.

The filename of the attachment will be a randomly generated unique filename.

Describing in English what the above screenshot achieves:

Ignoring the message classification, look at every attachment that the sender indicated contains patient data, where the patient data is encapsulated within a HL7 REF message. For the matching HL7 messages, modify the HL7 to conform to Medical Director's requirements, and save to the C:\Medical Director\Processing directory.

Configuring Sending