quentry on-site deployment guide€¦ · b updated section 2.3 dicom proxy settings and gateway...

39
Regulation Field: Support and Operations Number: SP2S00544 Version: G Subject: Quentry On-Site Deployment Guide Page 1 of 36 1 Quentry On-Site Deployment Guide AUDIT TRAIL Change # Version Change Description Date (mmm-yyyy) (i.e. Apr-2011) Approved By ----- A Initial version Oct-2016 Shlomy Shivek B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in Gateway and Patient Forms and DBS workflow Sep-2017 Shlomy Shivek D Updated for the TNG use cases Dec-2017 Zohar Brin E Update Auto-Sizer URL format in section 6 Use case: Quentry for TNG Feb-2018 Sagi Gershon F Added IP address for Quentry external services. Added section for dynamic forms offline mode Aug-2018 Shlomy Shivek G DBS use case updated Nov-2020 Shlomy Shivek Date & Signature Position Name R&D Manager Shlomy Shivek Prepared by General Manager Yifat Mushkin Reviewed by General Manager Yifat Mushkin Approved by

Upload: others

Post on 20-Aug-2020

3 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 1 of 36

1

Quentry On-Site Deployment Guide

AUDIT TRAIL

Change # Version Change Description Date

(mmm-yyyy)

(i.e. Apr-2011)

Approved By

----- A Initial version Oct-2016 Shlomy Shivek

B Updated section 2.3

DICOM Proxy settings and

Gateway installation

behind proxy server

Dec-2016 Shlomy Shivek

C Updated for R13 changes

in Gateway and Patient

Forms and DBS workflow

Sep-2017 Shlomy Shivek

D Updated for the TNG use

cases

Dec-2017 Zohar Brin

E

Update Auto-Sizer URL

format in section 6 Use

case: Quentry for TNG

Feb-2018 Sagi Gershon

F Added IP address for

Quentry external services.

Added section for dynamic

forms offline mode

Aug-2018 Shlomy Shivek

G DBS use case updated Nov-2020 Shlomy Shivek

Date & Signature Position Name

R&D Manager Shlomy Shivek Prepared by

General Manager Yifat Mushkin Reviewed by

General Manager Yifat Mushkin Approved by

Page 2: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 2 of 36

2

Table of Contents

1. Purpose ......................................................................................................................... 4

2. Quentry Gateway ........................................................................................................... 4

2.1 Installation ............................................................................................................................. 4

The Quentry Gateway is installed in the following directory: ................................................. 5

2.1.1 .NET Framework prerequisites .................................................................................. 5

2.1.2 Proxy Settings ............................................................................................................... 6

2.1.3 SSL Settings ................................................................................................................. 7

2.1.4 Pre-Upload Configuration ............................................................................................ 9

2.2 Configuration ....................................................................................................................... 10

2.2.1 Link to Business Account .......................................................................................... 10

2.2.2 Setting Gateway Name.............................................................................................. 12

2.2.3 DICOM Server Settings ............................................................................................. 13

2.2.4 Routing Rules ............................................................................................................. 15

2.2.5 Re-linking the Gateway ............................................................................................. 16

2.2.6 Mapping de-identified patient details ....................................................................... 18

2.3 PDM (DICOM Proxy) Settings .......................................................................................... 20

2.3.1 Query / Retrieve from the Gateway ......................................................................... 22

2.3.2 Auto Forwarding ......................................................................................................... 24

2.3.3 Manual Forwarding .................................................................................................... 25

2.4 Uninstall ...................................................................................................................................... 27

3. Patient Consent ........................................................................................................... 28

3.1 Patient Consent Tool for PDM.......................................................................................... 29

3.1.1 Installation ................................................................................................................... 29

3.1.2 Configuration ............................................................................................................... 30

3.2 Enforcing Consent in Quentry Gateway Upload Rules ................................................ 31

4. Patient Form ................................................................................................................ 33

4.1 Installation ........................................................................................................................... 33

