Mercurial > hg > orthanc-book

changeset 838:6afc236cd60a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
dicom-web & main-dicom-tags
author Alain Mazy <am@osimis.io>
date Thu, 05 May 2022 12:27:09 +0200
parents 66ff2f30afcc
children c29ac12e3160
files Sphinx/source/faq.rst Sphinx/source/faq/features.rst Sphinx/source/plugins/dicomweb.rst
diffstat 3 files changed, 24 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/faq.rst	Tue May 03 15:09:54 2022 +0200
+++ b/Sphinx/source/faq.rst	Thu May 05 12:27:09 2022 +0200
@@ -57,6 +57,7 @@
 
    faq/log.rst
    faq/orthanc-ids.rst
+   faq/main-dicom-tags.rst
    faq/versioning.rst
    faq/debian-daemon.rst
    faq/redhat.rst
--- a/Sphinx/source/faq/features.rst	Tue May 03 15:09:54 2022 +0200
+++ b/Sphinx/source/faq/features.rst	Thu May 05 12:27:09 2022 +0200
@@ -151,7 +151,9 @@
   the instance (for REST API).
 * ``PixelDataOffset`` (new in Orthanc 1.9.1): Offset (in bytes) of the
   Pixel Data DICOM tag in the DICOM file, if available.
-  
+* ``MainDicomTagsSignature`` (new in Orthanc 1.11.0 - not released yet):
+  The list of :ref:`MainDicomTags <main-dicom-tags>` that have been
+  saved in DB for this resource.
 
 Metadata listed above are set privately by the Orthanc core. They are
 **read-only** from the perspective of the end user, as Orthanc
@@ -186,6 +188,7 @@
 the :ref:`REST API <rest>`, for instance::
 
   $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/metadata
+  $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/metadata?expand
   $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/metadata/RemoteAet
   $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/metadata/SampleMetaData1
 
--- a/Sphinx/source/plugins/dicomweb.rst	Tue May 03 15:09:54 2022 +0200
+++ b/Sphinx/source/plugins/dicomweb.rst	Thu May 05 12:27:09 2022 +0200
@@ -114,15 +114,20 @@
   {
     [...]
     "DicomWeb" : {
-      "Enable" : true,            // Whether DICOMweb support is enabled
-      "Root" : "/dicom-web/",     // Root URI of the DICOMweb API (for QIDO-RS, STOW-RS and WADO-RS)
-      "EnableWado" : true,        // Whether WADO-URI (previously known as WADO) support is enabled
-      "WadoRoot" : "/wado",       // Root URI of the WADO-URI (aka. WADO) API
-      "Ssl" : false,              // Whether HTTPS should be used for subsequent WADO-RS requests
-      "QidoCaseSensitive" : true, // For QIDO-RS server, whether search is case sensitive (since release 0.5)
-      "Host" : "localhost",       // Hard-codes the name of the host for subsequent WADO-RS requests (deprecated)
-      "StudiesMetadata" : "Full", // How study-level metadata is retrieved (since release 1.1, cf. section below)
-      "SeriesMetadata" : "Full"   // How series-level metadata is retrieved (since release 1.1, cf. section below)
+      "Enable" : true,             // Whether DICOMweb support is enabled
+      "Root" : "/dicom-web/",      // Root URI of the DICOMweb API (for QIDO-RS, STOW-RS and WADO-RS)
+      "EnableWado" : true,         // Whether WADO-URI (previously known as WADO) support is enabled
+      "WadoRoot" : "/wado",        // Root URI of the WADO-URI (aka. WADO) API
+      "Ssl" : false,               // Whether HTTPS should be used for subsequent WADO-RS requests
+      "QidoCaseSensitive" : true,  // For QIDO-RS server, whether search is case sensitive (since release 0.5)
+      "Host" : "localhost",        // Hard-codes the name of the host for subsequent WADO-RS requests (deprecated)
+      "StudiesMetadata" : "Full",  // How study-level metadata is retrieved (since release 1.1, cf. section below)
+      "SeriesMetadata" : "Full",   // How series-level metadata is retrieved (since release 1.1, cf. section below)
+      "PublicRoot": "/dicom-web/", // The public Root URI of the DICOMweb API in case it is different from "Root".
+                                   // This is useful if, e.g, your Orthanc is behind a reverse-proxy and has another 
+                                   // base endpoint than the "Root" one.  Note that, if using a reverse-proxy, make sure to set the "host"
+                                   // and "proto" correctly in the "Forwarded" HTTP headers.
+                                   // (since release 1.8)
     }
   }
 
@@ -179,7 +184,11 @@
   files are not read from the disk, which provides best
   performance. However, this is a small subset of all the tags that
   would be retrieved if using the ``Full`` mode: A DICOMweb viewer
-  might need more tags.
+  might need more tags.  **Important Note:** From Orthanc 1.11.0 and DICOMweb plugin 1.8,
+  you may store more :ref:`MainDicomTags <main-dicom-tags>` in DB.
+  By correctly setting these tags, the ``MainDicomTags`` mode can
+  become faster than the ``Extrapolate`` mode with the same accuracy
+  as the ``Full`` mode.
 
 * If ``Extrapolate`` mode is used, the plugin will read up to 3 DICOM
   instances at random that belong to the study/series of interest. It