Mercurial > hg > orthanc-book

annotate Sphinx/source/users/rest.rst @ 312:b19b892977a2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
expand in /tools/find
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 06 Feb 2020 09:46:10 +0100
parents 64d1ddab8246
children 8e97e0524e16
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. _rest:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 REST API of Orthanc
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 ===================
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 .. contents::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 :depth: 3
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 One of the major strengths of Orthanc lies in its built-in `RESTful
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 API
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 <https://en.wikipedia.org/wiki/Representational_state_transfer>`__,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 that can be used to drive Orthanc from external applications,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 independently of the programming language that is used to develop
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 these applications. The REST API of Orthanc gives a full programmatic
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 access to all the core features of Orthanc.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 Importantly, Orthanc Explorer (the embedded administrative interface
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 of Orthanc) entirely resorts to this REST API for all its features.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 This implies that anything that can be done through Orthanc Explorer,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 can also be done through REST queries.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *Note:* All the examples are illustrated with the `cURL command-line
25
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
23 tool <https://curl.haxx.se/>`__, but equivalent calls can be readily
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 transposed to any programming language that supports both HTTP and
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 JSON.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
114
736d30badda0 large POST body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 35
diff changeset
28 .. _sending-dicom-images:
736d30badda0 large POST body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 35
diff changeset
29
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 Sending DICOM images
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 --------------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 The upload of DICOM files is possible by querying the REST API using
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 the following syntax::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 $ curl -X POST http://localhost:8042/instances --data-binary @CT.X.1.2.276.0.7230010.dcm
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 .. highlight:: json
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 Orthanc will respond with a JSON file that contain information about
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 the location of the stored instance, such as::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 "ID" : "e87da270-c52b-4f2a-b8c6-bae25928d0b0",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 "Path" : "/instances/e87da270-c52b-4f2a-b8c6-bae25928d0b0",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 "Status" : "Success"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 }
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 Note that in the case of curl, setting the ``Expect`` HTTP Header will
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 significantly `reduce the execution time of POST requests
25
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
55 <http://stackoverflow.com/questions/463144/php-http-post-fails-when-curl-data-1024/463277#463277>`__::
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 $ curl -X POST -H "Expect:" http://localhost:8042/instances --data-binary @CT.X.1.2.276.0.7230010.dcm
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 The code distribution of Orthanc contains a `sample Python script
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/ImportDicomFiles/ImportDicomFiles.py>`__
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 that recursively upload the content of some folder into Orthanc using
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 the REST API::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 $ python ImportDicomFiles.py localhost 8042 ~/DICOM/
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 .. _rest-access:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 Accessing the content of Orthanc
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 --------------------------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 Orthanc structures the stored DICOM resources using the "Patient,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 Study, Series, Instance" model of the DICOM standard. Each DICOM
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 resource is associated with an :ref:`unique identifier <orthanc-ids>`.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 List all the DICOM resources
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 Here is how you would list all the DICOM resources that are stored in
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 your local Orthanc instance::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 $ curl http://localhost:8042/patients
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 $ curl http://localhost:8042/studies
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 $ curl http://localhost:8042/series
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 $ curl http://localhost:8042/instances
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 Note that the result of this command is a `JSON file
25
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
102 <https://en.wikipedia.org/wiki/Json>`__ that contains an array of
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 resource identifiers. The JSON file format is lightweight and can be
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 parsed from almost any computer language.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 Accessing a patient
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 ^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 To access a single resource, add its identifier to the `URI
25
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
112 <https://en.wikipedia.org/wiki/Uniform_resource_identifier>`__. You
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 would for instance retrieve the main information about one patient as
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 follows::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 $ curl http://localhost:8042/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 .. highlight:: json
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 Here is a possible answer from Orthanc::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 "ID" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 "MainDicomTags" : {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 "OtherPatientIDs" : "(null)",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126 "PatientBirthDate" : "0",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 "PatientID" : "000000185",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128 "PatientName" : "Anonymous^Unknown",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129 "PatientSex" : "O"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 },
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
131 "Studies" : [ "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15" ],
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
132 "Type" : "Patient"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133 }
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
134
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
135 This is once again a JSON file. Note how Orthanc gives you a summary
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136 of the main DICOM tags that correspond to the patient level.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
141 Browsing from the patient down to the instance
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
142 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
144 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
145
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
146 The field ``Studies`` list all the DICOM studies that are associated
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147 with the patient. So, considering the patient above, we would go down
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
148 in her DICOM hierarchy as follows::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
149
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
150 $ curl http://localhost:8042/studies/9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
151
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
152 .. highlight:: json
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
153
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
154 And Orthanc could answer::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
155
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
156 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
157 "ID" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
158 "MainDicomTags" : {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
159 "AccessionNumber" : "(null)",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
160 "StudyDate" : "20120716",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
161 "StudyDescription" : "TestSUVce-TF",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
162 "StudyID" : "23848",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
163 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
164 "StudyTime" : "170728"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
165 },
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
166 "ParentPatient" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
167 "Series" : [
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
168 "6821d761-31fb55a9-031ebecb-ba7f9aae-ffe4ddc0",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
169 "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
170 "7384c47e-6398f2a8-901846ef-da1e2e0b-6c50d598"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
171 ],
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
172 "Type" : "Study"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
173 }
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
174
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
175 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
176
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
177 The main DICOM tags are now those that are related to the study
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
178 level. It is possible to retrieve the identifier of the patient in the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
179 ``ParentPatient`` field, which can be used to go upward the DICOM
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
180 hierarchy. But let us rather go down to the series level by using the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
181 ``Series`` array. The next command would return information about one
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
182 of the three series that have just been reported::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
183
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
184 $ curl http://localhost:8042/series/2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
185
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
186 .. highlight:: json
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
187
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
188 Here is a possible answer::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
189
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
190 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
191 "ExpectedNumberOfInstances" : 45,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
192 "ID" : "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
193 "Instances" : [
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
194 "41bc3f74-360f9d10-6ae9ffa4-01ea2045-cbd457dd",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
195 "1d3de868-6c4f0494-709fd140-7ccc4c94-a6daa3a8",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
196 <...>
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
197 "1010f80b-161b71c0-897ec01b-c85cd206-e669a3ea",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
198 "e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
199 ],
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
200 "MainDicomTags" : {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
201 "Manufacturer" : "Philips Medical Systems",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
202 "Modality" : "PT",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
203 "NumberOfSlices" : "45",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
204 "ProtocolName" : "CHU/Body_PET/CT___50",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
205 "SeriesDate" : "20120716",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
206 "SeriesDescription" : "[WB_CTAC] Body",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
207 "SeriesInstanceUID" : "1.3.46.670589.28.2.12.30.26407.37145.2.2516.0.1342458737",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
208 "SeriesNumber" : "587370",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
209 "SeriesTime" : "171121",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
210 "StationName" : "r054-svr"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
211 },
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
212 "ParentStudy" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
213 "Status" : "Complete",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
214 "Type" : "Series"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
215 }
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
216
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
217 It can be seen that this series comes from a PET modality. Orthanc has
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
218 computed that this series should contain 45 instances.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
219
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
220 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
221
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
222 So far, we have navigated from the patient level, to the study level,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
223 and finally to the series level. There only remains the instance
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
224 level. Let us dump the content of one of the instances::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
225
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
226 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
227
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
228 .. highlight:: json
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
229
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
230 The instance contains the following information::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
231
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
232 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
233 "FileSize" : 70356,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
234 "FileUuid" : "3fd265f0-c2b6-41a2-ace8-ae332db63e06",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
235 "ID" : "e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
236 "IndexInSeries" : 6,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
237 "MainDicomTags" : {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
238 "ImageIndex" : "6",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
239 "InstanceCreationDate" : "20120716",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
240 "InstanceCreationTime" : "171344",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
241 "InstanceNumber" : "6",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
242 "SOPInstanceUID" : "1.3.46.670589.28.2.15.30.26407.37145.3.2116.39.1342458737"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
243 },
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
244 "ParentSeries" : "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
245 "Type" : "Instance"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
246 }
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
247
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
248 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
249
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
250 The instance has the index 6 in the parent series. The instance is
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
251 stored as a raw DICOM file of 70356 bytes. You would download this
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
252 DICOM file using the following command::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
253
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
254 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/file > Instance.dcm
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
255
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
256
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
257 Accessing the DICOM fields of an instance as a JSON file
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
258 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
259
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
260 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
261
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
262 When one gets to the instance level, you can retrieve the hierarchy of
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
263 all the DICOM tags of this instance as a JSON file::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
264
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
265 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/simplified-tags
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
266
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
267 .. highlight:: json
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
268
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
269 Here is a excerpt of the Orthanc answer::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
270
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
271 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
272 "ACR_NEMA_2C_VariablePixelDataGroupLength" : "57130",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
273 "AccessionNumber" : null,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
274 "AcquisitionDate" : "20120716",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
275 "AcquisitionDateTime" : "20120716171219",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
276 "AcquisitionTime" : "171219",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
277 "ActualFrameDuration" : "3597793",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
278 "AttenuationCorrectionMethod" : "CTAC-SG",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
279 <...>
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
280 "PatientID" : "000000185",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
281 "PatientName" : "Anonymous^Unknown",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
282 "PatientOrientationCodeSequence" : [
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
283 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
284 "CodeMeaning" : "recumbent",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
285 "CodeValue" : "F-10450",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
286 "CodingSchemeDesignator" : "99SDM",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
287 "PatientOrientationModifierCodeSequence" : [
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
288 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
289 "CodeMeaning" : "supine",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
290 "CodeValue" : "F-10340",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
291 "CodingSchemeDesignator" : "99SDM"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
292 }
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
293 ]
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
294 }
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
295 ],
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
296 <...>
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
297 "StudyDescription" : "TestSUVce-TF",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
298 "StudyID" : "23848",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
299 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
300 "StudyTime" : "171117",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
301 "TypeOfDetectorMotion" : "NONE",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
302 "Units" : "BQML",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
303 "Unknown" : null,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
304 "WindowCenter" : "1.496995e+04",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
305 "WindowWidth" : "2.993990e+04"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
306 }
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
307
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
308 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
309
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
310 If you need more detailed information about the type of the variables
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
311 or if you wish to use the hexadecimal indexes of DICOM tags, you are
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
312 free to use the following URL::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
313
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
314 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/tags
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
315
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
316 Accessing the raw DICOM fields of an instance
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
317 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
318
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
319 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
320
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
321 You also have the opportunity to access the raw value of the DICOM
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
322 tags of an instance, without going through a JSON file. Here is how
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
323 you would find the Patient Name of the instance::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
324
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
327
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
328 The list of all the available tags for this instance can also be retrieved easily::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
329
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
330 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/content
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
331
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
332 It is also possible to recursively explore the sequences of tags::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
333
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
334 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/content/0008-1250/0/0040-a170/0/0008-0104
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
335 For Attenuation Correction
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
336
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
337 The command above has opened the "0008-1250" tag that is a DICOM
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
338 sequence, taken its first child, opened its "0040-a170" tag that is
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
339 also a sequence, taken the first child of this child, and returned the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
340 "0008-0104" DICOM tag.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
341
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
342 Downloading images
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
343 ^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
344
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
345 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 168
diff changeset
364 $ curl -H 'Accept: image/jpeg' http://localhost:8042/instances/609665c0-c5198aa2-8632476b-a00e0de0-e9075d94/preview > Preview.jpg
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
385
218
amazy
parents: 216
diff changeset
386
amazy
parents: 216
diff changeset
387 .. _peering:
amazy
parents: 216
diff changeset
388
216
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
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
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
391
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
392 Orthanc can send its DICOM instances to remote Orthanc over HTTP/HTTPS through its Rest API.
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
393 This process can be triggered by the REST API.
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
394
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
395 Configuration
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
396 ^^^^^^^^^^^^^
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
397
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
398 .. highlight:: json
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
399
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
400 You first have to declare the Url of the remote orthanc inside the :ref:`configuration file
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
401 <configuration>`. For instance, here is how to declare a remote
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
402 orthanc peer::
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
403
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
404 ...
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
405 "Peers" : {
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
406 "sample" : [ "http://localhost:8043" ], // short version
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
407 "sample2" : { // long version
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
408 "Url" : "http://localhost:8044",
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
409 "Username" : "alice", // optional
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
410 "Password" : "alicePassword", // optional
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
411 "HttpHeaders" : { "Token" : "Hello world" }, // optional
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
412 "CertificateFile" : "client.crt", // optional (only if using client certificate authentication)
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
413 "CertificateKeyFile" : "client.key", // optional (only if using client certificate authentication)
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
414 "CertificateKeyPassword" : "certpass" // optional (only if using client certificate authentication)
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
415 },
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
416 ...
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
417
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
418 .. highlight:: bash
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
419
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
420 Such a configuration would enable Orthanc to connect to two other
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
421 Orthanc instances that listens on the
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
422 localhost on the port 8043 & 8044. The peers that are known to Orthanc
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
423 can be queried::
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
424
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
425 $ curl http://localhost:8042/peers?expand
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
426
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
427 The peers can then be updated through the API too::
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
428
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
429 $ curl -v -X PUT http://localhost:8042/peers/sample -d '{"Url" : "http://127.0.0.1:8043"}'
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
430
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
431
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
432 Note that, by default, peers are stored in Orthanc configuration files
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
433 and are updated in Orthanc memory only. If you want your modifications
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
434 to be persistent, you should configure Orthanc to store its peers
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
435 in the database. This is done through this configuration::
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
436
216
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
437 ...
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
438 "OrthancPeersInDatabase" : true,
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
439 ...
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
440
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
441 Sending One Resource
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
442 ^^^^^^^^^^^^^^^^^^^^
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
443
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
444 .. highlight:: bash
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
445
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
446 Once you have identified the Orthanc identifier of the DICOM resource
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
447 that would like to send :ref:`as explained above <rest-access>`, you
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
448 would use the following command to send it::
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
449
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
450 $ curl -X POST http://localhost:8042/peers/sample/store -d c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
451
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
452 The ``/sample/`` component of the URI corresponds to the identifier of
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
453 the remote modality, as specified above in the configuration file.
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
454
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
455 Note that you can send isolated DICOM instances with this command, but
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
456 also entire patients, studies or series. It is possible to send multiple instances with a single POST
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
457 request::
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
458
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
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"]'
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
460
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
461 Note that the list of resources to be sent can include the
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
462 :ref:`Orthanc identifiers <orthanc-ids>` of entire patients,
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
463 studies or series as well.
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
464
294
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
465 Testing connectivity with a remote peer
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
466 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
467
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
468 .. highlight:: bash
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
469
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
470 In version 1.5.9+, we have introduced a route to retrieve the ``/system`` info from
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
471 a remote peer. This route can also be used to test the connectivity with that peer
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
472 without actually sending a DICOM resource.::
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
473
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
474 $ curl http://localhost:8042/peers/sample/system
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
475
33fb45a86cd8 /peers/{id}/system
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
476
216
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
477 Using HTTPS
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
478 ^^^^^^^^^^^
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
479
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
480 If you're transfering medical data over internet, it is mandatory to use HTTPS.
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
481
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
482 On the server side, we recommend to put Orthanc behing an :ref:`HTTPS server that will take care of the TLS <https>`.
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
483
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
484 On the client side, in order for the client Orthanc to recognize the server certificate, you'll have to provide a path
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
485 to the CA (certification authority) certificates. This is done in the configuration file through this configurationg::
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
486
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
487 ...
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
488 "HttpsCACertificates" : "/etc/ssl/certs/ca-certificates.crt,
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
489 ...
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
490
223
9ccafca945d2 Fixed small typo
Benjamin Golinvaux <bgo@osimis.io>
parents: 218
diff changeset
491 If you want your server to accept incoming connections for known hosts only, you can either:
216
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
492
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
493 - configure a firewall to accept incoming connections from known IP addresses
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
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.
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
495
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
496
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
497
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
498
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
499 Sending resources to remote modalities (through DICOM)
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
500 ------------------------------------------------------
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
501
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
502 Orthanc can send its DICOM instances to remote DICOM modalities (C-Store SCU). This process
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
503 can be triggered by the REST API.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
504
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
505 Configuration
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
506 ^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
507
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
508 .. highlight:: json
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
509
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
510 You first have to declare the AET, the IP address and the port number
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
511 of the remote modality inside the :ref:`configuration file
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
512 <configuration>`. For instance, here is how to declare a remote
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
513 modality::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
514
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
515 ...
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
516 "DicomModalities" : {
212
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
517 "sample" : [ "ORTHANCA", "127.0.0.1", 2000 ], // short version
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
518 "sample2" : { // long version
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
519 "AET" : "ORTHANCB",
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
520 "Port" : 2001,
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
521 "Host" : "127.0.0.1",
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
522 "Manufacturer" : "Generic",
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
523 "AllowEcho" : true,
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
524 "AllowFind" : true,
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
525 "AllowMove" : true,
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
526 "AllowStore" : true
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
527 }
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
528 },
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
529 ...
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
530
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
531 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
532
212
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
533 Such a configuration would enable Orthanc to connect to two DICOM
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
534 stores (for instance, other Orthanc instances) that listens on the
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
535 localhost on the port 2000 & 2001. The modalities that are known to Orthanc
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
536 can be queried::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
537
212
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
538 $ curl http://localhost:8042/modalities?expand
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
539
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
540 The modalities can then be updated through the API too::
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
541
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
542 $ curl -v -X PUT http://localhost:8042/modalities/sample -d '{"AET" : "ORTHANCC", "Host": "127.0.0.1", "Port": 2002}'
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
543
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
544
212
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
545 Note that, by default, modalities are stored in Orthanc configuration files
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
546 and are updated in Orthanc memory only. If you want your modifications
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
547 to be persistent, you should configure Orthanc to store its modalities
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
548 in the database. This is done through this configuration::
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
549
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
550 ...
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
551 "DicomModalitiesInDatabase" : true,
7ff807cc5ade added modalities configuration
amazy
parents: 207
diff changeset
552 ...
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
553
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
554 Sending One Resource
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
555 ^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
556
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
557 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
558
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
559 Once you have identified the Orthanc identifier of the DICOM resource
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
560 that would like to send :ref:`as explained above <rest-access>`, you
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
561 would use the following command to send it::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
562
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
563 $ curl -X POST http://localhost:8042/modalities/sample/store -d c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
564
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
565 The ``/sample/`` component of the URI corresponds to the identifier of
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
566 the remote modality, as specified above in the configuration file.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
570
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
571 Bulk Store SCU
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
572 ^^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
573
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
574 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
575
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
580
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
581 To circumvent this problem, you have 2 possibilities:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
582
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
583 1. Set the ``DicomAssociationCloseDelay`` option in the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
584 :ref:`configuration file <configuration>` to a non-zero value. This
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
592
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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"]'
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
594
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
595 The list of the resources to be sent are given as a JSON array. In
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
596 this case, a single DICOM connection is used. `Sample code is
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
597 available
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
598 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Python/HighPerformanceAutoRouting.py>`__.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
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
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
622 .. highlight:: bash
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
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
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
638 You will receive back an ID which can be used to retrieve more
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
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
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 138
diff changeset
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
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 138
diff changeset
661 "PatientName":"*Jo*"
132
55a2ee3c462d Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 114
diff changeset
662
138
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
663 To perform date searches you can specify within StudyDate a starting
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
664 date and/or a before date. For example ``"StudyDate":"20180323-"``
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
665 would search for all study dates after the specified date to
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
666 now. Doing ``"StudyDate":"20180323-20180325"`` would search for all
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
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
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
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
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
745 If C-Moves take too long (for example, performing a C-Move of a big
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
746 study), you may run the request in asynchronous fashion, which will
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
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
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
749 $ curl --request POST --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/retrieve \
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
750 --data '{"TargetAet":"Orthanc","Synchronous":false}'
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
751
205
7213bef30604 rest.rst edited online with Bitbucket.
Diego Fernández Slezak <dfslezak@gmail.com>
parents: 173
diff changeset
752
207
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
753 .. highlight:: bash
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
754
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
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
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
767 Performing a find within Orthanc is very similar to using Queries
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
768 against DICOM modalities and the additional options listed above work
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
769 with find also. When performing a find, you will receive the Orthanc
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
770 ID's of all the matched items within your find. For example if you
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
771 perform a study level find and 5 Studies match you will receive 5
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
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
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
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
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
779 $ 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
780 [
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
781 {
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
782 "ID" : "b9c08539-26f93bde-c81ab0d7-bffaf2cb-a4d0bdd0",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
783 "IsStable" : true,
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
784 "LastUpdate" : "20180414T091528",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
785 "MainDicomTags" : {
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
786 "InstitutionName" : "0ECJ52puWpVIjTuhnBA0um",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
787 "ReferringPhysicianName" : "1",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
788 "StudyDate" : "20070101",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
789 "StudyDescription" : "Knee (R)",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
790 "StudyID" : "1",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
791 "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
792 "StudyTime" : "120000.000000"
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
793 },
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
794 "ParentPatient" : "6816cb19-844d5aee-85245eba-28e841e6-2414fae2",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
795 "PatientMainDicomTags" : {
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
796 "PatientID" : "ozp00SjY2xG",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
797 "PatientName" : "KNIX"
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
798 },
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
799 "Series" : [
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
800 "20b9d0c2-97d85e07-f4dbf4d2-f09e7e6a-0c19062e",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
801 "edbfa0a9-fa2641d7-29514b1c-45881d0b-46c374bd",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
802 "f2635388-f01d497a-15f7c06b-ad7dba06-c4c599fe",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
803 "4d04593b-953ced51-87e93f11-ae4cf03c-25defdcd",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
804 "5e343c3e-3633c396-03aefde8-ba0e08c7-9c8208d3",
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
805 "8ea120d7-5057d919-837dfbcc-ccd04e0f-7f3a94aa"
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
806 ],
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
807 "Type" : "Study"
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
808 }
b19b892977a2 expand in /tools/find
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 297
diff changeset
809 ]
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
138
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
812
136
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents: 132
diff changeset
813 Additional Options
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents: 132
diff changeset
814 ^^^^^^^^^^^^^^^^^^
138
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
815 .. highlight:: json
136
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents: 132
diff changeset
816
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents: 132
diff changeset
817 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
818
138
f3127d33cf5e rst syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
819 "Limit":4
136
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST
Bryan Dearlove <bdearlove@gmail.com>
parents: 132
diff changeset
820
132
55a2ee3c462d Performing Query/Retrieve with REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 114
diff changeset
821
216
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
822 .. _changes:
dcf6c2e60448 added section about peering (wip)
amazy
parents: 212
diff changeset
823
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
824 Tracking changes
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
825 ----------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
826
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
827 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
828
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
829 Whenever Orthanc receives a new DICOM instance, this event is recorded
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
830 in the so-called "Changes Log". This enables remote scripts to react
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
831 to the arrival of new DICOM resources. A typical application is
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
832 **auto-routing**, where an external script waits for a new DICOM
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
833 instance to arrive into Orthanc, then forward this instance to another
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
834 modality.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
835
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
836 The Changes Log can be accessed by the following command::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
837
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
838 $ curl http://localhost:8042/changes
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
839
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
840 .. highlight:: json
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
841
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
842 Here is a typical output::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
843
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
844 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
845 "Changes" : [
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
846 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
847 "ChangeType" : "NewInstance",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
848 "Date" : "20130507T143902",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
849 "ID" : "8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
850 "Path" : "/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
851 "ResourceType" : "Instance",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
852 "Seq" : 921
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
853 },
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
854 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
855 "ChangeType" : "NewSeries",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
856 "Date" : "20130507T143902",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
857 "ID" : "cceb768f-e0f8df71-511b0277-07e55743-9ef8890d",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
858 "Path" : "/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
859 "ResourceType" : "Series",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
860 "Seq" : 922
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
861 },
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
862 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
863 "ChangeType" : "NewStudy",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
864 "Date" : "20130507T143902",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
865 "ID" : "c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
866 "Path" : "/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
867 "ResourceType" : "Study",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
868 "Seq" : 923
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
869 },
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
870 {
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
871 "ChangeType" : "NewPatient",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
872 "Date" : "20130507T143902",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
873 "ID" : "dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
874 "Path" : "/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
875 "ResourceType" : "Patient",
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
876 "Seq" : 924
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
877 }
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
878 ],
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
879 "Done" : true,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
880 "Last" : 924
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
881 }
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
882
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
883 This output corresponds to the receiving of one single DICOM instance
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
884 by Orthanc. It records that a new instance, a new series, a new study
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
885 and a new patient has been created inside Orthanc. Note that each
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
886 changes is labeled by a ``ChangeType``, a ``Date`` (in the `ISO format
25
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
887 <https://en.wikipedia.org/wiki/ISO_8601>`__), the location of the
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
888 resource inside Orthanc, and a sequence number (``Seq``).
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
889
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
890 Note that this call is non-blocking. It is up to the calling program
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
891 to wait for the occurrence of a new event (by implementing a polling
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
892 loop).
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
893
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
894 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
895
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
896 This call only returns a fixed number of events, that can be changed
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
897 by using the ``limit`` option::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
898
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
899 $ curl http://localhost:8042/changes?limit=100
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
900
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
901 The flag ``Last`` records the sequence number of the lastly returned
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
902 event. The flag ``Done`` is set to ``true`` if no further event has
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
903 occurred after this lastly returned event. If ``Done`` is set to
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
904 ``false``, further events are available and can be retrieved. This is
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
905 done by setting the ``since`` option that specifies from which
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
906 sequence number the changes must be returned::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
907
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
908 $ curl 'http://localhost:8042/changes?limit=100&since=922'
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
909
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
910 A `sample code in the source distribution
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
911 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Python/ChangesLoop.py>`__
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
912 shows how to use this Changes API to implement a polling loop.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
913
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
914
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
915 Deleting resources from Orthanc
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
916 -------------------------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
917
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
918 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
919
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
920 Deleting patients, studies, series or instances
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
921 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
922
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
923 Deleting DICOM resources (i.e. patients, studies, series or instances)
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
924 from Orthanc is as simple as using a HTTP DELETE on the URI of this
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
925 resource.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
926
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
927 Concretely, you would first explore the resources that are stored in
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
928 Orthanc :ref:`as explained above <rest-access>`::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
929
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
930 $ curl http://localhost:8042/patients
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
931 $ curl http://localhost:8042/studies
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
932 $ curl http://localhost:8042/series
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
933 $ curl http://localhost:8042/instances
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
934
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
935 Secondly, once you have spotted the resources to be removed, you would
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
936 use the following command-line syntax to delete them::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
937
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
938 $ curl -X DELETE http://localhost:8042/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
939 $ curl -X DELETE http://localhost:8042/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
940 $ curl -X DELETE http://localhost:8042/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
941 $ curl -X DELETE http://localhost:8042/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
942
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
943
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
944 Clearing log of changes
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
945 ^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
946
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
947 :ref:`As described above <changes>`, Orthanc keeps track of all the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
948 changes that occur in the DICOM store. This so-called "Changes Log"
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
949 is accessible at the following URI::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
950
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
951 $ curl http://localhost:8042/changes
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
952
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
953 To clear the content of the Changes Log, simply DELETE this URI::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
954
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
955 $ curl -X DELETE http://localhost:8042/changes
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
956
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
957
155
498c9e42c99d exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
958 Log of exported resources
498c9e42c99d exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
959 ^^^^^^^^^^^^^^^^^^^^^^^^^
498c9e42c99d exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
960
498c9e42c99d exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
961 For medical traceability, Orthanc can be configured to store a log of
498c9e42c99d exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
962 all the resources that have been exported to remote modalities::
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
963
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
964 $ curl http://localhost:8042/exports
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
965
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
966 In auto-routing scenarios, it is important to prevent this log to grow
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
967 indefinitely as incoming instances are routed. You can either disable
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
968 this logging by setting the option ``LogExportedResources`` to ``false``
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
969 in the :ref:`configuration file <configuration>`, or periodically
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
970 clear this log by DELETE-ing this URI::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
971
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
972 $ curl -X DELETE http://localhost:8042/exports
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
973
155
498c9e42c99d exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
974 NB: Starting with Orthanc 1.4.0, the ``LogExportedResources`` is set
498c9e42c99d exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
975 to ``false`` by default. If the logging is desired, set this option to
498c9e42c99d exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
976 ``true``.
498c9e42c99d exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
977
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
978
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
979 Anonymization and modification
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
980 ------------------------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
981
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
982 The process of anonymizing and modifying DICOM resources is
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
983 :ref:`documented in a separate page <anonymization>`.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
984
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
985
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
986 Further reading
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
987 ---------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
988
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
989 The examples above have shown you the basic principles for driving an
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
990 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
991 API have not been described:
5737f51ff94e How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 25
diff changeset
992
224
02399e86f046 starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 223
diff changeset
993 * 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
994 <rest-advanced>`.
35
5737f51ff94e How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 25
diff changeset
995 * 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
996 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
997 * 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
998 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
999 Web site
5737f51ff94e How does Orthanc stores its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 25
diff changeset
1000 <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
1001 (click on the *Reference of the REST API* button).
275
2946fcd2e7fa transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 224
diff changeset
1002 * A documentation of the REST API in the OpenAPI/Swagger format is
2946fcd2e7fa transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 224
diff changeset
1003 `available as work-in-progress <https://api.orthanc-server.com/>`__.