ReferralNet Agent - Interfacing

This document describes how to use the ReferralNet Agent to send messages via ReferralNet.

This document is intended for application developers who want to provide tighter integration with the Agent.

An "interactive" agent send will always display the agent's send window.

1. Configure the agent to monitor a specific directory (specifying "Interactive")
2. Save a file in the specified directory
3. The agent will display the send confirmation dialog

Execute ReferralNetAgent.exe with a -send parameter.

ReferralNetAgent.exe -send filename

For example:

ReferralNetAgent.exe -send "C:\Program Files\Application\Out\file.txt"

If you already know the ReferralNet recipient (eg urn:refnet:username), you can use the agent to send files without displaying the send confirmation dialog.

Non-interactive mode only works as file-drops for specific file formats

1. Configure the agent to monitor a specific directory (specifying "Non-Interactive")
2. Save a file in the specified directory

Specify the ReferralNet username in the name of the file you drop. The agent will find the first invalid username character and ignore it and all trailing characters. The username will always be prefixed with urn:refnet:.

The following characters are valid in a ReferralNet username: a-z A-Z 0-9 . - (space)

For example:

timc_CB05E6CA-B47E-4858-8BC0-2096BD564D1C.hl7    // original filename
--> "timc_CB05E6CA-B47E-4858-8BC0-2096BD564D1C"  // strip extension
--> "timc"                                       // first invalid char = _, strip from there
--> "urn:refnet:timc"                            // prepend urn:refnet:

Send to the ReferralNet username specified in the HL7's receiving facility (MSH.6). All other HL7 fields are ignored. The username will always be prefixed with urn:refnet: if the username is not already full qualified.

For example:

MSH|^~\&|Application|Somewhere|ReferralNet|urn:refnet:timc|20080724140844+0800||ADT^A13|5108|P|2.3
                                           ^^^^^^^^^^^^^^^

Send to the ReferralNet username specified in PRD.7.1 where PRD.1.1 is "RT". The username will always be prefixed with urn:refnet: if the username is not already full qualified.

For example:

MSH|^~\&|Application|Somewhere|ReferralNet|Someone|20080724140844+0800||REF^I12|5109|P|2.3.1
...
PRD|RP|^^^^^^L|^^^^|^^^Somewhere Clinic
PRD|RT|Clarke^Tim^^^^^L|^^^^||||urn:refnet:timc^REFNET
    ^^                          ^^^^^^^^^^^^^^^
...

Send to the ReferralNet username specified in the PIT file's MsgRecipient header. The username will always be prefixed with urn:refnet: if the username is not already full qualified.

For example:

MsgRecipient=urn:refnet:timc
Author=James Jekyll
001 Albert Rd Medical Centre                                   07 01/07/1996
002 
003 Report Run Number: 0006 Created:   08/07/2009      at    18:06:00
009 --------------------------------------------------------------------------
010 Dr James Jekyll                              0000000A
019 ---------------------------------------------------------------------------
...
999 END OF LISTING - Run Number:0006  08/07/2009  18:06:00