Professional Documents
Culture Documents
User Manual
Classification Common
prepared for double-side printing Version 1.0
Printed 23/04/03 15:08
Distribution
2-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
Table of contents
1 Introduction ................................................................................................................................... 4
1.1 Terms and abbreviations ......................................................................................................... 4
1.2 References ............................................................................................................................. 4
1.3 Quick use ............................................................................................................................... 4
1.4 Prepare RIS information. ......................................................................................................... 5
2 Instruction...................................................................................................................................... 6
2.1 Input and language selection window ...................................................................................... 6
2.1.1 Content of the Input and language selection window ....................................................... 6
2.1.2 Select RIS type .............................................................................................................. 6
2.1.3 Select RIS mapping file .................................................................................................. 7
2.1.4 Select Language ............................................................................................................ 7
2.2 Specify RIS data source .......................................................................................................... 8
2.2.1 Inputfile selection window............................................................................................... 8
2.2.1.1 Content of the inputfile selection window................................................................ 8
2.2.2 Specify Single byte ASCII inputfile selection window ....................................................... 9
2.2.2.1 Content of the single byte ASCII inputfile selection window .................................... 9
Single byte ASCII data file ...................................................................................................... 9
2.2.3 Dicom connection settings window................................................................................ 10
2.2.3.1 Content of the DICOM connection settings window ............................................... 10
2.3 RIS attribute configuration window ........................................................................................ 11
2.3.1 Content of the RIS attribute configuration window ......................................................... 11
2.4 Store file(s) window............................................................................................................... 13
2.4.1 Content of the store file(s) window ................................................................................ 13
2.5 User document comments window......................................................................................... 13
2.5.1 Content of the user document comments window .......................................................... 14
2.6 General mechanisms ............................................................................................................ 14
4 Installation ................................................................................................................................... 16
4.1 Compatability........................................................................................................................ 16
3-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
1 Introduction
In order to improve workflow efficiency, the ADC QS is connected to the hospital RIS for the transfer of patient
identification data. The ADC Rislink Toolkit software establishes this connection and is either based on
DICOM Modality Worklist or on the exchange of information through files.
The RISlink toolkit uses a mapping file that specifies the relationship between data from the RIS system and
the internal ADC QS database elements.
The RIS configuration tool assists in creating a mapping file for use with the RISlink Toolkit.
Term Description
1.2 References
Reference Document ID Description
When an existing mapping file must be updated the following steps should be taken (this session assumes
that the mapping file will be updated with data from the RIS present together with the mapping file):
• Prepare RIS data source and prepare existing RIS mapping file
• Select existing mapping file
4-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
• Specify RIS data source (type of RIS file/ RIS connection)
• Make any changes to the mappings
• Generate new mapping file and user document (and optional batch file)
• Install mapping file
The file must be stored in a location that is accessible to the tool. The file should preferably contain all data
that the RIS is capable to provide. It might be necessary that a RIS file with the appropriate information is
generated on a RIS system and that this file is copied to the system on which the RIS configuration tool will be
running.
In case of DICOM MWL the RIS system must be reachable through a network which can be accessed by the
tool. The RIS configuration tool will request a Modality Worklist for a user specified period. This list that must
be provided by the RIS should preferably contain all information that the RIS is capable to provide. It might be
necessary that the user of the RIS configuration tool prepares such a worklist.
When the preparations have been performed, this information should be selected by the tool.
- identify type of RIS data
- enable RIS data access (select RIS data file or specify DICOM MWL SCP)
5-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
2 Instruction
This section explains the various windows offered by the RIS configuration tool. It explains the meaning of the
fields that can be identified on these windows and what functionality is provided by the particular window.
6-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
Below an overview is given of names for the connection types that the Rislink Toolkit Software uses and the
(file)types normally associated with these connection types and that are used in the RIS Configuration Tool.
In most situations together with the existing mapping file, also the data from the RIS itself should be made
available. When both the RIS data and a mapping file are specified, the configuration tool will construct a
configuration window that allows the user to make changes to the mapping file based on actually available RIS
data.
When an existing mapping file is used as input, it is possible that this file contains mapping entries for which
no RIS elements are provided by the currently specified RIS data source. These mappings will be marked by a
RED cross indicating a suspect mapping. (Note: When no RIS data source is selected, all mappings will be
marked).
When unmapping a marked mapping, this mapping is removed. The ADC DB element is added to the list of
available ADC DB elements, the RIS DICOM tag will be completely discarded.
The language selections actually offered to the user depends on the language support that is installed on the
system on which the tool is running. Only those languages can be selected, for which language support is
present.
7-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
Note: when an other language is required from the list of supported languages, language support (fonts and
code-pages as well as proper registration of these facilities) for that specific language must be installed on the
system on which the tool is running.
The language which is used after installation of the tool is based on the regional settings. When this language
is not available, the english language is used as the default language. When a language is selected this
selection will be stored and reused when the tool is restarted.
Select a file that corresponds to the type of file which has been identified in the primary RIS data type
selection. The file can be selected either by entering the filename manually, or by browsing for the file by
activating the browse button and selecting the appropriate file.
Depending on the selection, dedicated default file extensions are enabled. This concerns the following RIS
data types and file extensions:
Multi byte XML data file (default extension .xml)
Delimited worklist file (default extension .dat) select the parameter file that contains the layout of the
Delimited worklist)
8-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
XML worklist file (default extension .xml)
Code page
A single byte ASCII file is encoded according to a specific code page. The code page that is used to create
the single byte ASCII file must be specified to guarantee that values are displayed properly. The following
code pages can be selected:
9-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
2.2.3 Dicom connection settings window
The screenshot below shows the DICOM connection settings window.
When a RIS is to be configured that implements the DICOM Modality Worklist SCP service, this RIS system is
assumed to be present in a network environment. To be able to access a DICOM service in a TCP/IP protocol
based network environment a number of network and DICOM parameters must be specified to allow access to
the RIS system.
The following items have to be filled in to be able to communicate with the connected RIS system:
• DICOM Server IP address <aaa-bbb-ccc-ddd>
This is the IP address of the connected RIS system. An IP address consists of four numbers that each
consists of upto three digits. When a number of less than three digits must be entered, the space key will
advance the cursor to the next number.
Note: The IP address of a windows based system can be discovered by opening a DOS-box on that
system and typing the command ipconfig. For other system consult the user manual of the system or
consult the system administrator.
• DICOM Server port number
This specifies the port number on the RIS system at which the DICOM Modality Worklist SCP (the RIS) is
available. The port number specifies the port at a system with a specific IP address at which the required
service is available.
Note: Often port number 104 is used for DICOM communication.
• Called AE Title
This is the Application Entity title used by the RIS system. This title is used in DICOM SCP/SCU
communication.
10-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
• Calling AE Title
This is the Application Entity title normally used by an ADC QS system/ ID viewer. This title is used in
DICOM SCP/SCU communication.
• Start date
This specifies the period for which the worklist will be requested at the connected RIS system. The
following selections are possible:
Today
Last 7 days
All
The RIS configuration window contains three lists. The upper part of the window shows a list of mapped
items. The middle part of the screen show two lists of unmapped data. The list on the left shows a list of
unmapped RIS data element. The list on the right shows a list of unmapped ADC DB items. For each ADC
DB item the following information is present: ADC DB name, optional IDviewer field(s), (optional) DICOM out
value.
11-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
ID viewer Column showing the labels used in the IDviewer for the fields in which the related ADC DB
element is displayed (in the selected language)
DICOM out Column showing the DICOM tag value used when the related ADC DB element is exported
by the ADC
Purpose of the tool is to define which data elements from the RIS must be used as which specific ADC DB
elements on an ADC QS/ IDviewer station. This relation can be established by creating a mapping that
consists of a RIS data element and an ADC QS item. The mappings created in this way will be used by the
ADC QS station. The created mappings will be stored in a file which must be transferred to the ADC QS
station.
For some of the items in this window tooltip help is available. When the mouse pointer is placed on either an
element in the list of unmapped RIS data elements, or on an unmapped ADC DB element field information with
respect to these fields will be shown.
For a “selected” RIS data element the following information will be provided:
• DICOM tag value
• DICOM help text
• DICOM VR string
• (optional) context info (this information is only available for specific RIS data sources)
A red cross marker in the list of mapped elements identifies a suspect mapping. A suspect mapping is a
mapping for which the currently selected RIS data source (when available) does not provide the DICOM tag
used in the marked mapping.
The lists of elements are either presented in a predefined order or in a sorted order (ascending or descending
order). Sorting can be changed by pressing the header of a particular row of data.
12-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
2.4 Store file(s) window
The screenshot below shows the store file(s) window.
13-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
2.5.1 Content of the user document comments window
This screen allows that comments can be added to this document. Two sections in the user document are
reserved for this purpose.
Header comment
Footer comment
Both section are free formatted comment fields which can be used to add any documentation texts
14-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
3 Files generated by the RIS configuration tool
The RIS configuration tool is able to generate three types of files. Each of these files is explained in a section
below. When creating a configuration for a new system, this configuration can best be created in a separate
directory. Creating a separate directory for each RIS system assures that files from other systems will not be
overwritten.
The layout of the user document is shown in Appendix B Layout User Document
When the batch file is activated, the mapping file will be copied to the default location of an ADC QS station.
When the file needs to be transferred with for instance a floppy disc both the batch file and the mapping file
should be copied to the same directory on the floppy disc. When the batch file is activated from the floppy, the
mapping file will be copied to the default location of an ADC QS station.
15-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
4 Installation
The RIS configuration tool is distributed as a self-extracting executable. The installation procedure will install
the RIS configuration tool application as well as a number of components required by the tool. Run setup to
install the tool and follow the instruction on the screen.
During Installation of the tool the presence and proper version of the Microsoft Java Virtual Machine will be
checked. This JVM is required when communication with a RIS using DICOM.
When the MS JVM can not be found the following message will be shown during the installation procedure:
When during installation it is detected that the wrong version of the MS-JVM is installed on the system, the
following message will be shown:
The Microsoft Java Virtual Machine is detected but Dicom communication needs a higher version.
In both cases it is preferred to exit from the installation process, install the proper version of the MS-JVM and
restart the installation process.
4.1 Compatability
The RIS configuration tool is intended to be used on the following windows operating systems:
• Windows 98, second edition
• Windows 2000
• Windows NT v4.0 SP4 with Internet Explorer 4.0
• Windows XP
The tool requires that in case a RIS that operates with DICOM Modality Worklist must be configured a Java
Runtime Environment (minimum version 1.1) has been installed.
16-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
5 Usage with RISlink toolkit
The mapping file (IDVRISConfig.xml) that is created by the tool is intended for use by the RISlink Toolkit. This
SW tool interpretes the mapping file and will use the mappings when accessing data from an actual RIS
system. The mapping file should be stored on the ADC QS station on which the RISlink toolkit is running and
the mapping file should be activated by selecting it within the RISlink toolkit.
17-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
Appendix A Error messages and recovery procedures
When encountering erroneous situations, the tool generates the following errors:
18-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
Appendix B Layout User Document
The figure below shows the layout of the user document.
- Heading text
- RIS type info: (The mapping is based on a connection of the following type: <<type-text>>)
- Mapping overview
- Footer text
The layout for each element in the RIS data list is:
“RIS element :” <RIS DICOM tag value> “is mapped to:”
“DB field :” <ADC DB element name>
“Idviewer :” <list of IDviewer labels>
“DICOM out :” <DICOM out tag value>
Example element:
19-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
Appendix C Example User Document
RIS Interface Customisation Report
This is an example user document. This text is the heading text of the user document that has been entered in
the header section of the header/footer screen.
---------------------------------------------------------------------------------------
The mapping is based on a connection of the following type: Single byte RIS data file
With the following codepage: 1252
The mappings are based on the following information from the RIS:
0019,1001
0010,0010
0010,0030
0010,0020
0010,0040
0008,0090
0020,0010
0020,000D
0008,0050
0008,0020
0008,0030
0020,4000
0019,10FA
0019,10FB
0019,10FC
0019,10FD
0008,1060
0008,1030
0008,103E
0020,0060
0018,0015
0018,5101
0008,0100
0018,1402
0018,6000
0019,10F0
0019,10F1
0019,10FF
0019,10F2
0019,10F3
0019,1072
0008,1040
---------------------------------------------------------------------------------------
Mapping overview:
20-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003
Phon. First Name:
DICOM out: 0010,0010
---------------------------------------------------------------------------------------
This is an example user document. This text is the footer text of the user document and has been entered in
the footer section of the header/footer screen.
21-21
[RIS Configuration tool] User Manual EMB2002050299.2.8-1
Dick Voogd Version: 1.0 Status: Final 23 apr 2003