Browse the documentation

Draft — being checked against the app

Installing the site agent

The small Windows service that prints, serves the modality worklist and relays HL7 on a site's own network.

AdministratorsPractice managersLast updated

Some jobs have to happen on a site's own network: sending reports and receipts to the site's printers, answering scanners' worklist queries, and passing HL7 messages to a local PACS or RIS. The Clarirad site agent does these. It is a Windows service, with a tray icon, installed on one always-on computer at the site.

Setting it up

  1. Ask Clarirad support for the site agent installer and install it on the site computer.
  2. In Clarirad, open Settings and, under 'Integrations', choose 'Site Agents'.
The Site Agents page with one site agent, its status, DICOM AE title, port, assigned site and security token, and the Add Agent button.
  1. Choose 'Add Agent'. Under 'Kind of agent', choose 'Site agent (printing, worklist, HL7 folder)'.
  2. Enter the 'DICOM AE Title' and 'MWL Port' if the agent will serve a worklist, pick the sites it works for, and choose 'Create Agent'.
The Create Site Agent window with Site agent chosen as the kind of agent, a name, DICOM AE title and MWL port filled in, one site ticked, and Create Agent.
  1. Under 'Security Token', choose 'Reveal' and then 'Copy token'.
A site agent's card, Pending and never seen, with its DICOM AE title, port and assigned site, and the Security Token section with the token hidden and Reveal, Regenerate and copy.
  1. On the site computer, open the agent's local dashboard and paste the token in. The agent connects to Clarirad.

Back in 'Site Agents', the agent shows 'Pending' until it first connects, then 'Online', with when it was last seen and its version. The test button (the lightning icon) checks it is answering.

Printers

The agent reports the printers it can see under 'Detected Printers'. Then decide what prints where in Settings, under 'Integrations', then 'Printing':

  • 'Printers': each printer and its state: 'Ready', 'Problem', 'Offline' or 'Not reported yet'.
  • 'What prints where': which document (a signed report, a receipt, an invoice or a referral letter) prints on which printer, and when: when a report is signed, when an invoice is paid, or only when printed by hand.
  • 'Failed prints': jobs that did not print. Choose 'Reprint' once the printer is fixed.
  • 'Usage': how much each printer has printed.
The Printing settings for a site, with the Printers, What prints where, Failed prints and Usage tabs.
The What prints where tab of the Printing settings with the Add rule button.

Worklist and scanners

Under 'Worklist Configuration', choose the 'Delivery Mode' ('DICOM MWL', 'HL7' or both) and which scanner AE titles may ask for the worklist. New scanners appear under 'Scanners'; choose 'Approve' or 'Block' for each.

A site agent's card with Worklist Configuration open, showing the Delivery Mode menu set to HL7, the HL7 output folder and Push to Agent.

If the agent goes offline

  • Check the site computer is on and connected to the internet.
  • Check the agent's tray icon and local dashboard for an error.
  • Jobs are queued while it is offline and sent once it reconnects.