Page 3: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 3 of 36

3

4.2 Exporting Patient Form from PDM ................................................................................... 34

4.3 Offline mode ........................................................................................................................ 34

5. Quentry Network Access .............................................................................................. 35

6. Use case: Quentry for DBS .......................................................................................... 37

6. Use case: Quentry for AutoSizer .................................................................................. 39

Page 4: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 4 of 36

4

1. Purpose

The purpose of this document is to guide you through the different components that can be

installed in the hospital environment (“Ground Components”) to allow connectivity to the Big

Data Quentry server and integration with other Brainlab installed devices using the PDM.

This guide targets Brainlab employees and is not intended to be used by customers.

2. Quentry Gateway

The Quentry Gateway application is used for data transfer to/from hospital DICOM node

applications (PACS, modality etc.) and Quentry. It is used as DICOM node that supports

DICOM C-FIND, C-STORE and C-GET commands.

The Quentry Gateway enhances the PDM integration with Quentry. From PDM users can:

1. Identify Quentry as a data export destination

2. Auto forward all DICOM data to the Gateway avoiding manual export

3. Retrieve Quentry patients in the patient selection page

2.1 Installation

Before installing the Quentry Gateway, please make sure all pre-requisites are properly

installed on the server. The entire list of pre-requisites can be found in the Quentry Gateway

user guide under the Quentry Web Portal Help section.

Quentry Gateway installation requires special permissions for configuring Windows service

and other operating system settings. Make sure you are logged to the operating system

using a user with administrative rights when performing this procedure.

Quentry Gateway can be installed using the Brainlab’s Master Installer application. Select

the “Quentry Gateway for Big Data” package from the list of available packages:

Page 5: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 5 of 36

5

The Quentry Gateway is installed in the following directory:

o C:\Program Files (x86)\Brainlab\Quentry Gateway

Quentry Gateway service and configuration tool log files can be found in the regular Brainlab

log files folder under:

o Brainlab\LogFiles\QuentryGatewayEnterprise_[version]

o Brainlab\LogFiles\GatewayConfigurationTool_[version]

2.1.1 .NET Framework prerequisites

Quentry Gateway requires .net framework 4 to be installed as a prerequisite. This is usually already

available for new servers or can be manually installed by downloading the right package from

Microsoft.

Special use case for Windows Server 2008 32bit, please use the following instruction in order to

install the .net framework:

1. Download Microsoft .NET Framework 4.5.1 (Offline Installer) Link: https://support.microsoft.com/en-us/help/2858728/the--net-framework-4-5-1-offline-installer-and--net-

framework-4-5-1-la

Note:

- The old Quentry Desktop integration with PDM may still be available in the Master

Installer packages list or already installed with your PDM. It should only be used

for specific use cases and is out of the scope of this document. Unless needed,

we recommend uninstalling it.

- You may also find another package called “Quentry Gateway”. This package

should only be used for the SRS Registry project and is out of the scope of this

document.

- Upgrade of existing Quentry Gateway installation is currently not supported.

Please uninstall existing Gateway before installing a new one. See details how to

uninstall Quentry Gateway later in this document.

Page 6: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 6 of 36

6

2. Install Microsoft .NET Framework 4.5.1 (restart may be required) 3. Apply all Windows Updates including optional updates.

2.1.2 Proxy Settings

Gateway proxy settings allows the Gateway service to communicate with Quentry behind a

Proxy Server. This setting is only required for sites where Internet access is behind proxy

server.

For installation behind a Proxy Server, the Gateway settings file must be updated with the

Proxy Server settings and credentials following the steps below:

1. Open Windows services console dialog and stop the Gateway service.

2. Quentry ConfigUpdateTool application is used to change settings in the Gateway

configuration files. Some of them are encrypted (like proxy credentials) so you cannot

manually edit them with a regular text editor. The tool can be found under the

Gateway installation folder:

o C:\Program Files (x86)\Brainlab\Quentry Gateway\Support\ConfigUpdateTool

