|
24
|
1 .. _dicomweb:
|
|
|
2
|
|
|
3
|
|
|
4 DICOMweb plugin
|
|
|
5 ===============
|
|
|
6
|
|
30
|
7 .. contents::
|
|
|
8
|
|
24
|
9 This **official** plugin extends Orthanc with support of the `DICOMweb
|
|
|
10 protocols <https://en.wikipedia.org/wiki/DICOMweb>`__. More precisely,
|
|
|
11 the plugin introduces a basic, reference implementation of WADO-URI,
|
|
|
12 WADO-RS, QIDO-RS and STOW-RS, following `DICOM PS3.18
|
|
25
|
13 <http://dicom.nema.org/medical/dicom/current/output/html/part18.html>`__.
|
|
27
|
14
|
|
|
15 For general information, check out the `official homepage of the
|
|
|
16 plugins <http://www.orthanc-server.com/static.php?page=dicomweb>`__.
|
|
|
17
|
|
|
18 The full standard is not implemented yet, the supported features are
|
|
|
19 `tracked in the repository
|
|
|
20 <https://bitbucket.org/sjodogne/orthanc-dicomweb/src/default/Status.txt>`__. Some
|
|
|
21 integration tests are `available separately
|
|
|
22 <https://bitbucket.org/sjodogne/orthanc-tests/src/default/Plugins/DicomWeb/Run.py>`__.
|
|
30
|
23
|
|
|
24
|
|
|
25 Compilation
|
|
|
26 -----------
|
|
|
27
|
|
|
28 .. highlight:: text
|
|
|
29
|
|
|
30 The procedure to compile these plugins is similar of that for the
|
|
|
31 :ref:`core of Orthanc <compiling>`. The following commands should work
|
|
|
32 for every UNIX-like distribution (including GNU/Linux)::
|
|
|
33
|
|
|
34 $ mkdir Build
|
|
|
35 $ cd Build
|
|
|
36 $ cmake .. -DSTATIC_BUILD=ON
|
|
|
37 $ make
|
|
|
38
|
|
|
39 The compilation will produce a shared library ``OrthancDicomWeb`` that
|
|
|
40 contains the DICOMweb plugin. Pre-compiled binaries for Microsoft
|
|
|
41 Windows `are also available
|
|
|
42 <http://www.orthanc-server.com/browse.php?path=/plugin-dicom-web>`__.
|
|
|
43 A package for `Apple's Mac OS X
|
|
|
44 <http://localhost/~jodogne/orthanc/static.php?page=download-mac>`__ is
|
|
|
45 available courtesy of `Osimis <http://osimis.io/>`__.
|
|
|
46
|
|
|
47
|
|
|
48 Usage
|
|
|
49 -----
|
|
|
50
|
|
|
51 .. highlight:: json
|
|
|
52
|
|
|
53 You of course first have to :ref:`install Orthanc <compiling>`. Once
|
|
|
54 Orthanc is installed, you must change the :ref:`configuration file
|
|
|
55 <configuration>` to tell Orthanc where it can find the plugin: This is
|
|
|
56 done by properly modifying the ``Plugins`` option. You could for
|
|
|
57 instance use the following configuration file::
|
|
|
58
|
|
|
59 {
|
|
|
60 "Name" : "MyOrthanc",
|
|
|
61 [...]
|
|
|
62 "Plugins" : [
|
|
|
63 "/home/user/OrthancDicomWeb/Build/libOrthancDicomWeb.so"
|
|
|
64 ]
|
|
|
65 }
|
|
|
66
|
|
|
67 The root of the DICOMweb REST API is then accessible at ``http://localhost:8042/dicom-web/``.
|
|
|
68
|
|
|
69
|
|
|
70 Options
|
|
|
71 -------
|
|
|
72
|
|
|
73 .. highlight:: json
|
|
|
74
|
|
|
75 Several configuration options are also available, and are listed in
|
|
|
76 the example below::
|
|
|
77
|
|
|
78 {
|
|
|
79 "DicomWeb" : {
|
|
|
80 "Enable" : true, // Whether DICOMweb support is enabled
|
|
|
81 "Root" : "/dicom-web/", // Root URI of the DICOMweb API (for QIDO-RS, STOW-RS and WADO-RS)
|
|
|
82 "EnableWado" : true, // Whether WADO-URI (aka. WADO) support is enabled
|
|
|
83 "WadoRoot" : "/wado", // Root URI of the WADO-URI (aka. WADO) API
|
|
|
84 "Host" : "localhost", // Hard-codes the name of the host for subsequent WADO-RS requests
|
|
|
85 "Ssl" : false // Whether HTTPS should be used for subsequent WADO-RS requests
|
|
|
86 }
|
|
|
87 }
|
|
|
88
|
