Mercurial > hg > orthanc-book
annotate Sphinx/source/users/rest.rst @ 212:7ff807cc5ade
added modalities configuration
author | amazy |
---|---|
date | Fri, 22 Feb 2019 10:02:23 +0100 |
parents | 66295dffbf33 |
children | dcf6c2e60448 |
rev | line source |
---|---|
0 | 1 .. _rest: |
2 | |
3 REST API of Orthanc | |
4 =================== | |
5 | |
6 .. contents:: | |
7 :depth: 3 | |
8 | |
9 One of the major strengths of Orthanc lies in its built-in `RESTful | |
10 API | |
11 <https://en.wikipedia.org/wiki/Representational_state_transfer>`__, | |
12 that can be used to drive Orthanc from external applications, | |
13 independently of the programming language that is used to develop | |
14 these applications. The REST API of Orthanc gives a full programmatic | |
15 access to all the core features of Orthanc. | |
16 | |
17 Importantly, Orthanc Explorer (the embedded administrative interface | |
18 of Orthanc) entirely resorts to this REST API for all its features. | |
19 This implies that anything that can be done through Orthanc Explorer, | |
20 can also be done through REST queries. | |
21 | |
22 *Note:* All the examples are illustrated with the `cURL command-line | |
25 | 23 tool <https://curl.haxx.se/>`__, but equivalent calls can be readily |
0 | 24 transposed to any programming language that supports both HTTP and |
25 JSON. | |
26 | |
27 | |
114 | 28 .. _sending-dicom-images: |
29 | |
0 | 30 Sending DICOM images |
31 -------------------- | |
32 | |
33 .. highlight:: bash | |
34 | |
35 The upload of DICOM files is possible by querying the REST API using | |
36 the following syntax:: | |
37 | |
38 $ curl -X POST http://localhost:8042/instances --data-binary @CT.X.1.2.276.0.7230010.dcm | |
39 | |
40 .. highlight:: json | |
41 | |
42 Orthanc will respond with a JSON file that contain information about | |
43 the location of the stored instance, such as:: | |
44 | |
45 { | |
46 "ID" : "e87da270-c52b-4f2a-b8c6-bae25928d0b0", | |
47 "Path" : "/instances/e87da270-c52b-4f2a-b8c6-bae25928d0b0", | |
48 "Status" : "Success" | |
49 } | |
50 | |
51 .. highlight:: bash | |
52 | |
53 Note that in the case of curl, setting the ``Expect`` HTTP Header will | |
54 significantly `reduce the execution time of POST requests | |
25 | 55 <http://stackoverflow.com/questions/463144/php-http-post-fails-when-curl-data-1024/463277#463277>`__:: |
0 | 56 |
57 $ curl -X POST -H "Expect:" http://localhost:8042/instances --data-binary @CT.X.1.2.276.0.7230010.dcm | |
58 | |
59 The code distribution of Orthanc contains a `sample Python script | |
60 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/ImportDicomFiles/ImportDicomFiles.py>`__ | |
61 that recursively upload the content of some folder into Orthanc using | |
62 the REST API:: | |
63 | |
64 $ python ImportDicomFiles.py localhost 8042 ~/DICOM/ | |
65 | |
66 | |
67 .. _rest-access: | |
68 | |
69 Accessing the content of Orthanc | |
70 -------------------------------- | |
71 | |
72 Orthanc structures the stored DICOM resources using the "Patient, | |
73 Study, Series, Instance" model of the DICOM standard. Each DICOM | |
74 resource is associated with an :ref:`unique identifier <orthanc-ids>`. | |
75 | |
76 List all the DICOM resources | |
77 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
78 | |
79 Here is how you would list all the DICOM resources that are stored in | |
80 your local Orthanc instance:: | |
81 | |
82 $ curl http://localhost:8042/patients | |
83 $ curl http://localhost:8042/studies | |
84 $ curl http://localhost:8042/series | |
85 $ curl http://localhost:8042/instances | |
86 | |
87 Note that the result of this command is a `JSON file | |
25 | 88 <https://en.wikipedia.org/wiki/Json>`__ that contains an array of |
0 | 89 resource identifiers. The JSON file format is lightweight and can be |
90 parsed from almost any computer language. | |
91 | |
92 Accessing a patient | |
93 ^^^^^^^^^^^^^^^^^^^ | |
94 | |
95 .. highlight:: bash | |
96 | |
97 To access a single resource, add its identifier to the `URI | |
25 | 98 <https://en.wikipedia.org/wiki/Uniform_resource_identifier>`__. You |
0 | 99 would for instance retrieve the main information about one patient as |
100 follows:: | |
101 | |
102 $ curl http://localhost:8042/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94 | |
103 | |
104 .. highlight:: json | |
105 | |
106 Here is a possible answer from Orthanc:: | |
107 | |
108 { | |
109 "ID" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea", | |
110 "MainDicomTags" : { | |
111 "OtherPatientIDs" : "(null)", | |
112 "PatientBirthDate" : "0", | |
113 "PatientID" : "000000185", | |
114 "PatientName" : "Anonymous^Unknown", | |
115 "PatientSex" : "O" | |
116 }, | |
117 "Studies" : [ "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15" ], | |
118 "Type" : "Patient" | |
119 } | |
120 | |
121 This is once again a JSON file. Note how Orthanc gives you a summary | |
122 of the main DICOM tags that correspond to the patient level. | |
123 | |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
124 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
125 .. _browsing-hierarchy: |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
126 |
0 | 127 Browsing from the patient down to the instance |
128 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
129 | |
130 .. highlight:: bash | |
131 | |
132 The field ``Studies`` list all the DICOM studies that are associated | |
133 with the patient. So, considering the patient above, we would go down | |
134 in her DICOM hierarchy as follows:: | |
135 | |
136 $ curl http://localhost:8042/studies/9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15 | |
137 | |
138 .. highlight:: json | |
139 | |
140 And Orthanc could answer:: | |
141 | |
142 { | |
143 "ID" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15", | |
144 "MainDicomTags" : { | |
145 "AccessionNumber" : "(null)", | |
146 "StudyDate" : "20120716", | |
147 "StudyDescription" : "TestSUVce-TF", | |
148 "StudyID" : "23848", | |
149 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40", | |
150 "StudyTime" : "170728" | |
151 }, | |
152 "ParentPatient" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea", | |
153 "Series" : [ | |
154 "6821d761-31fb55a9-031ebecb-ba7f9aae-ffe4ddc0", | |
155 "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35", | |
156 "7384c47e-6398f2a8-901846ef-da1e2e0b-6c50d598" | |
157 ], | |
158 "Type" : "Study" | |
159 } | |
160 | |
161 .. highlight:: bash | |
162 | |
163 The main DICOM tags are now those that are related to the study | |
164 level. It is possible to retrieve the identifier of the patient in the | |
165 ``ParentPatient`` field, which can be used to go upward the DICOM | |
166 hierarchy. But let us rather go down to the series level by using the | |
167 ``Series`` array. The next command would return information about one | |
168 of the three series that have just been reported:: | |
169 | |
170 $ curl http://localhost:8042/series/2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35 | |
171 | |
172 .. highlight:: json | |
173 | |
174 Here is a possible answer:: | |
175 | |
176 { | |
177 "ExpectedNumberOfInstances" : 45, | |
178 "ID" : "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35", | |
179 "Instances" : [ | |
180 "41bc3f74-360f9d10-6ae9ffa4-01ea2045-cbd457dd", | |
181 "1d3de868-6c4f0494-709fd140-7ccc4c94-a6daa3a8", | |
182 <...> | |
183 "1010f80b-161b71c0-897ec01b-c85cd206-e669a3ea", | |
184 "e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4" | |
185 ], | |
186 "MainDicomTags" : { | |
187 "Manufacturer" : "Philips Medical Systems", | |
188 "Modality" : "PT", | |
189 "NumberOfSlices" : "45", | |
190 "ProtocolName" : "CHU/Body_PET/CT___50", | |
191 "SeriesDate" : "20120716", | |
192 "SeriesDescription" : "[WB_CTAC] Body", | |
193 "SeriesInstanceUID" : "1.3.46.670589.28.2.12.30.26407.37145.2.2516.0.1342458737", | |
194 "SeriesNumber" : "587370", | |
195 "SeriesTime" : "171121", | |
196 "StationName" : "r054-svr" | |
197 }, | |
198 "ParentStudy" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15", | |
199 "Status" : "Complete", | |
200 "Type" : "Series" | |
201 } | |
202 | |
203 It can be seen that this series comes from a PET modality. Orthanc has | |
204 computed that this series should contain 45 instances. | |
205 | |
206 .. highlight:: bash | |
207 | |
208 So far, we have navigated from the patient level, to the study level, | |
209 and finally to the series level. There only remains the instance | |
210 level. Let us dump the content of one of the instances:: | |
211 | |
212 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4 | |
213 | |
214 .. highlight:: json | |
215 | |
216 The instance contains the following information:: | |
217 | |
218 { | |
219 "FileSize" : 70356, | |
220 "FileUuid" : "3fd265f0-c2b6-41a2-ace8-ae332db63e06", | |
221 "ID" : "e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4", | |
222 "IndexInSeries" : 6, | |
223 "MainDicomTags" : { | |
224 "ImageIndex" : "6", | |
225 "InstanceCreationDate" : "20120716", | |
226 "InstanceCreationTime" : "171344", | |
227 "InstanceNumber" : "6", | |
228 "SOPInstanceUID" : "1.3.46.670589.28.2.15.30.26407.37145.3.2116.39.1342458737" | |
229 }, | |
230 "ParentSeries" : "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35", | |
231 "Type" : "Instance" | |
232 } | |
233 | |
234 .. highlight:: bash | |
235 | |
236 The instance has the index 6 in the parent series. The instance is | |
237 stored as a raw DICOM file of 70356 bytes. You would download this | |
238 DICOM file using the following command:: | |
239 | |
240 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/file > Instance.dcm | |
241 | |
242 | |
243 Accessing the DICOM fields of an instance as a JSON file | |
244 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
245 | |
246 .. highlight:: bash | |
247 | |
248 When one gets to the instance level, you can retrieve the hierarchy of | |
249 all the DICOM tags of this instance as a JSON file:: | |
250 | |
251 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/simplified-tags | |
252 | |
253 .. highlight:: json | |
254 | |
255 Here is a excerpt of the Orthanc answer:: | |
256 | |
257 { | |
258 "ACR_NEMA_2C_VariablePixelDataGroupLength" : "57130", | |
259 "AccessionNumber" : null, | |
260 "AcquisitionDate" : "20120716", | |
261 "AcquisitionDateTime" : "20120716171219", | |
262 "AcquisitionTime" : "171219", | |
263 "ActualFrameDuration" : "3597793", | |
264 "AttenuationCorrectionMethod" : "CTAC-SG", | |
265 <...> | |
266 "PatientID" : "000000185", | |
267 "PatientName" : "Anonymous^Unknown", | |
268 "PatientOrientationCodeSequence" : [ | |
269 { | |
270 "CodeMeaning" : "recumbent", | |
271 "CodeValue" : "F-10450", | |
272 "CodingSchemeDesignator" : "99SDM", | |
273 "PatientOrientationModifierCodeSequence" : [ | |
274 { | |
275 "CodeMeaning" : "supine", | |
276 "CodeValue" : "F-10340", | |
277 "CodingSchemeDesignator" : "99SDM" | |
278 } | |
279 ] | |
280 } | |
281 ], | |
282 <...> | |
283 "StudyDescription" : "TestSUVce-TF", | |
284 "StudyID" : "23848", | |
285 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40", | |
286 "StudyTime" : "171117", | |
287 "TypeOfDetectorMotion" : "NONE", | |
288 "Units" : "BQML", | |
289 "Unknown" : null, | |
290 "WindowCenter" : "1.496995e+04", | |
291 "WindowWidth" : "2.993990e+04" | |
292 } | |
293 | |
294 .. highlight:: bash | |
295 | |
296 If you need more detailed information about the type of the variables | |
297 or if you wish to use the hexadecimal indexes of DICOM tags, you are | |
298 free to use the following URL:: | |
299 | |
300 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/tags | |
301 | |
302 Accessing the raw DICOM fields of an instance | |
303 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
304 | |
305 .. highlight:: bash | |
306 | |
307 You also have the opportunity to access the raw value of the DICOM | |
308 tags of an instance, without going through a JSON file. Here is how | |
309 you would find the Patient Name of the instance:: | |
310 | |
311 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/content/0010-0010 | |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
312 Anonymous^Unknown |
0 | 313 |
314 The list of all the available tags for this instance can also be retrieved easily:: | |
315 | |
316 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/content | |
317 | |
318 It is also possible to recursively explore the sequences of tags:: | |
319 | |
320 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/content/0008-1250/0/0040-a170/0/0008-0104 | |
321 For Attenuation Correction | |
322 | |
323 The command above has opened the "0008-1250" tag that is a DICOM | |
324 sequence, taken its first child, opened its "0040-a170" tag that is | |
325 also a sequence, taken the first child of this child, and returned the | |
326 "0008-0104" DICOM tag. | |
327 | |
328 Downloading images | |
329 ^^^^^^^^^^^^^^^^^^ | |
330 | |
331 .. highlight:: bash | |
332 | |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
333 As :ref:`explained above <browsing-hierarchy>`, the raw DICOM file |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
334 corresponding to a single instance can be retrieved as follows:: |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
335 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
336 $ curl http://localhost:8042/instances/609665c0-c5198aa2-8632476b-a00e0de0-e9075d94/file > Instance.dcm |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
337 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
338 It is also possible to download a preview PNG image that corresponds |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
339 to some DICOM instance:: |
0 | 340 |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
341 $ curl http://localhost:8042/instances/609665c0-c5198aa2-8632476b-a00e0de0-e9075d94/preview > Preview.png |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
342 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
343 The resulting image will be a standard graylevel PNG image (with 8 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
344 bits per pixel) that can be opened by any painting software. The |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
345 dynamic range of the pixel data is stretched to the [0..255] range. |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
346 An equivalent JPEG image can be downloaded by setting the `HTTP header |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
347 <https://en.wikipedia.org/wiki/List_of_HTTP_header_fields>`__ |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
348 ``Accept`` to ``image/jpeg``:: |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
349 |
169 | 350 $ curl -H 'Accept: image/jpeg' http://localhost:8042/instances/609665c0-c5198aa2-8632476b-a00e0de0-e9075d94/preview > Preview.jpg |
0 | 351 |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
352 If you don't want to stretch the dynamic range, and create a 8bpp or |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
353 16bpp PNG image, you can use the following URIs:: |
0 | 354 |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
355 $ curl http://localhost:8042/instances/609665c0-c5198aa2-8632476b-a00e0de0-e9075d94/image-uint8 > full-8.png |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
356 $ curl http://localhost:8042/instances/609665c0-c5198aa2-8632476b-a00e0de0-e9075d94/image-uint16 > full-16.png |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
357 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
358 In these images, the values are cropped to the maximal value that can |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
359 be encoded by the target image format. The |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
360 ``/instances/{...}/image-int16`` is available as well to download |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
361 signed DICOM pixel data. |
0 | 362 |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
363 Since Orthanc 1.4.2, it is also possible to download such images in |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
364 the generic `PAM format |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
365 <https://en.wikipedia.org/wiki/Netpbm#PAM_graphics_format>`__:: |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
366 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
367 $ curl -H 'Accept: image/x-portable-arbitrarymap' http://localhost:8042/instances/609665c0-c5198aa2-8632476b-a00e0de0-e9075d94/image-uint16 > full-16.pam |
0 | 368 |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
369 Users of Matlab or Octave can find related information :ref:`in the |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
370 dedicated section <matlab>`. |
0 | 371 |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
372 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
373 .. _changes: |
0 | 374 |
375 Sending resources to remote modalities | |
376 -------------------------------------- | |
377 | |
378 Orthanc can send its DICOM instances to remote DICOM modalities (C-Store SCU). This process | |
379 can be triggered by the REST API. | |
380 | |
381 Configuration | |
382 ^^^^^^^^^^^^^ | |
383 | |
384 .. highlight:: json | |
385 | |
386 You first have to declare the AET, the IP address and the port number | |
387 of the remote modality inside the :ref:`configuration file | |
388 <configuration>`. For instance, here is how to declare a remote | |
389 modality:: | |
390 | |
391 ... | |
392 "DicomModalities" : { | |
212 | 393 "sample" : [ "ORTHANCA", "127.0.0.1", 2000 ], // short version |
394 "sample2" : { // long version | |
395 "AET" : "ORTHANCB", | |
396 "Port" : 2001, | |
397 "Host" : "127.0.0.1", | |
398 "Manufacturer" : "Generic", | |
399 "AllowEcho" : true, | |
400 "AllowFind" : true, | |
401 "AllowMove" : true, | |
402 "AllowStore" : true | |
403 } | |
0 | 404 }, |
405 ... | |
406 | |
407 .. highlight:: bash | |
408 | |
212 | 409 Such a configuration would enable Orthanc to connect to two DICOM |
410 stores (for instance, other Orthanc instances) that listens on the | |
411 localhost on the port 2000 & 2001. The modalities that are known to Orthanc | |
0 | 412 can be queried:: |
413 | |
212 | 414 $ curl http://localhost:8042/modalities?expand |
415 | |
416 The modalities can then be updated through the API too:: | |
417 | |
418 $ curl -v -X PUT http://localhost:8042/modalities/sample -d '{"AET" : "ORTHANCC", "Host": "127.0.0.1", "Port": 2002}' | |
419 | |
0 | 420 |
212 | 421 Note that, by default, modalities are stored in Orthanc configuration files |
422 and are updated in Orthanc memory only. If you want your modifications | |
423 to be persistent, you should configure Orthanc to store its modalities | |
424 in the database. This is done through this configuration:: | |
425 | |
426 ... | |
427 "DicomModalitiesInDatabase" : true, | |
428 ... | |
0 | 429 |
430 Sending One Resource | |
431 ^^^^^^^^^^^^^^^^^^^^ | |
432 | |
433 .. highlight:: bash | |
434 | |
435 Once you have identified the Orthanc identifier of the DICOM resource | |
436 that would like to send :ref:`as explained above <rest-access>`, you | |
437 would use the following command to send it:: | |
438 | |
439 $ curl -X POST http://localhost:8042/modalities/sample/store -d c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f | |
440 | |
441 The ``/sample/`` component of the URI corresponds to the identifier of | |
442 the remote modality, as specified above in the configuration file. | |
443 | |
173
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
444 Note that you can send isolated DICOM instances with this command, but |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
445 also entire patients, studies or series. |
0 | 446 |
447 Bulk Store SCU | |
448 ^^^^^^^^^^^^^^ | |
449 | |
450 .. highlight:: bash | |
451 | |
452 Each time a POST request is made to ``/modalities/.../store``, a new | |
173
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
453 DICOM association is possibly established. This may lead to a large |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
454 communication overhead if sending multiple isolated instances by |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
455 making one REST call for each of these instances. |
0 | 456 |
457 To circumvent this problem, you have 2 possibilities: | |
458 | |
459 1. Set the ``DicomAssociationCloseDelay`` option in the | |
460 :ref:`configuration file <configuration>` to a non-zero value. This | |
461 will keep the DICOM connection open for a certain amount of time, | |
173
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
462 waiting for new instances to be routed. This is useful if |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
463 autorouting images :ref:`using Lua <lua-auto-routing>`. |
0 | 464 |
173
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
465 2. It is possible to send multiple instances with a single POST |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
466 request (so-called "Bulk Store SCU", available from Orthanc |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
467 0.5.2):: |
0 | 468 |
469 $ curl -X POST http://localhost:8042/modalities/sample/store -d '["d4b46c8e-74b16992-b0f5ca11-f04a60fa-8eb13a88","d5604121-7d613ce6-c315a5-a77b3cf3-9c253b23","cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e"]' | |
470 | |
471 The list of the resources to be sent are given as a JSON array. In | |
472 this case, a single DICOM connection is used. `Sample code is | |
473 available | |
474 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Python/HighPerformanceAutoRouting.py>`__. | |
475 | |
173
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
476 Note that the list of resources to be sent can include the |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
477 :ref:`Orthanc identifiers <orthanc-ids>` of entire patients, |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
478 studies or series as well. |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
479 |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
480 |
0 | 481 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
482 Performing Query/Retrieve and Find with REST |
138 | 483 -------------------------------------------- |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
484 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
485 *Section contributed by Bryan Dearlove* |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
486 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
487 Orthanc can be used to perform queries on the local Orthanc instance, |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
488 or on remote modalities through the REST API. |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
489 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
490 To perform a query of a remote modality you must define the modality |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
491 within the :ref:`configuration file <configuration>` (See |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
492 Configuration section under Sending resources to remote modalities). |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
493 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
494 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
495 Performing Queries on Modalities |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
496 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
497 |
138 | 498 .. highlight:: bash |
499 | |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
500 To initiate a query you perform a POST command against the Modality |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
501 with the identifiers you are looking for. The the example below we are |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
502 performing a study level query against the modality sample for any |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
503 study descriptions with the word chest within it. This search is case |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
504 insensitive unless configured otherwise within the Orthanc |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
505 configuration file:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
506 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
507 $ curl --request POST \ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
508 --url http://localhost:8042/modalities/sample/query \ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
509 --data '{"Level":"Study","Query": {"PatientID":"","StudyDescription":"*Chest*","PatientName":""}}' |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
510 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
511 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
512 .. highlight:: json |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
513 |
138 | 514 You will receive back an ID which can be used to retrieve more |
515 information with GET commands or C-Move requests with a POST Command:: | |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
516 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
517 { |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
518 "ID": "5af318ac-78fb-47ff-b0b0-0df18b0588e0", |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
519 "Path": "/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0" |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
520 } |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
521 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
522 |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
523 Additional Options |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
524 ^^^^^^^^^^^^^^^^^^ |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
525 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
526 .. highlight:: json |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
527 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
528 You can use patient identifiers by including the `*` within your |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
529 search. For example if you were searching for a name beginning with |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
530 `Jones` you can do:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
531 |
139 | 532 "PatientName":"Jones*" |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
533 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
534 If you wanted to search for a name with the words `Jo` anywhere within |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
535 it you can do:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
536 |
139 | 537 "PatientName":"*Jo*" |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
538 |
138 | 539 To perform date searches you can specify within StudyDate a starting |
540 date and/or a before date. For example ``"StudyDate":"20180323-"`` | |
541 would search for all study dates after the specified date to | |
542 now. Doing ``"StudyDate":"20180323-20180325"`` would search for all | |
543 study dates between the specified date. | |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
544 |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
545 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
546 Reviewing Level |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
547 ^^^^^^^^^^^^^^^ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
548 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
549 .. highlight:: bash |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
550 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
551 :: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
552 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
553 $ curl --request GET --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/level |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
554 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
555 Will retrieve the level with which the query was performed, Study, |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
556 Series or Instance. |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
557 |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
558 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
559 Reviewing Modality |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
560 ^^^^^^^^^^^^^^^^^^ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
561 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
562 .. highlight:: bash |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
563 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
564 :: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
565 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
566 $ curl --request GET --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/modality |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
567 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
568 Will provide the modality name which the original query was performed against. |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
569 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
570 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
571 Reviewing Query |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
572 ^^^^^^^^^^^^^^^ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
573 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
574 .. highlight:: bash |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
575 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
576 To retrieve information on what identifiers the query was originally |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
577 performed using you can use the query filter:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
578 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
579 $ curl --request GET --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/query |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
580 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
581 |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
582 Reviewing Query Answers |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
583 ^^^^^^^^^^^^^^^^^^^^^^^ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
584 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
585 .. highlight:: bash |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
586 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
587 You are able to individually review each answer returned by performing |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
588 a GET with the answers parameter:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
589 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
590 $ curl --request GET --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/answers |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
591 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
592 You will get a JSON back with numbered identifiers for each answer you |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
593 received back. For example because we performed a Study level query we |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
594 received back 5 studies answers back. We are able to query each answer |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
595 for content details:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
596 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
597 $ curl --request GET --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/answers/0/content |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
598 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
599 If there are content items missing, you may add them by adding that |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
600 identifier to the original query. For example if we wanted Modalities |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
601 listed in this JSON answer in the initial query we would add to the |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
602 POST body: `"ModalitiesInStudy":""` |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
603 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
604 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
605 Performing Retrieve (C-Move) |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
606 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
607 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
608 .. highlight:: bash |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
609 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
610 You can perform a C-Move to retrieve all studies within the original |
205
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
611 query using a post command and identifying the Modality (named in this |
207 | 612 example ``Orthanc``), to be one to in the POST contents:: |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
613 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
614 $ curl --request POST --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/retrieve --data Orthanc |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
615 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
616 You are also able to perform individual C-Moves for a content item by |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
617 specifying that individual content item:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
618 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
619 $ curl --request POST --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/answers/0/retrieve --data Orthanc |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
620 |
207 | 621 If C-Moves take too long (for example, performing a C-Move of a big |
622 study), you may run the request in asynchronous fashion, which will | |
623 create a job in Orthanc:: | |
205
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
624 |
207 | 625 $ curl --request POST --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/retrieve \ |
626 --data '{"TargetAet":"Orthanc","Synchronous":false}' | |
627 | |
205
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
628 |
207 | 629 .. highlight:: bash |
630 | |
631 The answer of this POST request is the job ID taking care of the C-Move:: | |
205
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
632 |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
633 { |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
634 "ID" : "11541b16-e368-41cf-a8e9-3acf4061d238", |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
635 "Path" : "/jobs/11541b16-e368-41cf-a8e9-3acf4061d238" |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
636 } |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
637 |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
638 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
639 Performing Finds within Orthanc |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
640 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
641 .. highlight:: bash |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
642 |
138 | 643 Performing a find within Orthanc is very similar to using Queries |
644 against DICOM modalities and the additional options listed above work | |
645 with find also. When performing a find, you will receive the Orthanc | |
646 ID's of all the matched items within your find. For example if you | |
647 perform a study level find and 5 Studies match you will receive 5 | |
648 study level Orthanc ID's in JSON format as a response:: | |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
649 |
138 | 650 $ curl --request POST --url http://localhost:8042/tools/find --data '{"Level":"Instance","Query":{"Modality":"CR","StudyDate":"20180323-","PatientID":"*"}}' |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
651 |
138 | 652 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
653 Additional Options |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
654 ^^^^^^^^^^^^^^^^^^ |
138 | 655 .. highlight:: json |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
656 |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
657 You also have the ability to limit the responses by specifying a limit within the body of the POST message. For example:: |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
658 |
138 | 659 "Limit":4 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
660 |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
661 |
0 | 662 Tracking changes |
663 ---------------- | |
664 | |
665 .. highlight:: bash | |
666 | |
667 Whenever Orthanc receives a new DICOM instance, this event is recorded | |
668 in the so-called "Changes Log". This enables remote scripts to react | |
669 to the arrival of new DICOM resources. A typical application is | |
670 **auto-routing**, where an external script waits for a new DICOM | |
671 instance to arrive into Orthanc, then forward this instance to another | |
672 modality. | |
673 | |
674 The Changes Log can be accessed by the following command:: | |
675 | |
676 $ curl http://localhost:8042/changes | |
677 | |
678 .. highlight:: json | |
679 | |
680 Here is a typical output:: | |
681 | |
682 { | |
683 "Changes" : [ | |
684 { | |
685 "ChangeType" : "NewInstance", | |
686 "Date" : "20130507T143902", | |
687 "ID" : "8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe", | |
688 "Path" : "/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe", | |
689 "ResourceType" : "Instance", | |
690 "Seq" : 921 | |
691 }, | |
692 { | |
693 "ChangeType" : "NewSeries", | |
694 "Date" : "20130507T143902", | |
695 "ID" : "cceb768f-e0f8df71-511b0277-07e55743-9ef8890d", | |
696 "Path" : "/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d", | |
697 "ResourceType" : "Series", | |
698 "Seq" : 922 | |
699 }, | |
700 { | |
701 "ChangeType" : "NewStudy", | |
702 "Date" : "20130507T143902", | |
703 "ID" : "c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f", | |
704 "Path" : "/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f", | |
705 "ResourceType" : "Study", | |
706 "Seq" : 923 | |
707 }, | |
708 { | |
709 "ChangeType" : "NewPatient", | |
710 "Date" : "20130507T143902", | |
711 "ID" : "dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94", | |
712 "Path" : "/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94", | |
713 "ResourceType" : "Patient", | |
714 "Seq" : 924 | |
715 } | |
716 ], | |
717 "Done" : true, | |
718 "Last" : 924 | |
719 } | |
720 | |
721 This output corresponds to the receiving of one single DICOM instance | |
722 by Orthanc. It records that a new instance, a new series, a new study | |
723 and a new patient has been created inside Orthanc. Note that each | |
724 changes is labeled by a ``ChangeType``, a ``Date`` (in the `ISO format | |
25 | 725 <https://en.wikipedia.org/wiki/ISO_8601>`__), the location of the |
0 | 726 resource inside Orthanc, and a sequence number (``Seq``). |
727 | |
728 Note that this call is non-blocking. It is up to the calling program | |
729 to wait for the occurrence of a new event (by implementing a polling | |
730 loop). | |
731 | |
732 .. highlight:: bash | |
733 | |
734 This call only returns a fixed number of events, that can be changed | |
735 by using the ``limit`` option:: | |
736 | |
737 $ curl http://localhost:8042/changes?limit=100 | |
738 | |
739 The flag ``Last`` records the sequence number of the lastly returned | |
740 event. The flag ``Done`` is set to ``true`` if no further event has | |
741 occurred after this lastly returned event. If ``Done`` is set to | |
742 ``false``, further events are available and can be retrieved. This is | |
743 done by setting the ``since`` option that specifies from which | |
744 sequence number the changes must be returned:: | |
745 | |
746 $ curl 'http://localhost:8042/changes?limit=100&since=922' | |
747 | |
748 A `sample code in the source distribution | |
749 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Python/ChangesLoop.py>`__ | |
750 shows how to use this Changes API to implement a polling loop. | |
751 | |
752 | |
753 Deleting resources from Orthanc | |
754 ------------------------------- | |
755 | |
756 .. highlight:: bash | |
757 | |
758 Deleting patients, studies, series or instances | |
759 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
760 | |
761 Deleting DICOM resources (i.e. patients, studies, series or instances) | |
762 from Orthanc is as simple as using a HTTP DELETE on the URI of this | |
763 resource. | |
764 | |
765 Concretely, you would first explore the resources that are stored in | |
766 Orthanc :ref:`as explained above <rest-access>`:: | |
767 | |
768 $ curl http://localhost:8042/patients | |
769 $ curl http://localhost:8042/studies | |
770 $ curl http://localhost:8042/series | |
771 $ curl http://localhost:8042/instances | |
772 | |
773 Secondly, once you have spotted the resources to be removed, you would | |
774 use the following command-line syntax to delete them:: | |
775 | |
776 $ curl -X DELETE http://localhost:8042/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94 | |
777 $ curl -X DELETE http://localhost:8042/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f | |
778 $ curl -X DELETE http://localhost:8042/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d | |
779 $ curl -X DELETE http://localhost:8042/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe | |
780 | |
781 | |
782 Clearing log of changes | |
783 ^^^^^^^^^^^^^^^^^^^^^^^ | |
784 | |
785 :ref:`As described above <changes>`, Orthanc keeps track of all the | |
786 changes that occur in the DICOM store. This so-called "Changes Log" | |
787 is accessible at the following URI:: | |
788 | |
789 $ curl http://localhost:8042/changes | |
790 | |
791 To clear the content of the Changes Log, simply DELETE this URI:: | |
792 | |
793 $ curl -X DELETE http://localhost:8042/changes | |
794 | |
795 | |
155 | 796 Log of exported resources |
797 ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
798 | |
799 For medical traceability, Orthanc can be configured to store a log of | |
800 all the resources that have been exported to remote modalities:: | |
0 | 801 |
802 $ curl http://localhost:8042/exports | |
803 | |
804 In auto-routing scenarios, it is important to prevent this log to grow | |
805 indefinitely as incoming instances are routed. You can either disable | |
806 this logging by setting the option ``LogExportedResources`` to ``false`` | |
807 in the :ref:`configuration file <configuration>`, or periodically | |
808 clear this log by DELETE-ing this URI:: | |
809 | |
810 $ curl -X DELETE http://localhost:8042/exports | |
811 | |
155 | 812 NB: Starting with Orthanc 1.4.0, the ``LogExportedResources`` is set |
813 to ``false`` by default. If the logging is desired, set this option to | |
814 ``true``. | |
815 | |
0 | 816 |
817 Anonymization and modification | |
818 ------------------------------ | |
819 | |
820 The process of anonymizing and modifying DICOM resources is | |
821 :ref:`documented in a separate page <anonymization>`. | |
822 | |
823 | |
824 Further reading | |
825 --------------- | |
826 | |
827 The examples above have shown you the basic principles for driving an | |
828 instance of Orthanc through its REST API. All the possibilities of the | |
35
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
829 API have not been described: |
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
830 |
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
831 * A :ref:`FAQ entry <rest-samples>` lists where you can find more |
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
832 advanced samples of the REST API of Orthanc. |
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
833 * The full documentation of the REST API is maintained as an online |
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
834 spreadsheet accessible from the `documentation part of the official |
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
835 Web site |
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
836 <http://www.orthanc-server.com/static.php?page=documentation>`__ |
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
837 (click on the *Reference of the REST API* button). |