3. Use the tool in a command line with the following command line arguments:

ConfigUpdateTool.exe "ConfigFile=[path to Quentry Gateway configuration

file]&ProxyHostName=[proxy server host name]&ProxyPort=[proxy server listening

port]&ProxyDomainName=[proxy server domain]&ProxyUserName=[proxy server

credentials username]&ProxyPassword=[proxy server credentials password]".

For example:

ConfigUpdateTool.exe

"ConfigFile=QuentryConfiguration_Production.xml&ProxyHostName=test

123&ProxyPort=1234&ProxyDomainName=Domain Name&ProxyUserName=user

name&ProxyPassword=My Password"

Note: proxy credentials are not always required and can be ignored.

Page 7: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 7 of 36

7

4. Start the Quentry Gateway service again

2.1.3 SSL Settings

Gateway SSL settings configures the Gateway service to use HTTPS and therefore be

accessed securely over the network.

In order to configure the gateways to use HTTPS please do the following steps:

1. Open Windows services console dialog and stop the Gateway service.

2. Open QuentryGatewayEnterprise.exe.config located in the gateway installation folder

and make the following changes:

Change bindingConfiguration="VLEMessagesBinding" to

bindingConfiguration="VLESecureMessagesBinding"

<endpoint address="/Messaging"

binding="basicHttpBinding"

bindingConfiguration="VLESecureMessagesBinding"

behaviorConfiguration="VLEVoyantWCFEndPointBehavior"

contract="VoyantHealth.Common.Messages.IMessagingService">

Change bindingConfiguration="VLEStreamBinding" to

bindingConfiguration="VLESecureStreamBinding"

<endpoint address="/Streaming"

binding="basicHttpBinding"

bindingConfiguration="VLESecureStreamBinding"

contract="VoyantHealth.Common.Messages.IStreamService">

Change bindingConfiguration=" GwWebAppBindingHTTP " to

bindingConfiguration=" GwWebAppBindingHTTPS "

Page 8: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 8 of 36

8

<endpoint address=""

binding="webHttpBinding"

contract="VoyantHealth.Feeder.Enterprise.WinService.WCFServerSide.In

terfaces.IGeneralRestfulService"

behaviorConfiguration="CORSEnabledHTTPBehavior"

bindingConfiguration="GwWebAppBindingHTTPS">

Change the base address URL to https

<add baseAddress="https://localhost/VoyantLinkWCFService"/>

3. Edit the Quentry Gateway web application web.config file located at the Gateway

installation folder

<add key="VoyantLinkEnterpriseService"

value="https://localhost/VoyantLinkWCFService/Messaging"/>

4. Edit the Quentry Gateway Configuration Tool configuration file

GatewayConfigurationTool.exe.config located in the Gateway installation folder to

use HTTPS.

<add key="VoyantLinkEnterpriseService"

value="https://localhost/VoyantLinkWCFService/Messaging"/>

Page 9: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 9 of 36

9

2.1.4 Pre-Upload Configuration

In order to improve upload performance, Quentry Gateway can prevent uploading again an

image that already exists in Quentry. By default this functionality is enabled.

Please follow the following procedure for special use cases that requires disabling it:

Open QuentryConfiguration_production.xml located in the gateway installation folder and

make the following changes:

<IsPreUploadEnabled>false</IsPreUploadEnabled>

Page 10: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 10 of 36

10

2.2 Configuration

After installation, configure the Gateway to allow DICOM communication and access to

Quentry Accounts. Quentry Gateway configuration is done using a configuration tool

installed on the target machine.

Click the Quentry Gateway Configuration Tool in the Start menu to launch the

configuration tool.

2.2.1 Link to Business Account

First the gateway should be linked to a specific business account. Quentry Business Account

represents a specific site in Quentry (e.g. department, small clinic, hospital). A Quentry user

is assigned as administrator of the Account and can manage one or more CareTeams.

By linking the Gateway to an Account, the Account administrator gets full control over the

Gateway including setting permissions and access to the Gateway activity report.

At this stage you can link the Gateway to your personal Support user Account. On

completion of the configuration you will be able to re-link the Gateway to the customer’s

Account. For more details about re-linking the Gateway see paragraph 3.2.5 .

By logging into the configuration tool, the Gateway is automatically linked to your Account.

Enter your Quentry.com Account credentials and click the login button.

Page 11: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 11 of 36

11

Gateways linked to the Business Account are listed in Quentry web portal Account Settings

under Gateway Management.

Page 12: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 12 of 36

12

More details about Gateway settings and management can be found in the Quentry Web

Portal user guide under the Quentry Web Portal Help section.

2.2.2 Setting Gateway Name

In the ‘System Settings’ tab define the Gateway name. The Gateway name is an identifier of

the installed Gateway and is displayed in the Quentry Portal in the ‘Uploaded By’ field and in

the Audit logs for each dataset uploaded by or actions performed by the Gateway. This

name can be modified later via Quentry portal in the Account Gateway Settings.

Page 13: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 13 of 36

13

2.2.3 DICOM Server Settings

In the ‘Server Settings’ tab configure the Calling AE Title and the Port number to be used as

the DICOM listener settings for the Gateway and press Save.

Page 14: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 14 of 36

14

DICOM Settings description:

Field Description

Calling AE Title Gateway AE title

Port

The port that Quentry Gateway uses to listen for incoming

DICOM

Enable DICOM Logging Enables the logging of DICOM actions between Quentry

Gateway and the DICOM node, in order to identify

inconsistencies during the communication between the

systems.

You must enter a log-level value provided by Brainlab

support when enabling DICOM logging. The DICOM logs are

located in the Windows service installation folder

This setting should only be used for troubleshooting

support cases

Note:

- Default port 6599 may already be used by Quentry Desktop if already installed on

the machine. In this case we recommend to uninstall Quentry Desktop.

- Validate the ports by checking the numeric values within the allowed port

numbers range.

- All fields are mandatory in PACS/SCU configuration.

