changeset 596:ef64d0769014

private tags
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 18 Jan 2021 11:12:01 +0100
parents 14e1e84192b0
children 859bd3aa72dd
files Sphinx/source/users/advanced-rest.rst
diffstat 1 files changed, 35 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/users/advanced-rest.rst	Wed Jan 13 09:24:08 2021 +0100
+++ b/Sphinx/source/users/advanced-rest.rst	Mon Jan 18 11:12:01 2021 +0100
@@ -258,6 +258,41 @@
 file.
 
 
+.. _private-tags:
+
+Creating DICOM instance with private tags
+-----------------------------------------
+
+.. highlight:: json
+
+The ``/tools/create-dicom`` URI can be used to create DICOM instances
+containing private tags. Those private tags must first be defined in
+the ``Dictionary`` configuration option of Orthanc. Importantly, the
+``xxxx,0010`` tag must be defined to register the private creator,
+where ``xxxx`` is the private group of interest. Here is a sample::
+
+  {
+    "Dictionary" : {
+      "0405,0010" : [ "LO", "Private data element", 1, 1, "RawDataStore" ],
+      "0405,1001" : [ "ST", "XML", 1, 1, "RawDataStore" ]
+    }
+  }
+
+Once Orthanc is started using this configuration file, it is possible
+to create a DICOM instance using the following POST body on
+``/tools/create-dicom``::
+
+  {
+    "PrivateCreator" : "RawDataStore",
+    "Tags" :
+    {
+      "PatientName" : "Love^Sarah",
+      "PatientID" : "7",
+      "0405,0010" : "RawDataStore",
+      "0405,1001" : "<xml><test>Testing</test></xml>"
+    }
+  }
+
 
 .. _prometheus: