logo资料库

DCM4CHEE参考文档.pdf

第1页 / 共40页
第2页 / 共40页
第3页 / 共40页
第4页 / 共40页
第5页 / 共40页
第6页 / 共40页
第7页 / 共40页
第8页 / 共40页
资料共40页,剩余部分请下载后查看
dcm4chee Open Source Image Manager/Archive
Table of Contents
Preface
Chapter 1. Installation Instructions
1.1. Minimum System Requirements and Supporting Software
1.2. Installation Steps
1.3. Verify the Installation
Chapter 2. dcm4chee Services
2.1. Overview
2.2. Service Reference
2.2.1. Core Archive Services
AE Title Configuration Service
Audit Logger
Compression Service
Consistency Check Service
Content Edit service
DICOM Server
Device Service
Echo Service
Teaching File and Clinical Trial Export Manager
File Copy Service
FixPatientAttributes Service
DICOM Forward Service
File System Management Service
DICOM GPWL Feed Service
DICOM GPWL Service Class Providers
DICOM GPWL SCU Service
DICOM Hanging Protocol SCP
DICOM IAN/SCN SCU Service
DICOM Key Object Generation Service
DICOM Media Creation Management SCU
MD5 Check Service
Move SCU Service
MPPS Emulator
DICOM Modality Performed Procedure Step (MPPS) SCP
DICOM Modality Performed Procedure Step (MPPS) SCU
DICOM Modality Worklist SCP
Modality Worklist SCU
Performed Procedure Step (PPS) Exception Managment
PPS SCU Service
DICOM Query/Retrieve SCP
Simple SMTP Mail Sender
DICOM Storage Commitment SCU/SCP
DICOM Storage SCP
Study Information Service
Study Reconciliation Service
Study Status Service
Private Study Management Service SCP
DICOM Modality Worklist SCU
Check File Status Service
TLS Configuration
XDS-I Service
Chapter 3. User Interface Guide
3.1. Introduction
3.2. User Login
3.3. Archive Content Administration
3.3.1. Study List
3.3.2. Search Filter
3.3.3. Function Buttons
3.3.3.1. Functions Buttons in the header section
3.3.3.1.1.  New Search
3.3.3.1.2.  Previous Search Results
3.3.3.1.3.  Next Search Results
3.3.3.1.4.  Add New Patient
3.3.3.1.5.  Merge Selected Patient
3.3.3.1.6.  Move Selected Items
3.3.3.1.6.1. To Move a Study to another Patient
3.3.3.1.6.2. To Move a Series to another Study
3.3.3.1.6.3. To Move an Instance to another Series
3.3.3.1.7.  Export Teaching Files
3.3.3.1.8.  Provide and Register Imaging Document Set to an XDS-I Registry/Repository
3.3.3.1.9.  Move Selected Entities into the Trash
3.3.3.1.10.  Permanently Delete Selected Entities
3.3.3.1.11.  Undelete Selected Entities
3.3.3.1.12.  Send Selected Entities to Specified Destination
3.3.3.2. Function buttons next to the entities in the folder
3.3.3.2.1.  Edit Patient Attributes
3.3.3.2.2.  Edit Study Attributes
3.3.3.2.3.  Edit Series Attributes
3.3.3.2.4.  Add New Study
3.3.3.2.5.  Add New Series
3.3.3.2.6.  View Image
3.3.3.2.7.  View Report as HTML
3.3.3.2.8.  View Report as PDF
3.3.3.2.9.  View Waveform object
3.3.3.2.10.  Offline
3.4. Application Entity (AE) Management
3.5. Offline Storage
3.5.1. Manual Offline Archiving
3.5.2. Automatic Offline Archiving
3.6. Worklist Console
3.7. MPPS Console
3.8. User Administration
3.8.1. Create a new user
3.8.2. Edit/Update a User Profile
3.8.3. Delete a user
3.9. Audit Repository
3.9.1. List Section
3.9.2. Search Section
3.9.3. The selection section
3.9.4. Audit Record Detail View
Appendix A. Building from Source Code
A.1. Building the dcm4chee Archive
dcm4chee Reference Documentation Version: 2.9.1
Table of Contents Preface ............................................................................................................................................ iv 1. Installation Instructions .............................................................................................................. 1 1.1. Minimum System Requirements and Supporting Software .................................................... 1 1.2. Installation Steps ................................................................................................................ 1 1.3. Verify the Installation ......................................................................................................... 4 2. dcm4chee Services ....................................................................................................................... 7 2.1. Overview ........................................................................................................................... 7 2.2. Service Reference .............................................................................................................. 7 2.2.1. Core Archive Services ............................................................................................. 7 2.2.1.1. AE Title Configuration Service ...................................................................... 7 2.2.1.2. Audit Logger ................................................................................................ 7 2.2.1.3. Compression Service .................................................................................... 7 2.2.1.4. Consistency Check Service ............................................................................ 7 2.2.1.5. Content Edit service ...................................................................................... 7 2.2.1.6. DICOM Server ............................................................................................. 8 2.2.1.7. Device Service ............................................................................................. 8 2.2.1.8. Echo Service ................................................................................................ 8 2.2.1.9. Teaching File and Clinical Trial Export Manager ............................................ 8 2.2.1.10. File Copy Service ....................................................................................... 8 2.2.1.11. FixPatientAttributes Service ........................................................................ 8 2.2.1.12. DICOM Forward Service ............................................................................ 8 2.2.1.13. File System Management Service ................................................................ 8 2.2.1.14. DICOM GPWL Feed Service ...................................................................... 8 2.2.1.15. DICOM GPWL Service Class Providers ....................................................... 8 2.2.1.16. DICOM GPWL SCU Service ...................................................................... 8 2.2.1.17. DICOM Hanging Protocol SCP ................................................................... 8 2.2.1.18. DICOM IAN/SCN SCU Service .................................................................. 8 2.2.1.19. DICOM Key Object Generation Service ....................................................... 9 2.2.1.20. DICOM Media Creation Management SCU .................................................. 9 2.2.1.21. MD5 Check Service .................................................................................... 9 2.2.1.22. Move SCU Service ..................................................................................... 9 2.2.1.23. MPPS Emulator .......................................................................................... 9 2.2.1.24. DICOM Modality Performed Procedure Step (MPPS) SCP ........................... 9 2.2.1.25. DICOM Modality Performed Procedure Step (MPPS) SCU ........................... 9 2.2.1.26. DICOM Modality Worklist SCP .................................................................. 9 2.2.1.27. Modality Worklist SCU ............................................................................... 9 2.2.1.28. Performed Procedure Step (PPS) Exception Managment ............................... 9 2.2.1.29. PPS SCU Service ........................................................................................ 9 2.2.1.30. DICOM Query/Retrieve SCP ....................................................................... 9 2.2.1.31. Simple SMTP Mail Sender .......................................................................... 9 2.2.1.32. DICOM Storage Commitment SCU/SCP ...................................................... 9 2.2.1.33. DICOM Storage SCP ................................................................................ 10 2.2.1.34. Study Information Service ......................................................................... 10 2.2.1.35. Study Reconciliation Service ..................................................................... 10 2.2.1.36. Study Status Service ................................................................................. 10 2.2.1.37. Private Study Management Service SCP ..................................................... 10 2.2.1.38. DICOM Modality Worklist SCU ............................................................... 10 2.2.1.39. Check File Status Service .......................................................................... 10 dcm4chee 2.9.1 ii
dcm4chee Open Source Image Manager/Archive 2.2.1.40. TLS Configuration .................................................................................... 10 2.2.1.41. XDS-I Service .......................................................................................... 10 3. User Interface Guide ................................................................................................................. 11 3.1. Introduction ..................................................................................................................... 11 3.2. User Login ....................................................................................................................... 11 3.3. Archive Content Administration ........................................................................................ 12 3.3.1. Study List ............................................................................................................. 12 3.3.2. Search Filter .......................................................................................................... 13 3.3.3. Function Buttons ................................................................................................... 14 3.3.3.1. Functions Buttons in the header section ........................................................ 14 3.3.3.2. Function buttons next to the entities in the folder .......................................... 18 3.4. Application Entity (AE) Management ................................................................................ 21 3.5. Offline Storage ................................................................................................................ 23 3.5.1. Manual Offline Archiving ...................................................................................... 24 3.5.2. Automatic Offline Archiving .................................................................................. 24 3.6. Worklist Console ............................................................................................................. 25 3.7. MPPS Console ................................................................................................................. 27 3.8. User Administration ......................................................................................................... 28 3.8.1. Create a new user .................................................................................................. 29 3.8.2. Edit/Update a User Profile ..................................................................................... 30 3.8.3. Delete a user ......................................................................................................... 31 3.9. Audit Repository .............................................................................................................. 31 3.9.1. List Section ........................................................................................................... 31 3.9.2. Search Section ....................................................................................................... 32 3.9.3. The selection section ............................................................................................. 32 3.9.4. Audit Record Detail View ...................................................................................... 33 A. Building from Source Code ........................................................................................................ 35 A.1. Building the dcm4chee Archive ........................................................................................ 35 dcm4chee 2.9.1 iii
Preface We need a better introduction than the following. dcm4chee is an implementation of an IHE (Integrating the Healthcare Enterprise) compliant Image Archive and Report Repository. This includes the capabilities • to store and retrieve various kinds of DICOM Objects such as: 1. Images from multiple modalities, 2. Grayscale Presentation States [GSPS], which specifies the presentations of images as grayscaling, zoom, text and graphical annotations, 3. Key Objects [KO], which specifies a particular selection of images for a specified reason and with an attached note, 4. Structured Reports [SR]. • • to process HL7 notification messages from the Order Filler, about Procedure Scheduling, Procedure Up- dates and Patient Information Updates, to process DICOM Modality Performed Procedure Step [MPPS] messages from modalities and forward them to the Order Filler. dcm4chee is a server application. Its Web-based User Interface is intended for system configuration and monit- oring by system adminstrators. dcm4chee 2.9.1 iv
Chapter 1. Installation Instructions 1.1. Minimum System Requirements and Supporting Software dcm4chee is a Java-based application for the management of digital clinical objects. As such, it should be run under the best hardware available for production systems. The minimal system configuration is as follows: • • • 512 MB RAM 100 MB hard disk space (in addition to archive disk space for object storage and caching) 400 MHz CPU or better dcm4chee requires a database to store transient and permanent information from the clinical workflow and ob- jects. The authors of dcm4chee realize that database expertise varies from site to site, and has included support for several different databases for deployment with the archive. The list of supported databases is: • PostgreSQL 8.1.x • MySQL 4.1+ • Oracle 9i/10g • SQL Server • DB2 8.1+ Additional Software Notes dcm4chee is a Java-based application. It requires the installation of the JDK version 1.4.2 or higher. JDK ver- sion 5 is recommended for the best performance and stability. For image compression/decompression, dcm4chee 2.8.x utilizes Sun's Java Advanced Imaging (JAI) Image I/O Tools 1.0_01. The binary distribution packages of dcm4chee 2.8.x already includes the necessary JARs and native libraries for Windows and Linux i586. For Solaris support, you need to download the software package from Sun at http://java.sun.com/products/java-media/jai/downloads/download-iio-1_0_01.html and replace the Linux version of libclib_jiio.so in DCM4CHEE_DIST/bin/ with the file of the same name from the Solaris JAI Image IO distribution. dcm4chee depends heavily on the JBoss (http://www.jboss.org) application server for its infrastructure. It is not necessary to download JBoss (as dcm4chee is pre-packaged within JBoss), but viewing the online (or downloaded) JBoss documentation will assist a great deal in learning the dcm4chee directory structure, and how the product operates under the covers. JBoss services such as XMBeans, JBossMQ (JMS), and EJB (Session and Entity beans) are utilized by dcm4chee. 1.2. Installation Steps Installing dcm4chee is fairly easy: 1. Download the binary distribution of dcm4chee for the database of your choice from the Files page of the dcm4chee 2.9.1 1
Installation Instructions dcm4che project page on SourceForge (http://sourceforge.net/projects/dcm4che/). If you do not see a distribution for your database, you will have to build dcm4chee from the source code. See Appendix A, Building from Source Code for instructions on doing so. 2. Once downloaded, extract the distribution package into your desired destination directory. Avoid using a directory path that contains spaces though, as that may cause problems when running the application from the command line. 3. 4. Install the database software of your choice (keeping in mind the supported database systems) if you have not already done so. Keep in mind that the database software that you install (or have installed) must match the version of dcm4chee that you downloaded. For example, if you want to use PostgreSQL with dcm4chee then you should download the dcm4chee-standalone-psql-2.8.2.zip file from SourceForge. If using a database other than MySQL or PostgreSQL you will need to copy an apropriate JDBC Driver for the database to DCM4CHEE_DIST/server/default/lib/. This is not necessary for MySQL or Postgr- eSQL because the binary distribution of dcm4chee already contains the correct JDBC drivers for these database systems. 5. Verify that your database installation has TCP/IP socket access available. For example, with PostgreSQL you can check the pg_hba.conf file for your database: $PGDATA/pg_hba.conf: # IPv4 local connections: host all all 127.0.0.1/32 trust With Oracle, you can verify that the TNS Listener is enabled: C:\>netstat -b -p TCP Active Connections TCP [ORACLE.EXE] localhost:1284 TCP [TNSLSNR.exe] localhost:1521 host.domain.com:1521 ESTABLISHED 1788 host.domain.com:1284 ESTABLISHED 1816 6. Initiate the archive database instance (named pacsdb) using the create DDL script DCM4CHEE_DIST/sql/create.xxx. located in For example, with PostgreSQL on a Unix-based system: > export PGUSER=postgres > createdb pacsdb > psql pacsdb -f DCM4CHEE_DIST/sql/create.psql To initialize a MySQL database on a Unix-based system: > mysql -uroot mysql> create database pacsdb; mysql> grant all on pacsdb.* to 'pacs'@'localhost' identified by 'pacs'; mysql> \q > mysql -upacs -ppacs < DCM4CHEE_DIST/sql/create.mysql dcm4chee 2.9.1 2
Installation Instructions Note: If you wish to take advantage of specific features of your RDBMS such as tablespaces, partitioning, etc. you will need to implement them on your own. This can sometimes be done with the tools that come with the database, or by modifying the DDL script before running it. If you make changes to the DDL script that you think might be useful to the wider audience, please submit them to the dcm4che-users list- serv. 7. Adjust pool settings the dcm4chee database in DCM4CHEE_DIST/server/default/deploy/xxxx-ds.xml to suit your environment. This includes the user name and password that the application should use when obtaining connections. In addition, JBoss allows for the configuration of other aspects of the connection pool. Although the default settings are fine for ba- sic deployment scenarios, the following may be added to the XML file in order to tune the connection pool: connection 5 20 0 8. Set the JAVA_HOME environment variable to your JDK installation directory. 9. Adjust the Java heap settings for the application [Windows]: DCM4CHEE_DIST/bin/run.bat: rem Sun JVM memory allocation pool parameters. Modify as appropriate. set JAVA_OPTS=%JAVA_OPTS% -Xms128m -Xmx512m [Linux/Unix]: DCM4CHEE_DIST/bin/run.conf # Specify options to pass to the Java VM. JAVA_OPTS="-server -Xms64m -Xmx200m -Djava.awt.headless=true .. dcm4chee 2.9.1 3
Installation Instructions Keep in mind the available RAM and memory requirements of other processes running on the hardware. For example, iif only 512 MB RAM is available on the machine, you should decrease the default value from -Xmx512m (on Windows to) -Xmx300. 10. Optional: Upon installation, all DICOM services are pre-configured with DCM4CHEE as the Application En- tity Title (AE Title, or AET). Although it is possible to modify this default configuration at a later date through the Web-based administrative console, it is more efficient to replace DCM4CHEE with YOUR_AET in DCM4CHEE_DIST/server/default/conf/xmdesc/*.xml using utilities provided by your platform. For example, on GNU Linux: > find DCM4CHEE_DIST/server/default/conf/xmdesc -exec \ sed -i s/DCM4CHEE_DIST/YOUR_AET/g '{}' ';' 11. You're all done and ready to verify the installation. After verifying that the application is installed and running correctly, you may want to install it as a Win- dows service or Unix daemon. a. Stop the application (type ctrl-c in the console window). b. Windows: install dcm4chee as a Windows service executing DCM4CHEE_DIST/bin/install_service.bat. c. Redhat Linux: copy the init script DCM4CHEE_DIST/bin/dcm4chee_init_redhat.sh to /etc/init.d/ and adjust it according to the dcm4chee installation location, the JDK installation location, and which user the dcm4chee should run under. 1.3. Verify the Installation Navigate to the DCM4CHEE_DIST/bin directory, and execute the run.bat or run.sh script, as appropriate for your operating system. Your output should look like the following and contain no error or exception messages: =============================================================================== . JBoss Bootstrap Environment . . . . JBOSS_HOME: C:\apps\dcm4chee-standalone-psql-2.8.2\bin\\.. JAVA: C:\jdk1.5.0_06\bin\java JAVA_OPTS: -Dprogram.name=run.bat -Xms128m -Xmx512m CLASSPATH: C:\jdk1.5.0_06\lib\tools.jar; C:\apps\dcm4chee-standalone-psql-2.8.2\bin\\run.jar . =============================================================================== . 14:46:16,046 INFO [Server] Starting JBoss (MX MicroKernel)... 14:46:16,046 INFO [Server] Release ID: JBoss [Zion] 4.0.3SP1 (build: CVSTag=JBoss_4_0_3_SP1 date=200510231054) ... ... ... 14:46:50,626 INFO -> [JkMain] Jk running ID=0 time=0/60 14:46:50,636 INFO -> [Server] JBoss (MX MicroKernel) [4.0.3SP1 (build: config=null CVSTag=JBoss_4_0_3_SP1 date=200510231054)] Started in 34s:580ms dcm4chee 2.9.1 4
分享到:
收藏