- Quentry Gateway settings are configured by administrators only (typically

customer's IT/PACS administrator) who must be responsible for entering correct

information for their own systems.

Page 15: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 15 of 36

15

2.2.4 Routing Rules

Routing rules are used for uploading data to Quentry accounts. The routing rules are

triggered for each dataset that is being pushed (C-STORE) to the Gateway. In addition to

setting the recipient of the uploaded dataset, the routing rules can also enforce the following:

- De-identification: all data that is uploaded to the selected recipient will be de-

identified by the Gateway prior to upload.

- Patient consent: patient consent must be required before uploading to Quentry. See

Chapter 4 for more details.

In the ‘Routing Rules’ tab define the rules enforced by the Quentry Gateway when sending

pushed images

You can either define a ‘Default Recipient’ or press the ‘Add Rule’ button to define a set of

rules.

Page 16: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 16 of 36

16

Please notice that the selected recipient must accept the uploading request from the

Gateway before you start uploading. More details about Gateway routing rules configuration

can be found in the Quentry Gateway user guide under the Quentry Web Portal Help

section.

2.2.5 Re-linking the Gateway

The last configuration step consists of linking the Gateway to the customer’s Quentry

Account. Your Support role user allows you to search and link the Gateway to a different

Account using the Quentry Gateway configuration tool. The Account name to be used here

should be provided to you as part of the installation request.

1. Click again on Quentry Gateway Configuration Tool in the Start menu to launch the

configuration tool.

2. Go to System Settings tab

Page 17: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 17 of 36

17

3. Click on Modify button in order to link the Gateway to the relevant Account. You must to

type the exact name of the Account.

4. Click Save.

5. If operation was successful you will get a message that the Account was linked

successfully.

Page 18: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 18 of 36

18

2.2.6 Mapping de-identified patient details

Unlike other uploading tools, de-identification with Quentry Gateway automatically generates

patient demographics details without user intervention. As a result, the user has no way to

link between de-identified data uploaded from the Gateway and the original patient details.

The Gateway can be configured to create a csv file which map original patient details and

with the de-identified details. By default, this setting is disabled and need to be manually

configured it in the Gateway configuration file. The csv file is stored locally in the site and

never uploaded to Quentry.

Follow these steps in order to enable the csv map file:

1. Stop Quentry Gateway service

2. Open the Gateway configuration file QuentryConfiguration_PRODUCTION.xml file in any

text editor

3. Add the following line under FeederConfiguration section:

4. <ExportPatientDataFileDirectory>d:\brainlab\UploadDeidentificationData</ExportPatient

DataFileDirectory>

5. This specified the path to store the mapping csv file

6. Start Quentry Gateway service

As a result of this setting, a new csv file will be created under the configured folder. For

example:

Page 19: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 19 of 36

19

Page 20: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 20 of 36

20

2.3 PDM (DICOM Proxy) Settings

This paragraph describes how DICOM Proxy should be configured to allow Query/Retrieve

(Q/R) data from CareTeams in Quentry and upload data from the PDM to Quentry.

Uploading data from the PDM to Quentry can be done in two ways:

1. Manual export of selected datasets by the user

2. Automatic forward of all data that is being used by the user in the different PDM

applications

Both methods push (C-STORE) the images to the Gateway. Quentry recipients should be

configured in the Gateway for correct upload functioning. See “Routing Rules” configuration

of paragraph 3.2.4 for additional information.

The SettingsEditor

DICOM Proxy configuration is done using the SettingsEditor application that can be found at:

o <Brainlab folder>\Tools\SettingsEditor

Change the settings editor view mode to “advanced service”.

Page 21: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 21 of 36

21

Manually restart the DICOM Proxy service after modifying and saving its configuration. In

order to save the configuration, click the save button at the SettingsEditor application

Use the services.msc console for restarting DICOM Proxy

Page 22: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 22 of 36

22

2.3.1 Query / Retrieve from the Gateway

Quentry Gateway can be added to a CareTeam in Quentry. By doing that, the Gateway will

have access to all datasets of the CareTeam and will be able to return them in response to a

DICOM Q/R request from the PDM or any other DICOM node.

Check the “Allow Download” checkbox in the CareTeam management page of the Web

Portal, under “Gateways” section.

More details about CareTeam settings and management can be found in the Quentry Web

Portal user guide under the Quentry Web Portal Help section.

In order to retrieve data from the CareTeam, Quentry Gateway should be configured as

PACS server in DICOM Proxy.

In the Settings Editor advanced mode, under DICOM Proxy -> DICOM -> PACS, add

another PACS with the Quentry Gateway configuration as in the following screenshot:

Page 23: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 23 of 36

23

Additional settings are available when the Setting Editor is open in “advanced Service”

mode. Scroll down and find the “Retrieve Model” key and set it to “C-GET Patient and Study

Root, no Retrieve Without Bulk Data”.

Note:

Make sure to use AET: QUENTRY with capital letters so Query results in PDM will have

the Quentry logo next to it.

Page 24: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 24 of 36

24

2.3.2 Auto Forwarding

The DICOM Proxy auto forwarding configuration will make the PDM to automatically push all

datasets being selected or created by the user. This can be configured by editing the DICOM

Proxy configuration file. In order to set automatic forwarding, you should add Quentry

Gateway as a new Storage Server.

1) Under DICOM -> Remote Storage Servers add new Storage Server

2) Display Name: Quentry

3) Host: 127.0.0.1

4) Port: 6599

5) AE title: [The AE Title that was configured for the Gateway]

Make sure to save the settings when you are done.

Page 25: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 25 of 36

25

2.3.3 Manual Forwarding

Manual forwarding allows users to select dataset to push to the Quentry Gateway for upload.

After selecting the export button in PDM, Quentry can be selected as destination by the user.

Page 26: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 26 of 36

26

In order for the PDM to display Quentry as a destination option, Quentry Gateway should be

configured as a Storage Target in the Patient Selection settings.

Page 27: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 27 of 36

27

2.4 Uninstall Quentry Gateway cannot be removed from the Master Installer. Instead you should use the windows

Add/Remove components from the Control Panel and later do some manual steps to clear remaining folders.

1. From Windows Control Panel, uninstall Quentry Gateway:

2. Manually delete Quentry Gateway installation folder located at:

a) C:\Program Files (x86)\Brainlab\Quentry Gateway

3. Manually delete old Gateway log files folders from:

a) D:\Brainlab\LogFiles\QuentryGatewayEnterprise*

Page 28: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 28 of 36

28

3. Patient Consent

Some hospitals may require collection of patient’s consent before uploading patient data to

Quentry.

Patient Consent Tool provides user with the possibility to mark a patient as “giving consent”,

thus enforcing this rule in the Quentry Gateway. When enforced in Quentry Gateway, every

upload of patient information fails unless the patient information in database allows

uploading data.

Note:

- Patient Consent is applicable for Quentry Gateway routing rules (auto uploading).

You may still be able to upload patient information from the web portal even if the

consent for this patient is missing.

- Patient Consent tool is only required in case the site would like to monitor patient

consent prior to upload data to Quentry.

- Some Patient Forms already include a patient consent checkbox so additional

consent tool may not be required.

Page 29: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 29 of 36

29

3.1 Patient Consent Tool for PDM

Patient Consent tool for PDM is an application that runs in the PDM environment and allows

to mark a patient as “giving consent” in Quentry.

3.1.1 Installation

1) Run ‘Brainlab Master Installer’ (available as a desktop shortcut)

2) Select ‘PatientConsent’ from the list

a) Quentry Gateway is a prerequisites for this package and will be selected in case it

wasn’t installed already.

3) Click the ‘Proceed’ button at the bottom-right corner of the screen

a) The installation will start.

b) The Patient Consent Tool will be installed under the appls folder:

o Brainlab\appls\PatientConsent

4) Click the ‘Exit’ button at the bottom-right corner of the screen.

Page 30: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 30 of 36

30

3.1.2 Configuration

User identification is required when adding a new patient consent. Identification can be done

in one of the following methods:

1. Quentry User

2. Active Directory

Set the preferred method by manually editing the consent tool using any simple text editor

(like notepad, for instance).

This can be configured in the globals.js file under

o BRAINLAB_PATH\appls\PatientConsent\Server

For Active Directory configuration, change the LoginAuthMethod value from “Quentry” to

“ActiveDirectory” and update the ldapServer and baseDN settings in this file. The settings

are used for the Brainlab network Active Directory settings:

Once patient consent has been accepted, Quentry Gateway will try to retrieve all existing

images of that patient from the DICOM Proxy cache and upload them to Quentry.

In order for that to work, Quentry Gateway must be configured as a client application in the

DICOM Proxy settings. In the Settings Editor advanced mode, under DICOM Proxy ->

DICOM Settings -> Client Applications, add another client application with the Quentry

Gateway configuration as in the following screenshot:

Page 31: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 31 of 36

31

3.2 Enforcing Consent in Quentry Gateway Upload Rules

Quentry Gateway routing rules settings should be configured to enforce checking for patient

consent before uploading patient information to Quentry.

For the default recipient you can select “Enforce patient consent for upload to the default

recipient”. A similar setting exists separately for each rule.

Note:

In case you have multiple Quentry Gateways installed for the Account, the consent

settings should be configured for each Gateway separately.

Page 32: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 32 of 36

32

Page 33: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 33 of 36

33

4. Patient Form

Patient Form allow medical institutes to collect various types of patient information, such as

symptoms, medications, medical history, etc.

The forms can be integrated into the PDM workflow and later viewed and edited in Quentry.

