Mercurial > hg > orthanc-book
annotate Sphinx/source/users/rest.rst @ 313:8e97e0524e16
cont
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Thu, 06 Feb 2020 09:47:29 +0100 |
parents | b19b892977a2 |
children | 5f0cd51d97c0 |
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 | |
297
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
67 .. highlight:: perl |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
68 |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
69 If you are using Powershell (>= 3.0), you can use the following to send a single |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
70 Dicom instance to Orthanc:: |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
71 |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
72 # disabling progress bar tremendously increases the Invoke-RestMethod call |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
73 $ProgressPreference = 'SilentlyContinue' |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
74 |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
75 # upload it to Orthanc |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
76 $reply = Invoke-RestMethod http://localhost:8042/instances -Method POST -InFile CT.X.1.2.276.0.7230010.dcm |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
77 |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
78 # display the result |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
79 Write-Host "The instance can be retrieved at http://localhost:8042$($reply.Path)" |
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
294
diff
changeset
|
80 |
0 | 81 .. _rest-access: |
82 | |
83 Accessing the content of Orthanc | |
84 -------------------------------- | |
85 | |
86 Orthanc structures the stored DICOM resources using the "Patient, | |
87 Study, Series, Instance" model of the DICOM standard. Each DICOM | |
88 resource is associated with an :ref:`unique identifier <orthanc-ids>`. | |
89 | |
90 List all the DICOM resources | |
91 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
92 | |
93 Here is how you would list all the DICOM resources that are stored in | |
94 your local Orthanc instance:: | |
95 | |
96 $ curl http://localhost:8042/patients | |
97 $ curl http://localhost:8042/studies | |
98 $ curl http://localhost:8042/series | |
99 $ curl http://localhost:8042/instances | |
100 | |
101 Note that the result of this command is a `JSON file | |
25 | 102 <https://en.wikipedia.org/wiki/Json>`__ that contains an array of |
0 | 103 resource identifiers. The JSON file format is lightweight and can be |
104 parsed from almost any computer language. | |
105 | |
106 Accessing a patient | |
107 ^^^^^^^^^^^^^^^^^^^ | |
108 | |
109 .. highlight:: bash | |
110 | |
111 To access a single resource, add its identifier to the `URI | |
25 | 112 <https://en.wikipedia.org/wiki/Uniform_resource_identifier>`__. You |
0 | 113 would for instance retrieve the main information about one patient as |
114 follows:: | |
115 | |
116 $ curl http://localhost:8042/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94 | |
117 | |
118 .. highlight:: json | |
119 | |
120 Here is a possible answer from Orthanc:: | |
121 | |
122 { | |
123 "ID" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea", | |
124 "MainDicomTags" : { | |
125 "OtherPatientIDs" : "(null)", | |
126 "PatientBirthDate" : "0", | |
127 "PatientID" : "000000185", | |
128 "PatientName" : "Anonymous^Unknown", | |
129 "PatientSex" : "O" | |
130 }, | |
131 "Studies" : [ "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15" ], | |
132 "Type" : "Patient" | |
133 } | |
134 | |
135 This is once again a JSON file. Note how Orthanc gives you a summary | |
136 of the main DICOM tags that correspond to the patient level. | |
137 | |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
138 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
139 .. _browsing-hierarchy: |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
140 |
0 | 141 Browsing from the patient down to the instance |
142 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
143 | |
144 .. highlight:: bash | |
145 | |
146 The field ``Studies`` list all the DICOM studies that are associated | |
147 with the patient. So, considering the patient above, we would go down | |
148 in her DICOM hierarchy as follows:: | |
149 | |
150 $ curl http://localhost:8042/studies/9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15 | |
151 | |
152 .. highlight:: json | |
153 | |
154 And Orthanc could answer:: | |
155 | |
156 { | |
157 "ID" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15", | |
158 "MainDicomTags" : { | |
159 "AccessionNumber" : "(null)", | |
160 "StudyDate" : "20120716", | |
161 "StudyDescription" : "TestSUVce-TF", | |
162 "StudyID" : "23848", | |
163 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40", | |
164 "StudyTime" : "170728" | |
165 }, | |
166 "ParentPatient" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea", | |
167 "Series" : [ | |
168 "6821d761-31fb55a9-031ebecb-ba7f9aae-ffe4ddc0", | |
169 "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35", | |
170 "7384c47e-6398f2a8-901846ef-da1e2e0b-6c50d598" | |
171 ], | |
172 "Type" : "Study" | |
173 } | |
174 | |
175 .. highlight:: bash | |
176 | |
177 The main DICOM tags are now those that are related to the study | |
178 level. It is possible to retrieve the identifier of the patient in the | |
179 ``ParentPatient`` field, which can be used to go upward the DICOM | |
180 hierarchy. But let us rather go down to the series level by using the | |
181 ``Series`` array. The next command would return information about one | |
182 of the three series that have just been reported:: | |
183 | |
184 $ curl http://localhost:8042/series/2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35 | |
185 | |
186 .. highlight:: json | |
187 | |
188 Here is a possible answer:: | |
189 | |
190 { | |
191 "ExpectedNumberOfInstances" : 45, | |
192 "ID" : "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35", | |
193 "Instances" : [ | |
194 "41bc3f74-360f9d10-6ae9ffa4-01ea2045-cbd457dd", | |
195 "1d3de868-6c4f0494-709fd140-7ccc4c94-a6daa3a8", | |
196 <...> | |
197 "1010f80b-161b71c0-897ec01b-c85cd206-e669a3ea", | |
198 "e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4" | |
199 ], | |
200 "MainDicomTags" : { | |
201 "Manufacturer" : "Philips Medical Systems", | |
202 "Modality" : "PT", | |
203 "NumberOfSlices" : "45", | |
204 "ProtocolName" : "CHU/Body_PET/CT___50", | |
205 "SeriesDate" : "20120716", | |
206 "SeriesDescription" : "[WB_CTAC] Body", | |
207 "SeriesInstanceUID" : "1.3.46.670589.28.2.12.30.26407.37145.2.2516.0.1342458737", | |
208 "SeriesNumber" : "587370", | |
209 "SeriesTime" : "171121", | |
210 "StationName" : "r054-svr" | |
211 }, | |
212 "ParentStudy" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15", | |
213 "Status" : "Complete", | |
214 "Type" : "Series" | |
215 } | |
216 | |
217 It can be seen that this series comes from a PET modality. Orthanc has | |
218 computed that this series should contain 45 instances. | |
219 | |
220 .. highlight:: bash | |
221 | |
222 So far, we have navigated from the patient level, to the study level, | |
223 and finally to the series level. There only remains the instance | |
224 level. Let us dump the content of one of the instances:: | |
225 | |
226 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4 | |
227 | |
228 .. highlight:: json | |
229 | |
230 The instance contains the following information:: | |
231 | |
232 { | |
233 "FileSize" : 70356, | |
234 "FileUuid" : "3fd265f0-c2b6-41a2-ace8-ae332db63e06", | |
235 "ID" : "e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4", | |
236 "IndexInSeries" : 6, | |
237 "MainDicomTags" : { | |
238 "ImageIndex" : "6", | |
239 "InstanceCreationDate" : "20120716", | |
240 "InstanceCreationTime" : "171344", | |
241 "InstanceNumber" : "6", | |
242 "SOPInstanceUID" : "1.3.46.670589.28.2.15.30.26407.37145.3.2116.39.1342458737" | |
243 }, | |
244 "ParentSeries" : "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35", | |
245 "Type" : "Instance" | |
246 } | |
247 | |
248 .. highlight:: bash | |
249 | |
250 The instance has the index 6 in the parent series. The instance is | |
251 stored as a raw DICOM file of 70356 bytes. You would download this | |
252 DICOM file using the following command:: | |
253 | |
254 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/file > Instance.dcm | |
255 | |
256 | |
257 Accessing the DICOM fields of an instance as a JSON file | |
258 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
259 | |
260 .. highlight:: bash | |
261 | |
262 When one gets to the instance level, you can retrieve the hierarchy of | |
263 all the DICOM tags of this instance as a JSON file:: | |
264 | |
265 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/simplified-tags | |
266 | |
267 .. highlight:: json | |
268 | |
269 Here is a excerpt of the Orthanc answer:: | |
270 | |
271 { | |
272 "ACR_NEMA_2C_VariablePixelDataGroupLength" : "57130", | |
273 "AccessionNumber" : null, | |
274 "AcquisitionDate" : "20120716", | |
275 "AcquisitionDateTime" : "20120716171219", | |
276 "AcquisitionTime" : "171219", | |
277 "ActualFrameDuration" : "3597793", | |
278 "AttenuationCorrectionMethod" : "CTAC-SG", | |
279 <...> | |
280 "PatientID" : "000000185", | |
281 "PatientName" : "Anonymous^Unknown", | |
282 "PatientOrientationCodeSequence" : [ | |
283 { | |
284 "CodeMeaning" : "recumbent", | |
285 "CodeValue" : "F-10450", | |
286 "CodingSchemeDesignator" : "99SDM", | |
287 "PatientOrientationModifierCodeSequence" : [ | |
288 { | |
289 "CodeMeaning" : "supine", | |
290 "CodeValue" : "F-10340", | |
291 "CodingSchemeDesignator" : "99SDM" | |
292 } | |
293 ] | |
294 } | |
295 ], | |
296 <...> | |
297 "StudyDescription" : "TestSUVce-TF", | |
298 "StudyID" : "23848", | |
299 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40", | |
300 "StudyTime" : "171117", | |
301 "TypeOfDetectorMotion" : "NONE", | |
302 "Units" : "BQML", | |
303 "Unknown" : null, | |
304 "WindowCenter" : "1.496995e+04", | |
305 "WindowWidth" : "2.993990e+04" | |
306 } | |
307 | |
308 .. highlight:: bash | |
309 | |
310 If you need more detailed information about the type of the variables | |
311 or if you wish to use the hexadecimal indexes of DICOM tags, you are | |
312 free to use the following URL:: | |
313 | |
314 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/tags | |
315 | |
316 Accessing the raw DICOM fields of an instance | |
317 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
318 | |
319 .. highlight:: bash | |
320 | |
321 You also have the opportunity to access the raw value of the DICOM | |
322 tags of an instance, without going through a JSON file. Here is how | |
323 you would find the Patient Name of the instance:: | |
324 | |
325 $ 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
|
326 Anonymous^Unknown |
0 | 327 |
328 The list of all the available tags for this instance can also be retrieved easily:: | |
329 | |
330 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/content | |
331 | |
332 It is also possible to recursively explore the sequences of tags:: | |
333 | |
334 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/content/0008-1250/0/0040-a170/0/0008-0104 | |
335 For Attenuation Correction | |
336 | |
337 The command above has opened the "0008-1250" tag that is a DICOM | |
338 sequence, taken its first child, opened its "0040-a170" tag that is | |
339 also a sequence, taken the first child of this child, and returned the | |
340 "0008-0104" DICOM tag. | |
341 | |
342 Downloading images | |
343 ^^^^^^^^^^^^^^^^^^ | |
344 | |
345 .. highlight:: bash | |
346 | |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
347 As :ref:`explained above <browsing-hierarchy>`, the raw DICOM file |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
348 corresponding to a single instance can be retrieved as follows:: |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
349 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
350 $ 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
|
351 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
352 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
|
353 to some DICOM instance:: |
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/preview > Preview.png |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
356 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
357 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
|
358 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
|
359 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
|
360 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
|
361 <https://en.wikipedia.org/wiki/List_of_HTTP_header_fields>`__ |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
362 ``Accept`` to ``image/jpeg``:: |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
363 |
169 | 364 $ curl -H 'Accept: image/jpeg' http://localhost:8042/instances/609665c0-c5198aa2-8632476b-a00e0de0-e9075d94/preview > Preview.jpg |
0 | 365 |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
366 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
|
367 16bpp PNG image, you can use the following URIs:: |
0 | 368 |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
369 $ 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
|
370 $ 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
|
371 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
372 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
|
373 be encoded by the target image format. The |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
374 ``/instances/{...}/image-int16`` is available as well to download |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
375 signed DICOM pixel data. |
0 | 376 |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
377 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
|
378 the generic `PAM format |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
379 <https://en.wikipedia.org/wiki/Netpbm#PAM_graphics_format>`__:: |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
380 |
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
381 $ curl -H 'Accept: image/x-portable-arbitrarymap' http://localhost:8042/instances/609665c0-c5198aa2-8632476b-a00e0de0-e9075d94/image-uint16 > full-16.pam |
0 | 382 |
168
86e92d0cc53e
information about images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
383 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
|
384 dedicated section <matlab>`. |
0 | 385 |
218 | 386 |
387 .. _peering: | |
388 | |
216 | 389 Sending resources to remote Orthanc over HTTP/HTTPS (through Orthanc peering) |
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
223
diff
changeset
|
390 ----------------------------------------------------------------------------- |
216 | 391 |
392 Orthanc can send its DICOM instances to remote Orthanc over HTTP/HTTPS through its Rest API. | |
393 This process can be triggered by the REST API. | |
394 | |
395 Configuration | |
396 ^^^^^^^^^^^^^ | |
397 | |
398 .. highlight:: json | |
399 | |
400 You first have to declare the Url of the remote orthanc inside the :ref:`configuration file | |
401 <configuration>`. For instance, here is how to declare a remote | |
402 orthanc peer:: | |
403 | |
404 ... | |
405 "Peers" : { | |
406 "sample" : [ "http://localhost:8043" ], // short version | |
407 "sample2" : { // long version | |
408 "Url" : "http://localhost:8044", | |
409 "Username" : "alice", // optional | |
410 "Password" : "alicePassword", // optional | |
411 "HttpHeaders" : { "Token" : "Hello world" }, // optional | |
412 "CertificateFile" : "client.crt", // optional (only if using client certificate authentication) | |
413 "CertificateKeyFile" : "client.key", // optional (only if using client certificate authentication) | |
414 "CertificateKeyPassword" : "certpass" // optional (only if using client certificate authentication) | |
415 }, | |
416 ... | |
417 | |
418 .. highlight:: bash | |
419 | |
420 Such a configuration would enable Orthanc to connect to two other | |
421 Orthanc instances that listens on the | |
422 localhost on the port 8043 & 8044. The peers that are known to Orthanc | |
423 can be queried:: | |
424 | |
425 $ curl http://localhost:8042/peers?expand | |
426 | |
427 The peers can then be updated through the API too:: | |
428 | |
429 $ curl -v -X PUT http://localhost:8042/peers/sample -d '{"Url" : "http://127.0.0.1:8043"}' | |
430 | |
431 | |
432 Note that, by default, peers are stored in Orthanc configuration files | |
433 and are updated in Orthanc memory only. If you want your modifications | |
434 to be persistent, you should configure Orthanc to store its peers | |
435 in the database. This is done through this configuration:: | |
0 | 436 |
216 | 437 ... |
438 "OrthancPeersInDatabase" : true, | |
439 ... | |
440 | |
441 Sending One Resource | |
442 ^^^^^^^^^^^^^^^^^^^^ | |
443 | |
444 .. highlight:: bash | |
445 | |
446 Once you have identified the Orthanc identifier of the DICOM resource | |
447 that would like to send :ref:`as explained above <rest-access>`, you | |
448 would use the following command to send it:: | |
449 | |
450 $ curl -X POST http://localhost:8042/peers/sample/store -d c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f | |
451 | |
452 The ``/sample/`` component of the URI corresponds to the identifier of | |
453 the remote modality, as specified above in the configuration file. | |
454 | |
455 Note that you can send isolated DICOM instances with this command, but | |
456 also entire patients, studies or series. It is possible to send multiple instances with a single POST | |
457 request:: | |
458 | |
459 $ curl -X POST http://localhost:8042/peers/sample/store -d '["d4b46c8e-74b16992-b0f5ca11-f04a60fa-8eb13a88","d5604121-7d613ce6-c315a5-a77b3cf3-9c253b23","cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e"]' | |
460 | |
461 Note that the list of resources to be sent can include the | |
462 :ref:`Orthanc identifiers <orthanc-ids>` of entire patients, | |
463 studies or series as well. | |
464 | |
294 | 465 Testing connectivity with a remote peer |
466 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
467 | |
468 .. highlight:: bash | |
469 | |
470 In version 1.5.9+, we have introduced a route to retrieve the ``/system`` info from | |
471 a remote peer. This route can also be used to test the connectivity with that peer | |
472 without actually sending a DICOM resource.:: | |
473 | |
474 $ curl http://localhost:8042/peers/sample/system | |
475 | |
476 | |
216 | 477 Using HTTPS |
478 ^^^^^^^^^^^ | |
479 | |
480 If you're transfering medical data over internet, it is mandatory to use HTTPS. | |
481 | |
482 On the server side, we recommend to put Orthanc behing an :ref:`HTTPS server that will take care of the TLS <https>`. | |
483 | |
484 On the client side, in order for the client Orthanc to recognize the server certificate, you'll have to provide a path | |
485 to the CA (certification authority) certificates. This is done in the configuration file through this configurationg:: | |
486 | |
487 ... | |
488 "HttpsCACertificates" : "/etc/ssl/certs/ca-certificates.crt, | |
489 ... | |
490 | |
223 | 491 If you want your server to accept incoming connections for known hosts only, you can either: |
216 | 492 |
493 - configure a firewall to accept incoming connections from known IP addresses | |
494 - configure your client Orthanc to use a client certificate to authenticate at the Server. This is done through the ``CertificateFile``, ``CertificateKeyFile`` and ``CertificateKeyPassword`` entries in the configuration file. | |
495 | |
496 | |
497 | |
498 | |
499 Sending resources to remote modalities (through DICOM) | |
500 ------------------------------------------------------ | |
0 | 501 |
502 Orthanc can send its DICOM instances to remote DICOM modalities (C-Store SCU). This process | |
503 can be triggered by the REST API. | |
504 | |
505 Configuration | |
506 ^^^^^^^^^^^^^ | |
507 | |
508 .. highlight:: json | |
509 | |
510 You first have to declare the AET, the IP address and the port number | |
511 of the remote modality inside the :ref:`configuration file | |
512 <configuration>`. For instance, here is how to declare a remote | |
513 modality:: | |
514 | |
515 ... | |
516 "DicomModalities" : { | |
212 | 517 "sample" : [ "ORTHANCA", "127.0.0.1", 2000 ], // short version |
518 "sample2" : { // long version | |
519 "AET" : "ORTHANCB", | |
520 "Port" : 2001, | |
521 "Host" : "127.0.0.1", | |
522 "Manufacturer" : "Generic", | |
523 "AllowEcho" : true, | |
524 "AllowFind" : true, | |
525 "AllowMove" : true, | |
526 "AllowStore" : true | |
527 } | |
0 | 528 }, |
529 ... | |
530 | |
531 .. highlight:: bash | |
532 | |
212 | 533 Such a configuration would enable Orthanc to connect to two DICOM |
534 stores (for instance, other Orthanc instances) that listens on the | |
535 localhost on the port 2000 & 2001. The modalities that are known to Orthanc | |
0 | 536 can be queried:: |
537 | |
212 | 538 $ curl http://localhost:8042/modalities?expand |
539 | |
540 The modalities can then be updated through the API too:: | |
541 | |
542 $ curl -v -X PUT http://localhost:8042/modalities/sample -d '{"AET" : "ORTHANCC", "Host": "127.0.0.1", "Port": 2002}' | |
543 | |
0 | 544 |
212 | 545 Note that, by default, modalities are stored in Orthanc configuration files |
546 and are updated in Orthanc memory only. If you want your modifications | |
547 to be persistent, you should configure Orthanc to store its modalities | |
548 in the database. This is done through this configuration:: | |
549 | |
550 ... | |
551 "DicomModalitiesInDatabase" : true, | |
552 ... | |
0 | 553 |
554 Sending One Resource | |
555 ^^^^^^^^^^^^^^^^^^^^ | |
556 | |
557 .. highlight:: bash | |
558 | |
559 Once you have identified the Orthanc identifier of the DICOM resource | |
560 that would like to send :ref:`as explained above <rest-access>`, you | |
561 would use the following command to send it:: | |
562 | |
563 $ curl -X POST http://localhost:8042/modalities/sample/store -d c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f | |
564 | |
565 The ``/sample/`` component of the URI corresponds to the identifier of | |
566 the remote modality, as specified above in the configuration file. | |
567 | |
173
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
568 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
|
569 also entire patients, studies or series. |
0 | 570 |
571 Bulk Store SCU | |
572 ^^^^^^^^^^^^^^ | |
573 | |
574 .. highlight:: bash | |
575 | |
576 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
|
577 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
|
578 communication overhead if sending multiple isolated instances by |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
579 making one REST call for each of these instances. |
0 | 580 |
581 To circumvent this problem, you have 2 possibilities: | |
582 | |
583 1. Set the ``DicomAssociationCloseDelay`` option in the | |
584 :ref:`configuration file <configuration>` to a non-zero value. This | |
585 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
|
586 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
|
587 autorouting images :ref:`using Lua <lua-auto-routing>`. |
0 | 588 |
173
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
589 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
|
590 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
|
591 0.5.2):: |
0 | 592 |
593 $ 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"]' | |
594 | |
595 The list of the resources to be sent are given as a JSON array. In | |
596 this case, a single DICOM connection is used. `Sample code is | |
597 available | |
598 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Python/HighPerformanceAutoRouting.py>`__. | |
599 | |
173
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
600 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
|
601 :ref:`Orthanc identifiers <orthanc-ids>` of entire patients, |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
602 studies or series as well. |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
603 |
901bc7b2dbab
improved bulk store scu section
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
169
diff
changeset
|
604 |
0 | 605 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
606 Performing Query/Retrieve and Find with REST |
138 | 607 -------------------------------------------- |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
608 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
609 *Section contributed by Bryan Dearlove* |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
610 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
611 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
|
612 or on remote modalities through the REST API. |
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 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
|
615 within the :ref:`configuration file <configuration>` (See |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
616 Configuration section under Sending resources to remote modalities). |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
617 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
618 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
619 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
|
620 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
621 |
138 | 622 .. highlight:: bash |
623 | |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
624 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
|
625 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
|
626 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
|
627 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
|
628 insensitive unless configured otherwise within the Orthanc |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
629 configuration file:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
630 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
631 $ curl --request POST \ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
632 --url http://localhost:8042/modalities/sample/query \ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
633 --data '{"Level":"Study","Query": {"PatientID":"","StudyDescription":"*Chest*","PatientName":""}}' |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
634 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
635 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
636 .. highlight:: json |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
637 |
138 | 638 You will receive back an ID which can be used to retrieve more |
639 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
|
640 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
641 { |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
642 "ID": "5af318ac-78fb-47ff-b0b0-0df18b0588e0", |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
643 "Path": "/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0" |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
644 } |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
645 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
646 |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
647 Additional Options |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
648 ^^^^^^^^^^^^^^^^^^ |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
649 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
650 .. highlight:: json |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
651 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
652 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
|
653 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
|
654 `Jones` you can do:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
655 |
139 | 656 "PatientName":"Jones*" |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
657 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
658 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
|
659 it you can do:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
660 |
139 | 661 "PatientName":"*Jo*" |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
662 |
138 | 663 To perform date searches you can specify within StudyDate a starting |
664 date and/or a before date. For example ``"StudyDate":"20180323-"`` | |
665 would search for all study dates after the specified date to | |
666 now. Doing ``"StudyDate":"20180323-20180325"`` would search for all | |
667 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
|
668 |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
669 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
670 Reviewing Level |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
671 ^^^^^^^^^^^^^^^ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
672 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
673 .. highlight:: bash |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
674 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
675 :: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
676 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
677 $ 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
|
678 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
679 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
|
680 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
|
681 |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
682 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
683 Reviewing Modality |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
684 ^^^^^^^^^^^^^^^^^^ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
685 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
686 .. highlight:: bash |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
687 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
688 :: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
689 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
690 $ 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
|
691 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
692 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
|
693 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
694 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
695 Reviewing Query |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
696 ^^^^^^^^^^^^^^^ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
697 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
698 .. highlight:: bash |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
699 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
700 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
|
701 performed using you can use the query filter:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
702 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
703 $ 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
|
704 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
705 |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
706 Reviewing Query Answers |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
707 ^^^^^^^^^^^^^^^^^^^^^^^ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
708 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
709 .. highlight:: bash |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
710 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
711 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
|
712 a GET with the answers parameter:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
713 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
714 $ 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
|
715 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
716 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
|
717 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
|
718 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
|
719 for content details:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
720 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
721 $ 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
|
722 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
723 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
|
724 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
|
725 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
|
726 POST body: `"ModalitiesInStudy":""` |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
727 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
728 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
729 Performing Retrieve (C-Move) |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
730 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
731 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
732 .. highlight:: bash |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
733 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
734 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
|
735 query using a post command and identifying the Modality (named in this |
207 | 736 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
|
737 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
738 $ 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
|
739 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
740 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
|
741 specifying that individual content item:: |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
742 |
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
743 $ 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
|
744 |
207 | 745 If C-Moves take too long (for example, performing a C-Move of a big |
746 study), you may run the request in asynchronous fashion, which will | |
747 create a job in Orthanc:: | |
205
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
748 |
207 | 749 $ curl --request POST --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/retrieve \ |
750 --data '{"TargetAet":"Orthanc","Synchronous":false}' | |
751 | |
205
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
752 |
207 | 753 .. highlight:: bash |
754 | |
755 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
|
756 |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
757 { |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
758 "ID" : "11541b16-e368-41cf-a8e9-3acf4061d238", |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
759 "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
|
760 } |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
761 |
7213bef30604
rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents:
173
diff
changeset
|
762 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
763 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
|
764 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
765 .. highlight:: bash |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
766 |
138 | 767 Performing a find within Orthanc is very similar to using Queries |
768 against DICOM modalities and the additional options listed above work | |
769 with find also. When performing a find, you will receive the Orthanc | |
770 ID's of all the matched items within your find. For example if you | |
771 perform a study level find and 5 Studies match you will receive 5 | |
772 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
|
773 |
138 | 774 $ 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
|
775 |
312
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
776 Setting the ``Expand`` field to ``true`` in the POST body of the |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
777 query will automatically report details about each study:: |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
778 |
313 | 779 $ curl https://demo.orthanc-server.com/tools/find -d '{"Level":"Study","Query":{"PatientName":"KNIX"}}' |
780 [ | |
781 "b9c08539-26f93bde-c81ab0d7-bffaf2cb-a4d0bdd0" | |
782 ] | |
312
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
783 $ curl https://demo.orthanc-server.com/tools/find -d '{"Level":"Study","Query":{"PatientName":"KNIX"},"Expand":true}' |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
784 [ |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
785 { |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
786 "ID" : "b9c08539-26f93bde-c81ab0d7-bffaf2cb-a4d0bdd0", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
787 "IsStable" : true, |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
788 "LastUpdate" : "20180414T091528", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
789 "MainDicomTags" : { |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
790 "InstitutionName" : "0ECJ52puWpVIjTuhnBA0um", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
791 "ReferringPhysicianName" : "1", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
792 "StudyDate" : "20070101", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
793 "StudyDescription" : "Knee (R)", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
794 "StudyID" : "1", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
795 "StudyInstanceUID" : "1.2.840.113619.2.176.2025.1499492.7391.1171285944.390", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
796 "StudyTime" : "120000.000000" |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
797 }, |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
798 "ParentPatient" : "6816cb19-844d5aee-85245eba-28e841e6-2414fae2", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
799 "PatientMainDicomTags" : { |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
800 "PatientID" : "ozp00SjY2xG", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
801 "PatientName" : "KNIX" |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
802 }, |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
803 "Series" : [ |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
804 "20b9d0c2-97d85e07-f4dbf4d2-f09e7e6a-0c19062e", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
805 "edbfa0a9-fa2641d7-29514b1c-45881d0b-46c374bd", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
806 "f2635388-f01d497a-15f7c06b-ad7dba06-c4c599fe", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
807 "4d04593b-953ced51-87e93f11-ae4cf03c-25defdcd", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
808 "5e343c3e-3633c396-03aefde8-ba0e08c7-9c8208d3", |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
809 "8ea120d7-5057d919-837dfbcc-ccd04e0f-7f3a94aa" |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
810 ], |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
811 "Type" : "Study" |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
812 } |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
813 ] |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
814 |
b19b892977a2
expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
297
diff
changeset
|
815 |
138 | 816 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
817 Additional Options |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
818 ^^^^^^^^^^^^^^^^^^ |
138 | 819 .. highlight:: json |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
820 |
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
821 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
|
822 |
138 | 823 "Limit":4 |
136
8e08909ab69b
Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents:
132
diff
changeset
|
824 |
132
55a2ee3c462d
Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
825 |
216 | 826 .. _changes: |
827 | |
0 | 828 Tracking changes |
829 ---------------- | |
830 | |
831 .. highlight:: bash | |
832 | |
833 Whenever Orthanc receives a new DICOM instance, this event is recorded | |
834 in the so-called "Changes Log". This enables remote scripts to react | |
835 to the arrival of new DICOM resources. A typical application is | |
836 **auto-routing**, where an external script waits for a new DICOM | |
837 instance to arrive into Orthanc, then forward this instance to another | |
838 modality. | |
839 | |
840 The Changes Log can be accessed by the following command:: | |
841 | |
842 $ curl http://localhost:8042/changes | |
843 | |
844 .. highlight:: json | |
845 | |
846 Here is a typical output:: | |
847 | |
848 { | |
849 "Changes" : [ | |
850 { | |
851 "ChangeType" : "NewInstance", | |
852 "Date" : "20130507T143902", | |
853 "ID" : "8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe", | |
854 "Path" : "/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe", | |
855 "ResourceType" : "Instance", | |
856 "Seq" : 921 | |
857 }, | |
858 { | |
859 "ChangeType" : "NewSeries", | |
860 "Date" : "20130507T143902", | |
861 "ID" : "cceb768f-e0f8df71-511b0277-07e55743-9ef8890d", | |
862 "Path" : "/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d", | |
863 "ResourceType" : "Series", | |
864 "Seq" : 922 | |
865 }, | |
866 { | |
867 "ChangeType" : "NewStudy", | |
868 "Date" : "20130507T143902", | |
869 "ID" : "c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f", | |
870 "Path" : "/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f", | |
871 "ResourceType" : "Study", | |
872 "Seq" : 923 | |
873 }, | |
874 { | |
875 "ChangeType" : "NewPatient", | |
876 "Date" : "20130507T143902", | |
877 "ID" : "dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94", | |
878 "Path" : "/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94", | |
879 "ResourceType" : "Patient", | |
880 "Seq" : 924 | |
881 } | |
882 ], | |
883 "Done" : true, | |
884 "Last" : 924 | |
885 } | |
886 | |
887 This output corresponds to the receiving of one single DICOM instance | |
888 by Orthanc. It records that a new instance, a new series, a new study | |
889 and a new patient has been created inside Orthanc. Note that each | |
890 changes is labeled by a ``ChangeType``, a ``Date`` (in the `ISO format | |
25 | 891 <https://en.wikipedia.org/wiki/ISO_8601>`__), the location of the |
0 | 892 resource inside Orthanc, and a sequence number (``Seq``). |
893 | |
894 Note that this call is non-blocking. It is up to the calling program | |
895 to wait for the occurrence of a new event (by implementing a polling | |
896 loop). | |
897 | |
898 .. highlight:: bash | |
899 | |
900 This call only returns a fixed number of events, that can be changed | |
901 by using the ``limit`` option:: | |
902 | |
903 $ curl http://localhost:8042/changes?limit=100 | |
904 | |
905 The flag ``Last`` records the sequence number of the lastly returned | |
906 event. The flag ``Done`` is set to ``true`` if no further event has | |
907 occurred after this lastly returned event. If ``Done`` is set to | |
908 ``false``, further events are available and can be retrieved. This is | |
909 done by setting the ``since`` option that specifies from which | |
910 sequence number the changes must be returned:: | |
911 | |
912 $ curl 'http://localhost:8042/changes?limit=100&since=922' | |
913 | |
914 A `sample code in the source distribution | |
915 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Python/ChangesLoop.py>`__ | |
916 shows how to use this Changes API to implement a polling loop. | |
917 | |
918 | |
919 Deleting resources from Orthanc | |
920 ------------------------------- | |
921 | |
922 .. highlight:: bash | |
923 | |
924 Deleting patients, studies, series or instances | |
925 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
926 | |
927 Deleting DICOM resources (i.e. patients, studies, series or instances) | |
928 from Orthanc is as simple as using a HTTP DELETE on the URI of this | |
929 resource. | |
930 | |
931 Concretely, you would first explore the resources that are stored in | |
932 Orthanc :ref:`as explained above <rest-access>`:: | |
933 | |
934 $ curl http://localhost:8042/patients | |
935 $ curl http://localhost:8042/studies | |
936 $ curl http://localhost:8042/series | |
937 $ curl http://localhost:8042/instances | |
938 | |
939 Secondly, once you have spotted the resources to be removed, you would | |
940 use the following command-line syntax to delete them:: | |
941 | |
942 $ curl -X DELETE http://localhost:8042/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94 | |
943 $ curl -X DELETE http://localhost:8042/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f | |
944 $ curl -X DELETE http://localhost:8042/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d | |
945 $ curl -X DELETE http://localhost:8042/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe | |
946 | |
947 | |
948 Clearing log of changes | |
949 ^^^^^^^^^^^^^^^^^^^^^^^ | |
950 | |
951 :ref:`As described above <changes>`, Orthanc keeps track of all the | |
952 changes that occur in the DICOM store. This so-called "Changes Log" | |
953 is accessible at the following URI:: | |
954 | |
955 $ curl http://localhost:8042/changes | |
956 | |
957 To clear the content of the Changes Log, simply DELETE this URI:: | |
958 | |
959 $ curl -X DELETE http://localhost:8042/changes | |
960 | |
961 | |
155 | 962 Log of exported resources |
963 ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
964 | |
965 For medical traceability, Orthanc can be configured to store a log of | |
966 all the resources that have been exported to remote modalities:: | |
0 | 967 |
968 $ curl http://localhost:8042/exports | |
969 | |
970 In auto-routing scenarios, it is important to prevent this log to grow | |
971 indefinitely as incoming instances are routed. You can either disable | |
972 this logging by setting the option ``LogExportedResources`` to ``false`` | |
973 in the :ref:`configuration file <configuration>`, or periodically | |
974 clear this log by DELETE-ing this URI:: | |
975 | |
976 $ curl -X DELETE http://localhost:8042/exports | |
977 | |
155 | 978 NB: Starting with Orthanc 1.4.0, the ``LogExportedResources`` is set |
979 to ``false`` by default. If the logging is desired, set this option to | |
980 ``true``. | |
981 | |
0 | 982 |
983 Anonymization and modification | |
984 ------------------------------ | |
985 | |
986 The process of anonymizing and modifying DICOM resources is | |
987 :ref:`documented in a separate page <anonymization>`. | |
988 | |
989 | |
990 Further reading | |
991 --------------- | |
992 | |
993 The examples above have shown you the basic principles for driving an | |
994 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
|
995 API have not been described: |
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
996 |
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
223
diff
changeset
|
997 * Advanced features of the REST API can be found on :ref:`another page |
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
223
diff
changeset
|
998 <rest-advanced>`. |
35
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
999 * 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
|
1000 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
|
1001 * 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
|
1002 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
|
1003 Web site |
5737f51ff94e
How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
1004 <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
|
1005 (click on the *Reference of the REST API* button). |
275 | 1006 * A documentation of the REST API in the OpenAPI/Swagger format is |
1007 `available as work-in-progress <https://api.orthanc-server.com/>`__. |