comparison Sphinx/source/users/advanced-rest.rst @ 596:ef64d0769014

private tags
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 18 Jan 2021 11:12:01 +0100
parents 090cc988c35e
children eaa6cdfa7ba6
comparison
equal deleted inserted replaced
595:14e1e84192b0 596:ef64d0769014
255 Orthanc instance ID of the newly created DICOM resource. 255 Orthanc instance ID of the newly created DICOM resource.
256 256
257 You can use the ``/instances/.../pdf`` URI to retrieve an embedded PDF 257 You can use the ``/instances/.../pdf`` URI to retrieve an embedded PDF
258 file. 258 file.
259 259
260
261 .. _private-tags:
262
263 Creating DICOM instance with private tags
264 -----------------------------------------
265
266 .. highlight:: json
267
268 The ``/tools/create-dicom`` URI can be used to create DICOM instances
269 containing private tags. Those private tags must first be defined in
270 the ``Dictionary`` configuration option of Orthanc. Importantly, the
271 ``xxxx,0010`` tag must be defined to register the private creator,
272 where ``xxxx`` is the private group of interest. Here is a sample::
273
274 {
275 "Dictionary" : {
276 "0405,0010" : [ "LO", "Private data element", 1, 1, "RawDataStore" ],
277 "0405,1001" : [ "ST", "XML", 1, 1, "RawDataStore" ]
278 }
279 }
280
281 Once Orthanc is started using this configuration file, it is possible
282 to create a DICOM instance using the following POST body on
283 ``/tools/create-dicom``::
284
285 {
286 "PrivateCreator" : "RawDataStore",
287 "Tags" :
288 {
289 "PatientName" : "Love^Sarah",
290 "PatientID" : "7",
291 "0405,0010" : "RawDataStore",
292 "0405,1001" : "<xml><test>Testing</test></xml>"
293 }
294 }
260 295
261 296
262 .. _prometheus: 297 .. _prometheus:
263 298
264 Instrumentation with Prometheus 299 Instrumentation with Prometheus