4.1 Installation

The Patient Form installation using the master installer simply choose the right patient form

to be installed. For example:

Patient Form can be started from the PDM Tools section:

Note:

Patient form are not designed to allow any user self-customization. Every change must

be reviewed and implemented by Brainlab Big Data R&D.

Note:

Upgrade of existing Patient Form installation is currently not supported. Please uninstall

existing Patient Form before installing a new one.

Page 34: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 34 of 36

34

4.2 Exporting Patient Form from PDM

By Default, Patient Form submitted data is written to the PDM and can be later exported to

Quentry.

From the PDM export option, select some datasets to be exported to Quentry and the recent

submitted Patient Form will be sent together with the dataset files. Note that in the data

selection there is no indication about the selected Patient Form.

4.3 Offline mode

Dynamic Forms are intended to use when the client machine is connected to the Internet so

the client can export them to Quentry. In case the client machine is not connected to the

Internet (or to a network at all) and you still want to use the forms in order to store them to

the PDM, the following configuration changes need to be done:

4.3.1 Open the globals.js file located at Brainlab\appls\DynamicForms\Server in

a notepad or other text editor.

4.3.2 Change the hostname configuration key of

DicomOpsHttpWrappAndSendConfig from localhost to 127.0.0.1

var DicomOpsHttpWrappAndSendConfig = {

hostname: '127.0.0.1',

port: '80',

path: '/api/upload/dynamicforms',

method: 'POST',

headers: {

'Content-Type': 'application/json'

}

};

4.3.3 Save the globals.js configuration file

4.3.4 Restart the “Brainlab NodeMaster” in windows service

Page 35: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 35 of 36

35

5. Quentry Network Access

Some customers network restrictions requires opening firewall access to specific IP address for

Quentry. The following current IPs are required to be available for Quentry operation from the

customer network

Devices accessing Quentry for SRS Registry (https://srsregistry.quentry.com) will require access to

the following hosts:

Server Name IP Address Port(s)

v01-us2.quentry.com 54.241.252.174 443

v02-us2.quentry.com 54.241.252.178 443

s01-us2.quentry.com 54.215.10.84 443

s02-us2.quentry.com 54.215.8.3 443

srsregistry.quentry.com CNAME, no static IP

servicesus2.quentry.com CNAME, no static IP 80,443

Devices accessing Quentry (https://www.quentry.com) will require access to the following hosts:

Server Name IP Address Port(s)

EU Region

v01-eu1.quentry.com 54.247.92.243 443

v02-eu1.quentry.com 54.247.92.245 443

v03-eu1.quentry.com 54.217.219.108 443

s01-eu1.quentry.com 54.247.81.173 443

s02-eu1.quentry.com 54.247.81.189 443

b01-eu1.quentry.com 54.195.247.72 443

b02-eu1.quentry.com 54.195.254.170 443

b03-eu1.quentry.com 54.75.232.172 443

b04-eu1.quentry.com 54.217.222.237 443

serviceseu1.quentry.com CNAME, no static IP 80,443

US Region

v01-us1.quentry.com 54.243.240.56 443

v02-us1.quentry.com 54.235.97.81 443

v03-us1.quentry.com 54.235.112.68 443

s01-us1.quentry.com 54.243.240.64 443

s02-us1.quentry.com 54.243.240.66 443

b01-us1.quentry.com 54.83.46.26 443

b02-us1.quentry.com 54.83.31.118 443

b03-us1.quentry.com 54.83.60.205 443

b04-us1.quentry.com 54.163.228.203 443

servicesus1.quentry.com CNAME, no static IP 80,443

All Regions

www.quentry.com

Page 36: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 36 of 36

36

Devices accessing Quentry (https://au.quentry.com) will require access to the following hosts:

Server Name IP Address Port(s) v01-au1.quentry.com 52.62.223.204 443

v02-au1.quentry.com 52.62.235.142 443

v03-au1.quentry.com 52.62.253.119 443

b01-au1.quentry.com 13.210.194.95 443

b02-au1.quentry.com 13.236.23.31 443

b03-au1.quentry.com 13.236.59.93 443

b04-au1.quentry.com 13.54.219.211 443

servicesau1.quentry.com CNAME, no static IP 80,443

au.quentry.com

Page 37: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 37 of 36

37

6. Use case: Quentry for DBS

Quentry for DBS (Deep Brain Stimulation) allows users to upload data from Guide Elements

and Patient Form to Quentry in order to generate DBS heatmaps and analytics.

This chapter describes the specific technical steps for configuring the Big Data applications

for this use case.

Installation steps:

1. Make sure to have a Quentry Business Account and at least one CareTeam for the

Account

2. Install and configure Quentry Gateway by following instructions on chapter 3

a. Specific for this use case make sure to check the “Group by Dicom

Association” option in the Gateway Routing Rules configuration. In this way all

files pushed from PDM in one export are uploaded into a single Quentry folder.

Note:

In master installer you may find a DBS dynamic forms bip file of the previous version of

this project. To the best of our knowledge, it is no longer used by anyone so unless said

otherwise, you most likely do not need it.

Page 38: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 38 of 36

38

Change the Timeout settings to 3 seconds. This specifies the time the Gateway

waits for additional images before starting to upload.

3. Configure PDM (DICOM Proxy) Settings to allow Manual upload from the PDM to

Quentry as described on chapter 3.3.3.

a. Specific for this use case Do not configure Auto Forwarding

Note:

A new form for collecting data about trajectories was released as part of Quentry R18U3.

This form is automatically generated for each folder created for a CareTeam.

In order for this to work, the CareTeam settings need to be updated in the Quentry

database. Please contact the Quentry R&D team in case you need it.

Page 39: Quentry On-Site Deployment Guide€¦ · B Updated section 2.3 DICOM Proxy settings and Gateway installation behind proxy server Dec-2016 Shlomy Shivek C Updated for R13 changes in

Regulation

Field: Support and Operations Number: SP2S00544 Version: G

Subject: Quentry On-Site Deployment Guide Page 39 of 36

39

6. Use case: Quentry for AutoSizer

Quentry for AutoSizer enables automatic TraumaCad planning through Quentry. The

following steps needed to be applied in Quentry Gateway for the AutoSizer workflow:

1. Make sure to have a Quentry Business Account and at least one CareTeam for the

Account

2. Install and configure Quentry Gateway (routing rules should be configured with a

Careteam as the default recipient). For more details see section 2.2.4 and in Quentry

Gateway user guide.

3. Images for AutoSizer planning are taken from PACS, Make sure to configure PACS

integration as described in section 2.2

4. Disable the Pre-Upload feature as described in section 2.1.4

5. In case SSL communication is required - it can be configured as described in chapter 2.1

The following URLs can be used on the installed server in order to access the AutoSizer application:

- AutoSizerURL = "http://" + AutoSizerHost + "/QuentryGateway/AutoSize;

- StudyUIDQuery = “?StudyUID=" + [StudyUID];

- AccessionQuery = “?Accession=” + [Accession];

- LaunchURL = AutoSizerURL + QueryParameter (StudyUIDQuery or AccessionQuery);

Configuration testing

Launch http://localhost/QuentryGateway/AutoSize on the QG server, authenticate to Quentry and

search for patient images in PACS

Integration Examples:

Query by StudyUID:

http://192.168.192.168/QuentryGateway/AutoSize?StudyUID=1.240.307915213106.13152134446.118

Query by Accession Number:

http:// 192.168.192.168/QuentryGateway/AutoSize?Accession=ACC11443 PACS Viewer integration with StudyUID:

http://<AutoSizerHost>/QuentryGateway/AutoSize?StudyUID =<STUDYUID> PACS Viewer integration with Accession Number:

http://<AutoSizerHost>/QuentryGateway/AutoSize?Accession=<ACCESSION>