orthanc-book: Sphinx/source/users/rest.rst annotate

annotate Sphinx/source/users/rest.rst @ 676:109d663abac0

cont

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Thu, 06 May 2021 14:58:25 +0200
parents	aba6dac03d16
children	ca814560dcb8

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
674 5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	28 .. _curl-windows:
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	29
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	30 Warning about using cURL from the Windows prompt
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	31 ------------------------------------------------
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	32
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	33 The examples on this page assume that the user is running a bash shell
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	34 on some GNU/Linux distribution. Such a shell has the major advantage
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	35 of having the possibility to use either single-quote or double-quotes
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	36 characters in order to group a set of characters (including spaces) as
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	37 a whole string.
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	38
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	39 .. highlight:: bash
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	40
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	41 Unfortunately, the default command-line prompt of Microsoft Windows
675 aba6dac03d16 typo Sebastien Jodogne <s.jodogne@gmail.com> parents: 674 diff changeset	42 doesn't support single-quote characters. If you copy/paste a cURL
674 5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	43 command-line from this page that mixes single-quote and double-quotes,
676 109d663abac0 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 675 diff changeset	44 it won't work as such, and you'll have to replace single-quotes by
109d663abac0 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 675 diff changeset	45 double-quotes, and prefix the double-quotes by a backslash
109d663abac0 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 675 diff changeset	46 character. For instance, consider the following command line that
109d663abac0 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 675 diff changeset	47 works fine on GNU/Linux::
674 5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	48
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	49 $ curl -v -X PUT http://localhost:8042/modalities/sample \
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	50 -d '{"AET" : "ORTHANCC", "Host": "127.0.0.1", "Port": 2002}'
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	51
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	52 This call will not work on the Microsoft Windows prompt as it
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	53 contains single-quotes. You should adapt this command line as follows
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	54 to run it on Windows::
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	55
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	56 $ curl -v -X PUT http://localhost:8042/modalities/sample \
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	57 -d "{\"AET\" : \"ORTHANCC\", \"Host\": \"127.0.0.1\", \"Port\": 2002}"
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	58
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	59 As an alternative, consider using a different Windows shell, for
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	60 instance `Windows PowerShell
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	61 <https://fr.wikipedia.org/wiki/Windows_PowerShell>`__ (some examples
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	62 of PowerShell can be found below on this page).
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	63
5ec581c7e610 Warning about using cURL from the Windows prompt Sebastien Jodogne <s.jodogne@gmail.com> parents: 671 diff changeset	64
114 736d30badda0 large POST body Sebastien Jodogne <s.jodogne@gmail.com> parents: 35 diff changeset	65 .. _sending-dicom-images:
736d30badda0 large POST body Sebastien Jodogne <s.jodogne@gmail.com> parents: 35 diff changeset	66
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	67 Sending DICOM images
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	68 --------------------
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	69
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	70 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	71
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	72 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	73 the following syntax::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	74
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	75 $ 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	76
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	77 .. highlight:: json
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	78
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	79 Orthanc will respond with a JSON file that contain information about
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	80 the location of the stored instance, such as::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	81
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 "ID" : "e87da270-c52b-4f2a-b8c6-bae25928d0b0",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	84 "Path" : "/instances/e87da270-c52b-4f2a-b8c6-bae25928d0b0",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	85 "Status" : "Success"
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	86 }
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	87
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	88 .. highlight:: bash
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 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	91 significantly `reduce the execution time of POST requests
358 011b01ccf52d fixing external hyperlinks Sebastien Jodogne <s.jodogne@gmail.com> parents: 331 diff changeset	92 <https://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	93
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	94 $ 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	95
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	96 The code distribution of Orthanc contains a `sample Python script
449 2922fb1bd65e fix links Sebastien Jodogne <s.jodogne@gmail.com> parents: 428 diff changeset	97 <https://hg.orthanc-server.com/orthanc/file/default/OrthancServer/Resources/Samples/ImportDicomFiles/ImportDicomFiles.py>`__
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	98 that recursively upload the content of some folder into Orthanc using
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	99 the REST API::
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 $ python ImportDicomFiles.py localhost 8042 ~/DICOM/
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	102
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	103
297 64d1ddab8246 Improved PDF creation Pwsh snippet + added Dicom instance upload example with Benjamin Golinvaux <bgo@osimis.io> parents: 294 diff changeset	104 .. highlight:: perl
64d1ddab8246 Improved PDF creation Pwsh snippet + added Dicom instance upload example with Benjamin Golinvaux <bgo@osimis.io> parents: 294 diff changeset	105
64d1ddab8246 Improved PDF creation Pwsh snippet + added Dicom instance upload example with Benjamin Golinvaux <bgo@osimis.io> parents: 294 diff changeset	106 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	107 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	108
376 6d7a36447e21 Small rephrasing Benjamin Golinvaux <bgo@osimis.io> parents: 360 diff changeset	109 # disabling the progress bar makes the Invoke-RestMethod call MUCH faster
297 64d1ddab8246 Improved PDF creation Pwsh snippet + added Dicom instance upload example with Benjamin Golinvaux <bgo@osimis.io> parents: 294 diff changeset	110 $ProgressPreference = 'SilentlyContinue'
64d1ddab8246 Improved PDF creation Pwsh snippet + added Dicom instance upload example with Benjamin Golinvaux <bgo@osimis.io> parents: 294 diff changeset	111
64d1ddab8246 Improved PDF creation Pwsh snippet + added Dicom instance upload example with Benjamin Golinvaux <bgo@osimis.io> parents: 294 diff changeset	112 # 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	113 $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	114
64d1ddab8246 Improved PDF creation Pwsh snippet + added Dicom instance upload example with Benjamin Golinvaux <bgo@osimis.io> parents: 294 diff changeset	115 # display the result
64d1ddab8246 Improved PDF creation Pwsh snippet + added Dicom instance upload example with Benjamin Golinvaux <bgo@osimis.io> parents: 294 diff changeset	116 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	117
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	118 .. _rest-access:
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 Accessing the content of 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 Orthanc structures the stored DICOM resources using the "Patient,
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	124 Study, Series, Instance" model of the DICOM standard. Each DICOM
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	125 resource is associated with an :ref:`unique identifier <orthanc-ids>`.
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	126
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	127 List all the DICOM resources
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	128 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	129
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	130 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	131 your local Orthanc instance::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	132
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	133 $ curl http://localhost:8042/patients
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	134 $ curl http://localhost:8042/studies
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	135 $ curl http://localhost:8042/series
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	136 $ curl http://localhost:8042/instances
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	137
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	138 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	139 <https://en.wikipedia.org/wiki/Json>`__ that contains an array of
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	140 resource identifiers. The JSON file format is lightweight and can be
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	141 parsed from almost any computer language.
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 Accessing a patient
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	144 ^^^^^^^^^^^^^^^^^^^
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 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	147
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	148 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	149 <https://en.wikipedia.org/wiki/Uniform_resource_identifier>`__. You
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	150 would for instance retrieve the main information about one patient as
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	151 follows::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	152
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	153 $ curl http://localhost:8042/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	154
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	155 .. highlight:: json
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 Here is a possible answer from Orthanc::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	158
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	159 {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	160 "ID" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	161 "MainDicomTags" : {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	162 "OtherPatientIDs" : "(null)",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	163 "PatientBirthDate" : "0",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	164 "PatientID" : "000000185",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	165 "PatientName" : "Anonymous^Unknown",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	166 "PatientSex" : "O"
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	167 },
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	168 "Studies" : [ "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15" ],
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	169 "Type" : "Patient"
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	170 }
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 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	173 of the main DICOM tags that correspond to the patient level.
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	174
168 86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	175
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	176 .. _browsing-hierarchy:
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	177
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	178 Browsing from the patient down to the instance
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	179 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	180
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	181 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	182
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	183 The field ``Studies`` list all the DICOM studies that are associated
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	184 with the patient. So, considering the patient above, we would go down
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	185 in her DICOM hierarchy as follows::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	186
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	187 $ curl http://localhost:8042/studies/9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	188
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	189 .. highlight:: json
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 And Orthanc could answer::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	192
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	193 {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	194 "ID" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	195 "MainDicomTags" : {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	196 "AccessionNumber" : "(null)",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	197 "StudyDate" : "20120716",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	198 "StudyDescription" : "TestSUVce-TF",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	199 "StudyID" : "23848",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	200 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	201 "StudyTime" : "170728"
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	202 },
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	203 "ParentPatient" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	204 "Series" : [
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	205 "6821d761-31fb55a9-031ebecb-ba7f9aae-ffe4ddc0",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	206 "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	207 "7384c47e-6398f2a8-901846ef-da1e2e0b-6c50d598"
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	208 ],
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	209 "Type" : "Study"
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	210 }
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 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	213
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	214 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	215 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	216 ``ParentPatient`` field, which can be used to go upward the DICOM
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	217 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	218 ``Series`` array. The next command would return information about one
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	219 of the three series that have just been reported::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	220
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	221 $ curl http://localhost:8042/series/2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	222
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	223 .. highlight:: json
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	224
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	225 Here is a possible answer::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	226
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 "ExpectedNumberOfInstances" : 45,
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	229 "ID" : "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	230 "Instances" : [
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	231 "41bc3f74-360f9d10-6ae9ffa4-01ea2045-cbd457dd",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	232 "1d3de868-6c4f0494-709fd140-7ccc4c94-a6daa3a8",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	233 <...>
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	234 "1010f80b-161b71c0-897ec01b-c85cd206-e669a3ea",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	235 "e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4"
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	236 ],
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 "Manufacturer" : "Philips Medical Systems",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	239 "Modality" : "PT",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	240 "NumberOfSlices" : "45",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	241 "ProtocolName" : "CHU/Body_PET/CT___50",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	242 "SeriesDate" : "20120716",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	243 "SeriesDescription" : "[WB_CTAC] Body",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	244 "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	245 "SeriesNumber" : "587370",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	246 "SeriesTime" : "171121",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	247 "StationName" : "r054-svr"
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	248 },
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	249 "ParentStudy" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	250 "Status" : "Complete",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	251 "Type" : "Series"
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	252 }
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 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	255 computed that this series should contain 45 instances.
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 .. highlight:: bash
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 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	260 and finally to the series level. There only remains the instance
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	261 level. Let us dump the content of one of the instances::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	262
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	263 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4
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 .. highlight:: json
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 The instance contains the following information::
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 {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	270 "FileSize" : 70356,
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	271 "FileUuid" : "3fd265f0-c2b6-41a2-ace8-ae332db63e06",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	272 "ID" : "e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	273 "IndexInSeries" : 6,
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	274 "MainDicomTags" : {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	275 "ImageIndex" : "6",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	276 "InstanceCreationDate" : "20120716",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	277 "InstanceCreationTime" : "171344",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	278 "InstanceNumber" : "6",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	279 "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	280 },
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	281 "ParentSeries" : "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	282 "Type" : "Instance"
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
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	285 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	286
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	287 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	288 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	289 DICOM file using the following command::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	290
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	291 $ 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	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 Accessing the DICOM fields of an instance as a JSON file
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 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	298
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	299 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	300 all the DICOM tags of this instance as a JSON file::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	301
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	302 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/simplified-tags
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	303
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	304 .. highlight:: json
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	305
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	306 Here is a excerpt of the Orthanc answer::
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 {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	309 "ACR_NEMA_2C_VariablePixelDataGroupLength" : "57130",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	310 "AccessionNumber" : null,
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	311 "AcquisitionDate" : "20120716",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	312 "AcquisitionDateTime" : "20120716171219",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	313 "AcquisitionTime" : "171219",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	314 "ActualFrameDuration" : "3597793",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	315 "AttenuationCorrectionMethod" : "CTAC-SG",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	316 <...>
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	317 "PatientID" : "000000185",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	318 "PatientName" : "Anonymous^Unknown",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	319 "PatientOrientationCodeSequence" : [
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 "CodeMeaning" : "recumbent",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	322 "CodeValue" : "F-10450",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	323 "CodingSchemeDesignator" : "99SDM",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	324 "PatientOrientationModifierCodeSequence" : [
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	325 {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	326 "CodeMeaning" : "supine",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	327 "CodeValue" : "F-10340",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	328 "CodingSchemeDesignator" : "99SDM"
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 ]
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 ],
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 "StudyDescription" : "TestSUVce-TF",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	335 "StudyID" : "23848",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	336 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	337 "StudyTime" : "171117",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	338 "TypeOfDetectorMotion" : "NONE",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	339 "Units" : "BQML",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	340 "Unknown" : null,
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	341 "WindowCenter" : "1.496995e+04",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	342 "WindowWidth" : "2.993990e+04"
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
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	347 If you need more detailed information about the type of the variables
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	348 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	349 free to use the following URL::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	350
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	351 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/tags
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	352
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	353 Accessing the raw DICOM fields of an instance
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	354 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	355
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	356 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	357
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	358 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	359 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	360 you would find the Patient Name of the instance::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	361
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	362 $ 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	363 Anonymous^Unknown
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	364
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	365 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	366
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	367 $ curl http://localhost:8042/instances/e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4/content
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	368
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	369 It is also possible to recursively explore the sequences of tags::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	370
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	371 $ 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	372 For Attenuation Correction
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	373
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	374 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	375 sequence, taken its first child, opened its "0040-a170" tag that is
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	376 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	377 "0008-0104" DICOM tag.
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	378
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	379 Downloading images
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	380 ^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	381
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	382 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	383
168 86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	384 As :ref:`explained above <browsing-hierarchy>`, the raw DICOM file
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	385 corresponding to a single instance can be retrieved as follows::
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	386
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	387 $ 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	388
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	389 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	390 to some DICOM instance::
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	391
168 86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	392 $ 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	393
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	394 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	395 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	396 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	397 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	398 <https://en.wikipedia.org/wiki/List_of_HTTP_header_fields>`__
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	399 ``Accept`` to ``image/jpeg``::
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	400
169 8239d44e0520 typo Sebastien Jodogne <s.jodogne@gmail.com> parents: 168 diff changeset	401 $ 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	402
168 86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	403 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	404 16bpp PNG image, you can use the following URIs::
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	405
168 86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	406 $ 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	407 $ 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	408
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	409 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	410 be encoded by the target image format. The
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	411 ``/instances/{...}/image-int16`` is available as well to download
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	412 signed DICOM pixel data.
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	413
168 86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	414 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	415 the generic `PAM format
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	416 <https://en.wikipedia.org/wiki/Netpbm#PAM_graphics_format>`__::
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	417
86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	418 $ 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	419
168 86e92d0cc53e information about images Sebastien Jodogne <s.jodogne@gmail.com> parents: 155 diff changeset	420 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	421 dedicated section <matlab>`.
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	422
380 06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	423 Downloading studies
411 b4cc2b6a9f13 wip Sebastien Jodogne <s.jodogne@gmail.com> parents: 407 diff changeset	424 ^^^^^^^^^^^^^^^^^^^
380 06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	425
06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	426 .. highlight:: bash
06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	427
06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	428 All instances of a study can be retrieved as a zip file as follows::
06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	429
06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	430 $ curl http://localhost:8042/studies/6b9e19d9-62094390-5f9ddb01-4a191ae7-9766b715/archive > Study.zip
06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	431
06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	432 It is also possible to download a zipped DICOMDIR through::
06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	433
381 f9c4c6144fec fix Alain Mazy <alain@mazy.be> parents: 380 diff changeset	434 $ curl http://localhost:8042/studies/6b9e19d9-62094390-5f9ddb01-4a191ae7-9766b715/media > Study.zip
380 06ab5ab05a2d API doc: download study Alain Mazy <alain@mazy.be> parents: 379 diff changeset	435
218 8bb11cd0f20f links amazy parents: 216 diff changeset	436
8bb11cd0f20f links amazy parents: 216 diff changeset	437 .. _peering:
8bb11cd0f20f links amazy parents: 216 diff changeset	438
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	439 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	440 -----------------------------------------------------------------------------
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	441
428 943515b68158 documented transcoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 411 diff changeset	442 Orthanc can send its DICOM instances to remote Orthanc servers over
943515b68158 documented transcoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 411 diff changeset	443 HTTP/HTTPS. Such servers are referred to as :ref:`Orthanc peers
943515b68158 documented transcoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 411 diff changeset	444 <peers>`. This process can be triggered by the REST API, which is
943515b68158 documented transcoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 411 diff changeset	445 described in this section.
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	446
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	447 Configuration
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	448 ^^^^^^^^^^^^^
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	449
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	450 .. highlight:: json
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	451
314 5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	452 You first have to declare the Url of the remote orthanc inside the
5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	453 :ref:`configuration file <configuration>`. For instance, here is how
5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	454 to declare a remote orthanc peer::
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	455
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	456 ...
494 7daa331a91a9 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 449 diff changeset	457 "OrthancPeers" : {
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	458 "sample" : [ "http://localhost:8043" ], // short version
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	459 "sample2" : { // long version
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	460 "Url" : "http://localhost:8044",
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	461 "Username" : "alice", // optional
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	462 "Password" : "alicePassword", // optional
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	463 "HttpHeaders" : { "Token" : "Hello world" }, // optional
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	464 "CertificateFile" : "client.crt", // optional (only if using client certificate authentication)
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	465 "CertificateKeyFile" : "client.key", // optional (only if using client certificate authentication)
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	466 "CertificateKeyPassword" : "certpass" // optional (only if using client certificate authentication)
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	467 },
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	468 ...
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	469
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	470 .. highlight:: bash
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	471
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	472 Such a configuration would enable Orthanc to connect to two other
667 be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	473 Orthanc instances that listens on the localhost on the ports 8043
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	474 and 8044. The peers that are known to Orthanc can be queried::
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	475
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	476 $ curl http://localhost:8042/peers?expand
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	477
667 be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	478 Instead of using the configuration file, peers can be created or
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	479 updated through the REST API using the ``PUT`` method of HTTP::
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	480
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	481 $ 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	482
667 be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	483 One peer can also be removed using the ``DELETE`` method as follows::
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	484
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	485 $ curl -v -X DELETE http://localhost:8042/peers/sample
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	486
667 be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	487 Note that, by default, peers are read from the Orthanc configuration
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	488 files and are updated in Orthanc memory only. If you want your
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	489 modifications to be persistent, you should configure Orthanc to store
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	490 its peers in the database. This is done through this configuration::
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	491
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 "OrthancPeersInDatabase" : true,
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	494 ...
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	495
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	496 Sending One Resource
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 .. highlight:: bash
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	500
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	501 Once you have identified the Orthanc identifier of the DICOM resource
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	502 that would like to send :ref:`as explained above <rest-access>`, you
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	503 would use the following command to send it::
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	504
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	505 $ 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	506
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	507 The ``/sample/`` component of the URI corresponds to the identifier of
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	508 the remote modality, as specified above in the configuration file.
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	509
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	510 Note that you can send isolated DICOM instances with this command, but
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	511 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	512 request::
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	513
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	514 $ 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"]'
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	515
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	516 Note that the list of resources to be sent can include the
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	517 :ref:`Orthanc identifiers <orthanc-ids>` of entire patients,
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	518 studies or series as well.
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	519
633 06bea33cb7d0 metadata and attachments are not transferred between peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 609 diff changeset	520 Important remark: Neither the :ref:`metadata <metadata>`, nor the
06bea33cb7d0 metadata and attachments are not transferred between peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 609 diff changeset	521 :ref:`attachments <attachments>` are transferred between the Orthanc
06bea33cb7d0 metadata and attachments are not transferred between peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 609 diff changeset	522 peers. This is because metadata and attachments are considered as
06bea33cb7d0 metadata and attachments are not transferred between peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 609 diff changeset	523 local to one Orthanc server.
06bea33cb7d0 metadata and attachments are not transferred between peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 609 diff changeset	524
06bea33cb7d0 metadata and attachments are not transferred between peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 609 diff changeset	525
294 33fb45a86cd8 /peers/{id}/system Alain Mazy <alain@mazy.be> parents: 275 diff changeset	526 Testing connectivity with a remote peer
33fb45a86cd8 /peers/{id}/system Alain Mazy <alain@mazy.be> parents: 275 diff changeset	527 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33fb45a86cd8 /peers/{id}/system Alain Mazy <alain@mazy.be> parents: 275 diff changeset	528
33fb45a86cd8 /peers/{id}/system Alain Mazy <alain@mazy.be> parents: 275 diff changeset	529 .. highlight:: bash
33fb45a86cd8 /peers/{id}/system Alain Mazy <alain@mazy.be> parents: 275 diff changeset	530
33fb45a86cd8 /peers/{id}/system Alain Mazy <alain@mazy.be> parents: 275 diff changeset	531 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	532 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	533 without actually sending a DICOM resource.::
33fb45a86cd8 /peers/{id}/system Alain Mazy <alain@mazy.be> parents: 275 diff changeset	534
33fb45a86cd8 /peers/{id}/system Alain Mazy <alain@mazy.be> parents: 275 diff changeset	535 $ curl http://localhost:8042/peers/sample/system
33fb45a86cd8 /peers/{id}/system Alain Mazy <alain@mazy.be> parents: 275 diff changeset	536
33fb45a86cd8 /peers/{id}/system Alain Mazy <alain@mazy.be> parents: 275 diff changeset	537
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	538 Using HTTPS
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	539 ^^^^^^^^^^^
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	540
609 0dde82745e0d documentation of DICOM TLS Sebastien Jodogne <s.jodogne@gmail.com> parents: 577 diff changeset	541 If you're transfering medical data over internet, it is mandatory to
0dde82745e0d documentation of DICOM TLS Sebastien Jodogne <s.jodogne@gmail.com> parents: 577 diff changeset	542 use HTTPS.
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	543
609 0dde82745e0d documentation of DICOM TLS Sebastien Jodogne <s.jodogne@gmail.com> parents: 577 diff changeset	544 On the server side, we recommend to put Orthanc behind an :ref:`HTTPS
0dde82745e0d documentation of DICOM TLS Sebastien Jodogne <s.jodogne@gmail.com> parents: 577 diff changeset	545 server that will take care of the TLS <https>`.
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	546
609 0dde82745e0d documentation of DICOM TLS Sebastien Jodogne <s.jodogne@gmail.com> parents: 577 diff changeset	547 On the client side, in order for the client Orthanc to recognize the
0dde82745e0d documentation of DICOM TLS Sebastien Jodogne <s.jodogne@gmail.com> parents: 577 diff changeset	548 server certificate, you'll have to provide a path to the CA
0dde82745e0d documentation of DICOM TLS Sebastien Jodogne <s.jodogne@gmail.com> parents: 577 diff changeset	549 (certification authority) certificates. This is done in the
0dde82745e0d documentation of DICOM TLS Sebastien Jodogne <s.jodogne@gmail.com> parents: 577 diff changeset	550 configuration file through this configurationg::
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	551
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	552 ...
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	553 "HttpsCACertificates" : "/etc/ssl/certs/ca-certificates.crt,
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	554 ...
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	555
223 9ccafca945d2 Fixed small typo Benjamin Golinvaux <bgo@osimis.io> parents: 218 diff changeset	556 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	557
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	558 - configure a firewall to accept incoming connections from known IP addresses
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	559 - 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	560
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	561
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	562
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	563
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	564 Sending resources to remote modalities (through DICOM C-Store)
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	565 --------------------------------------------------------------
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	566
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	567 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	568 can be triggered by the REST API.
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	569
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	570 Configuration
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	571 ^^^^^^^^^^^^^
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 .. highlight:: json
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	574
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	575 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	576 of the remote modality inside the :ref:`configuration file
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	577 <configuration>`. For instance, here is how to declare a remote
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	578 modality::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	579
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 "DicomModalities" : {
212 7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	582 "sample" : [ "ORTHANCA", "127.0.0.1", 2000 ], // short version
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	583 "sample2" : { // long version
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	584 "AET" : "ORTHANCB",
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	585 "Port" : 2001,
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	586 "Host" : "127.0.0.1",
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	587 "Manufacturer" : "Generic",
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	588 "AllowEcho" : true,
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	589 "AllowFind" : true,
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	590 "AllowMove" : true,
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	591 "AllowStore" : true
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	592 }
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	593 },
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
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	596 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	597
212 7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	598 Such a configuration would enable Orthanc to connect to two DICOM
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	599 stores (for instance, other Orthanc instances) that listens on the
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	600 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	601 can be queried::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	602
212 7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	603 $ curl http://localhost:8042/modalities?expand
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	604
667 be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	605 Instead of using the configuration file, modalities can be created or
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	606 updated through the REST API using the ``PUT`` method of HTTP::
212 7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	607
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	608 $ 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	609
667 be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	610 One modality can also be removed using the ``DELETE`` method as follows::
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	611
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	612 $ curl -v -X DELETE http://localhost:8042/modalities/sample
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	613
667 be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	614 Note that, by default, modalities are read from the Orthanc
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	615 configuration files and are updated in Orthanc memory only. If you
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	616 want your modifications to be persistent, you should configure Orthanc
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	617 to store the modalities in the database. This is done through this
be71b56c90ab example to delete peer/modality using rest Sebastien Jodogne <s.jodogne@gmail.com> parents: 662 diff changeset	618 configuration::
212 7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	619
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	620 ...
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	621 "DicomModalitiesInDatabase" : true,
7ff807cc5ade added modalities configuration amazy parents: 207 diff changeset	622 ...
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	623
331 48673b8abae3 documentation of storage commitment scu Sebastien Jodogne <s.jodogne@gmail.com> parents: 314 diff changeset	624
48673b8abae3 documentation of storage commitment scu Sebastien Jodogne <s.jodogne@gmail.com> parents: 314 diff changeset	625 .. _rest-store-scu:
48673b8abae3 documentation of storage commitment scu Sebastien Jodogne <s.jodogne@gmail.com> parents: 314 diff changeset	626
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	627 Sending One Resource
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	628 ^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	629
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	630 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	631
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	632 Once you have identified the Orthanc identifier of the DICOM resource
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	633 that would like to send :ref:`as explained above <rest-access>`, you
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	634 would use the following command to send it::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	635
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	636 $ 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	637
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	638 The ``/sample/`` component of the URI corresponds to the identifier of
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	639 the remote modality, as specified above in the configuration file.
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	640
173 901bc7b2dbab improved bulk store scu section Sebastien Jodogne <s.jodogne@gmail.com> parents: 169 diff changeset	641 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	642 also entire patients, studies or series.
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	643
407 3aa7d50a4ccd fix merge Alain Mazy <alain@mazy.be> parents: 406 diff changeset	644 Various optional fields are also available. i.e, if you need to
3aa7d50a4ccd fix merge Alain Mazy <alain@mazy.be> parents: 406 diff changeset	645 monitor the state of a transfer, you can start the transfer in :ref:`asynchronous mode
3aa7d50a4ccd fix merge Alain Mazy <alain@mazy.be> parents: 406 diff changeset	646 <jobs>`, which will provide you with the identifier of the Orthanc job::
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	647
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	648 $ curl -X POST http://localhost:8042/modalities/sample/store \
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	649 --data '{
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	650 "Resources" : ["d4b46c8e-74b16992-b0f5ca11-f04a60fa-8eb13a88"],
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	651 "Synchronous" : false,
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	652 "LocalAet" : "ORTHANC",
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	653 "MoveOriginatorAet": "ORTHANC",
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	654 "MoveOriginatorID": 1234,
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	655 "Timeout": 10,
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	656 "StorageCommitment": false
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	657 }'
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	658
403 e73148f45930 async c-store Sebastien Jodogne <s.jodogne@gmail.com> parents: 381 diff changeset	659
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	660 Bulk Store SCU
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	661 ^^^^^^^^^^^^^^
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	662
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	663 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	664
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	665 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	666 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	667 communication overhead if sending multiple isolated instances by
901bc7b2dbab improved bulk store scu section Sebastien Jodogne <s.jodogne@gmail.com> parents: 169 diff changeset	668 making one REST call for each of these instances.
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	669
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	670 To circumvent this problem, you have 2 possibilities:
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	671
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	672 1. Set the ``DicomAssociationCloseDelay`` option in the
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	673 :ref:`configuration file <configuration>` to a non-zero value. This
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	674 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	675 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	676 autorouting images :ref:`using Lua <lua-auto-routing>`.
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	677
173 901bc7b2dbab improved bulk store scu section Sebastien Jodogne <s.jodogne@gmail.com> parents: 169 diff changeset	678 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	679 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	680 0.5.2)::
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	681
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	682 $ 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	683
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	684 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	685 this case, a single DICOM connection is used. `Sample code is
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	686 available
449 2922fb1bd65e fix links Sebastien Jodogne <s.jodogne@gmail.com> parents: 428 diff changeset	687 <https://hg.orthanc-server.com/orthanc/file/default/OrthancServer/Resources/Samples/Python/HighPerformanceAutoRouting.py>`__.
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	688
173 901bc7b2dbab improved bulk store scu section Sebastien Jodogne <s.jodogne@gmail.com> parents: 169 diff changeset	689 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	690 :ref:`Orthanc identifiers <orthanc-ids>` of entire patients,
901bc7b2dbab improved bulk store scu section Sebastien Jodogne <s.jodogne@gmail.com> parents: 169 diff changeset	691 studies or series as well.
901bc7b2dbab improved bulk store scu section Sebastien Jodogne <s.jodogne@gmail.com> parents: 169 diff changeset	692
901bc7b2dbab improved bulk store scu section Sebastien Jodogne <s.jodogne@gmail.com> parents: 169 diff changeset	693
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	694 Performing C-Echo
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	695 -----------------
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	696
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	697 To validate the DICOM connectivity between Orthanc and a remote modality,
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	698 you can perform a C-ECHO::
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	699
557 3af5dda67520 fix sample for c-echo in rest api Sebastien Jodogne <s.jodogne@gmail.com> parents: 494 diff changeset	700 $ curl -X POST http://localhost:8042/modalities/sample/echo -d '{}'
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	701
557 3af5dda67520 fix sample for c-echo in rest api Sebastien Jodogne <s.jodogne@gmail.com> parents: 494 diff changeset	702 From Orthanc 1.7.0, you can include an extra ``Timeout`` field::
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	703
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	704 $ curl -X POST http://localhost:8042/modalities/sample/echo -d '{ "Timeout": 10 }'
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	705
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	706 If no ``Timeout`` parameter is specified, the value of the ``DicomScuTimeout``
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	707 configuration is used as a default. If ``Timeout`` is set to zero, this means
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	708 no timeout.
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	709
557 3af5dda67520 fix sample for c-echo in rest api Sebastien Jodogne <s.jodogne@gmail.com> parents: 494 diff changeset	710 NB: A body containing a valid JSON object is needed by
3af5dda67520 fix sample for c-echo in rest api Sebastien Jodogne <s.jodogne@gmail.com> parents: 494 diff changeset	711 ``/modalities/{id}/echo`` since Orthanc 1.7.0.
3af5dda67520 fix sample for c-echo in rest api Sebastien Jodogne <s.jodogne@gmail.com> parents: 494 diff changeset	712
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	713
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	714 Performing C-Move
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	715 -----------------
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	716
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	717 .. highlight:: bash
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	718
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	719 You can perform a DICOM C-Move to move a specific study from one modality
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	720 to another (including Orthanc itself if you don't specify the ``TargetAet``
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	721 field).
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	722
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	723 I.e. to move a study whose you know the ``StudyInstanceUID`` from
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	724 the modality ``sample`` to another Orthanc whose AET is ``ORTHANCB``::
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	725
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	726 $ curl --request POST --url http://localhost:8042/modalities/samples/move \
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	727 --data '{
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	728 "Level" : "Study",
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	729 "Resources" : [
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	730 {
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	731 "StudyInstanceUID": "1.2.840.113543.6.6.4.7.64067529866380271256212683512383713111129"
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	732 }
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	733 ],
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	734 "TargetAet": "ORTHANCB",
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	735 "Timeout": 60
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	736 }'
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	737
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	738
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	739 Performing Query/Retrieve (C-Find) and Find with REST
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	740 -----------------------------------------------------
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	741
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	742 Section contributed by Bryan Dearlove
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	743
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	744 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	745 or on remote modalities through the REST API.
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	746
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	747 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	748 within the :ref:`configuration file <configuration>` (See
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	749 Configuration section under Sending resources to remote modalities).
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	750
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	751
136 8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	752 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	753 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	754
138 f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	755 .. highlight:: bash
f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	756
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	757 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	758 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	759 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	760 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	761 insensitive unless configured otherwise within the Orthanc
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	762 configuration file::
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	763
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	764 $ curl --request POST \
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	765 --url http://localhost:8042/modalities/sample/query \
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	766 --data '{
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	767 "Level" : "Study",
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	768 "Query" : {
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	769 "PatientID" : "",
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	770 "StudyDescription" : "Chest",
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	771 "PatientName" : ""
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	772 }
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	773 }'
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	774
314 5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	775 You might be interested in including the ``Normalize`` option to bypass
5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	776 the normalization of the outgoing C-FIND queries. For instance, for
5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	777 the ``InstitutionName`` to be included at the ``Study`` level, one would
5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	778 run::
5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	779
5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	780 $ curl -v http://localhost:8042/modalities/sample/query -X POST -d \
5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	781 '{"Level":"Study","Query":{"InstitutionName":"a"},"Normalize":false}'
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	782
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	783 .. highlight:: json
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	784
138 f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	785 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	786 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	787
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	788 {
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	789 "ID": "5af318ac-78fb-47ff-b0b0-0df18b0588e0",
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	790 "Path": "/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0"
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	791 }
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	792
136 8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	793
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	794 Additional Options
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	795 ^^^^^^^^^^^^^^^^^^
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	796
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	797 .. highlight:: json
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	798
314 5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	799 You can use patient identifiers by including the ``*`` within your
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	800 search. For example if you were searching for a name beginning with
314 5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	801 ``Jones`` you can do::
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	802
139 fded2e8d1d49 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 138 diff changeset	803 "PatientName":"Jones*"
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	804
314 5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	805 If you wanted to search for a name with the words ``Jo`` anywhere
5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	806 within it you can do::
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	807
139 fded2e8d1d49 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 138 diff changeset	808 "PatientName":"Jo"
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	809
138 f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	810 To perform date searches you can specify within StudyDate a starting
f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	811 date and/or a before date. For example ``"StudyDate":"20180323-"``
f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	812 would search for all study dates after the specified date to
f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	813 now. Doing ``"StudyDate":"20180323-20180325"`` would search for all
f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	814 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	815
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	816
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	817 Reviewing Level
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	818 ^^^^^^^^^^^^^^^
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	819
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	820 .. highlight:: bash
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	821
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	822 ::
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	823
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	824 $ 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	825
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	826 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	827 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	828
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	829
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	830 Reviewing Modality
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	831 ^^^^^^^^^^^^^^^^^^
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	832
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	833 .. highlight:: bash
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	834
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	835 ::
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	836
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	837 $ 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	838
136 8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	839 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	840
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	841
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	842 Reviewing Query
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	843 ^^^^^^^^^^^^^^^
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	844
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	845 .. highlight:: bash
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	846
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	847 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	848 performed using you can use the query filter::
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	849
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	850 $ 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	851
136 8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	852
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	853 Reviewing Query Answers
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	854 ^^^^^^^^^^^^^^^^^^^^^^^
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	855
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	856 .. highlight:: bash
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	857
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	858 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	859 a GET with the answers parameter::
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	860
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	861 $ 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	862
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	863 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	864 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	865 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	866 for content details::
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	867
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	868 $ 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	869
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	870 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	871 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	872 listed in this JSON answer in the initial query we would add to the
314 5f0cd51d97c0 Normalize option in /modalities/.../query Sebastien Jodogne <s.jodogne@gmail.com> parents: 313 diff changeset	873 POST body: ``"ModalitiesInStudy":""``
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	874
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	875
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	876 Performing Retrieve (C-Move)
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	877 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	878
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	879 .. highlight:: bash
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	880
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	881 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	882 query using a post command and identifying the Modality (named in this
207 66295dffbf33 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 205 diff changeset	883 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	884
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	885 $ 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	886
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	887 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	888 specifying that individual content item::
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	889
55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	890 $ 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	891
207 66295dffbf33 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 205 diff changeset	892 If C-Moves take too long (for example, performing a C-Move of a big
671 bc8fa2bf4cf7 asynchronous c-move Sebastien Jodogne <s.jodogne@gmail.com> parents: 667 diff changeset	893 study), you may run the request in :ref:`asynchronous mode <jobs>`,
bc8fa2bf4cf7 asynchronous c-move Sebastien Jodogne <s.jodogne@gmail.com> parents: 667 diff changeset	894 which will create a job in Orthanc::
205 7213bef30604 rest.rst edited online with Bitbucket. Diego Fernández Slezak <dfslezak@gmail.com> parents: 173 diff changeset	895
207 66295dffbf33 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 205 diff changeset	896 $ curl --request POST --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/retrieve \
66295dffbf33 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 205 diff changeset	897 --data '{"TargetAet":"Orthanc","Synchronous":false}'
66295dffbf33 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 205 diff changeset	898
205 7213bef30604 rest.rst edited online with Bitbucket. Diego Fernández Slezak <dfslezak@gmail.com> parents: 173 diff changeset	899
207 66295dffbf33 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 205 diff changeset	900 .. highlight:: bash
66295dffbf33 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 205 diff changeset	901
671 bc8fa2bf4cf7 asynchronous c-move Sebastien Jodogne <s.jodogne@gmail.com> parents: 667 diff changeset	902 The answer of this POST request is the job ID taking care of the
bc8fa2bf4cf7 asynchronous c-move Sebastien Jodogne <s.jodogne@gmail.com> parents: 667 diff changeset	903 C-Move command, :ref:`whose status can be monitored <jobs-monitoring>`
bc8fa2bf4cf7 asynchronous c-move Sebastien Jodogne <s.jodogne@gmail.com> parents: 667 diff changeset	904 in order to detect failure or completion::
205 7213bef30604 rest.rst edited online with Bitbucket. Diego Fernández Slezak <dfslezak@gmail.com> parents: 173 diff changeset	905
7213bef30604 rest.rst edited online with Bitbucket. Diego Fernández Slezak <dfslezak@gmail.com> parents: 173 diff changeset	906 {
7213bef30604 rest.rst edited online with Bitbucket. Diego Fernández Slezak <dfslezak@gmail.com> parents: 173 diff changeset	907 "ID" : "11541b16-e368-41cf-a8e9-3acf4061d238",
7213bef30604 rest.rst edited online with Bitbucket. Diego Fernández Slezak <dfslezak@gmail.com> parents: 173 diff changeset	908 "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	909 }
7213bef30604 rest.rst edited online with Bitbucket. Diego Fernández Slezak <dfslezak@gmail.com> parents: 173 diff changeset	910
7213bef30604 rest.rst edited online with Bitbucket. Diego Fernández Slezak <dfslezak@gmail.com> parents: 173 diff changeset	911
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	912
378 16dc3561b41e Filtering and returning metadata using Python Sebastien Jodogne <s.jodogne@gmail.com> parents: 360 diff changeset	913 .. _rest-find:
16dc3561b41e Filtering and returning metadata using Python Sebastien Jodogne <s.jodogne@gmail.com> parents: 360 diff changeset	914
136 8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	915 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	916 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	917 .. highlight:: bash
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	918
662 88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	919 Performing a find within the local database of Orthanc is very similar
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	920 to using Queries against DICOM modalities and the additional options
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	921 listed above work with find also. When performing a find, you will
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	922 receive the Orthanc ID's of all the matched items within your
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	923 find. For example if you perform a study level find and 5 Studies
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	924 match you will receive 5 study level Orthanc ID's in JSON format as a
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	925 response::
136 8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	926
404 7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	927 $ curl --request POST --url http://localhost:8042/tools/find \
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	928 --data '{
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	929 "Level" : "Instance",
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	930 "Query" : {
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	931 "Modality" : "CR",
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	932 "StudyDate" : "20180323-",
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	933 "PatientID" : "*"
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	934 }
7469b6c5618b DICOM commands: Timeout + improved existing doc Alain Mazy <alain@mazy.be> parents: 381 diff changeset	935 }'
136 8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	936
312 b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	937 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	938 query will automatically report details about each study::
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	939
313 8e97e0524e16 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 312 diff changeset	940 $ curl https://demo.orthanc-server.com/tools/find -d '{"Level":"Study","Query":{"PatientName":"KNIX"}}'
8e97e0524e16 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 312 diff changeset	941 [
8e97e0524e16 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 312 diff changeset	942 "b9c08539-26f93bde-c81ab0d7-bffaf2cb-a4d0bdd0"
8e97e0524e16 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 312 diff changeset	943 ]
312 b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	944 $ 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	945 [
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	946 {
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	947 "ID" : "b9c08539-26f93bde-c81ab0d7-bffaf2cb-a4d0bdd0",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	948 "IsStable" : true,
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	949 "LastUpdate" : "20180414T091528",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	950 "MainDicomTags" : {
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	951 "InstitutionName" : "0ECJ52puWpVIjTuhnBA0um",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	952 "ReferringPhysicianName" : "1",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	953 "StudyDate" : "20070101",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	954 "StudyDescription" : "Knee (R)",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	955 "StudyID" : "1",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	956 "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	957 "StudyTime" : "120000.000000"
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	958 },
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	959 "ParentPatient" : "6816cb19-844d5aee-85245eba-28e841e6-2414fae2",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	960 "PatientMainDicomTags" : {
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	961 "PatientID" : "ozp00SjY2xG",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	962 "PatientName" : "KNIX"
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	963 },
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	964 "Series" : [
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	965 "20b9d0c2-97d85e07-f4dbf4d2-f09e7e6a-0c19062e",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	966 "edbfa0a9-fa2641d7-29514b1c-45881d0b-46c374bd",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	967 "f2635388-f01d497a-15f7c06b-ad7dba06-c4c599fe",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	968 "4d04593b-953ced51-87e93f11-ae4cf03c-25defdcd",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	969 "5e343c3e-3633c396-03aefde8-ba0e08c7-9c8208d3",
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	970 "8ea120d7-5057d919-837dfbcc-ccd04e0f-7f3a94aa"
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	971 ],
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	972 "Type" : "Study"
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	973 }
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	974 ]
b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	975
662 88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	976 Here is a sample REST API call to find the Orthanc identifiers of all
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	977 the DICOM series generated by an imaging modality whose "Device Serial
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	978 Number (0018,1000)" DICOM tag is equal to "123"::
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	979
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	980 $ curl -X POST http://localhost:8042/tools/find -d '{"Level":"Series","Query":{"DeviceSerialNumber":"123"},"Expand":true}'
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	981
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	982 If you are interested by a list of several items (in this case, in
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	983 a list of serial numbers), just separate them with backslashes as
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	984 would do with DICOM C-FIND::
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	985
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	986 $ curl -X POST http://localhost:8042/tools/find -d '{"Level":"Series","Query":{"DeviceSerialNumber":"123\\abc"},"Expand":true}'
88503c6e549f list of items in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 633 diff changeset	987
312 b19b892977a2 expand in /tools/find Sebastien Jodogne <s.jodogne@gmail.com> parents: 297 diff changeset	988
138 f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	989
136 8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	990 Additional Options
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	991 ^^^^^^^^^^^^^^^^^^
138 f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	992 .. highlight:: json
136 8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	993
8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	994 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	995
138 f3127d33cf5e rst syntax Sebastien Jodogne <s.jodogne@gmail.com> parents: 136 diff changeset	996 "Limit":4
136 8e08909ab69b Added find information to: Performing Query/Retrieve and Find with REST Bryan Dearlove <bdearlove@gmail.com> parents: 132 diff changeset	997
132 55a2ee3c462d Performing Query/Retrieve with REST Sebastien Jodogne <s.jodogne@gmail.com> parents: 114 diff changeset	998
216 dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	999 .. _changes:
dcf6c2e60448 added section about peering (wip) amazy parents: 212 diff changeset	1000
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1001 Tracking changes
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1002 ----------------
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1003
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1004 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1005
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1006 Whenever Orthanc receives a new DICOM instance, this event is recorded
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1007 in the so-called "Changes Log". This enables remote scripts to react
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1008 to the arrival of new DICOM resources. A typical application is
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1009 auto-routing, where an external script waits for a new DICOM
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1010 instance to arrive into Orthanc, then forward this instance to another
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1011 modality.
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1012
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1013 The Changes Log can be accessed by the following command::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1014
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1015 $ curl http://localhost:8042/changes
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1016
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1017 .. highlight:: json
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1018
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1019 Here is a typical output::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1020
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1021 {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1022 "Changes" : [
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1023 {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1024 "ChangeType" : "NewInstance",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1025 "Date" : "20130507T143902",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1026 "ID" : "8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1027 "Path" : "/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1028 "ResourceType" : "Instance",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1029 "Seq" : 921
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1030 },
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1031 {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1032 "ChangeType" : "NewSeries",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1033 "Date" : "20130507T143902",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1034 "ID" : "cceb768f-e0f8df71-511b0277-07e55743-9ef8890d",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1035 "Path" : "/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1036 "ResourceType" : "Series",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1037 "Seq" : 922
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1038 },
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1039 {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1040 "ChangeType" : "NewStudy",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1041 "Date" : "20130507T143902",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1042 "ID" : "c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1043 "Path" : "/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1044 "ResourceType" : "Study",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1045 "Seq" : 923
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1046 },
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1047 {
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1048 "ChangeType" : "NewPatient",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1049 "Date" : "20130507T143902",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1050 "ID" : "dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1051 "Path" : "/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1052 "ResourceType" : "Patient",
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1053 "Seq" : 924
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1054 }
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1055 ],
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1056 "Done" : true,
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1057 "Last" : 924
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1058 }
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1059
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1060 This output corresponds to the receiving of one single DICOM instance
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1061 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	1062 and a new patient has been created inside Orthanc. Note that each
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1063 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	1064 <https://en.wikipedia.org/wiki/ISO_8601>`__), the location of the
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1065 resource inside Orthanc, and a sequence number (``Seq``).
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1066
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1067 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	1068 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	1069 loop).
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1070
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1071 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1072
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1073 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	1074 by using the ``limit`` option::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1075
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1076 $ curl http://localhost:8042/changes?limit=100
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1077
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1078 The flag ``Last`` records the sequence number of the lastly returned
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1079 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	1080 occurred after this lastly returned event. If ``Done`` is set to
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1081 ``false``, further events are available and can be retrieved. This is
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1082 done by setting the ``since`` option that specifies from which
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1083 sequence number the changes must be returned::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1084
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1085 $ curl 'http://localhost:8042/changes?limit=100&since=922'
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1086
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1087 A `sample code in the source distribution
449 2922fb1bd65e fix links Sebastien Jodogne <s.jodogne@gmail.com> parents: 428 diff changeset	1088 <https://hg.orthanc-server.com/orthanc/file/default/OrthancServer/Resources/Samples/Python/ChangesLoop.py>`__
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1089 shows how to use this Changes API to implement a polling loop.
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1090
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1091
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1092 Deleting resources from Orthanc
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1093 -------------------------------
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1094
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1095 .. highlight:: bash
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1096
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1097 Deleting patients, studies, series or instances
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1098 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1099
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1100 Deleting DICOM resources (i.e. patients, studies, series or instances)
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1101 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	1102 resource.
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1103
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1104 Concretely, you would first explore the resources that are stored in
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1105 Orthanc :ref:`as explained above <rest-access>`::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1106
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1107 $ curl http://localhost:8042/patients
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1108 $ curl http://localhost:8042/studies
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1109 $ curl http://localhost:8042/series
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1110 $ curl http://localhost:8042/instances
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1111
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1112 Secondly, once you have spotted the resources to be removed, you would
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1113 use the following command-line syntax to delete them::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1114
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1115 $ curl -X DELETE http://localhost:8042/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1116 $ curl -X DELETE http://localhost:8042/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1117 $ curl -X DELETE http://localhost:8042/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1118 $ curl -X DELETE http://localhost:8042/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1119
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1120
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1121 Clearing log of changes
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1122 ^^^^^^^^^^^^^^^^^^^^^^^
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1123
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1124 :ref:`As described above <changes>`, Orthanc keeps track of all the
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1125 changes that occur in the DICOM store. This so-called "Changes Log"
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1126 is accessible at the following URI::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1127
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1128 $ curl http://localhost:8042/changes
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1129
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1130 To clear the content of the Changes Log, simply DELETE this URI::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1131
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1132 $ curl -X DELETE http://localhost:8042/changes
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1133
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1134
155 498c9e42c99d exported resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 139 diff changeset	1135 Log of exported resources
498c9e42c99d exported resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 139 diff changeset	1136 ^^^^^^^^^^^^^^^^^^^^^^^^^
498c9e42c99d exported resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 139 diff changeset	1137
498c9e42c99d exported resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 139 diff changeset	1138 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	1139 all the resources that have been exported to remote modalities::
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1140
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1141 $ curl http://localhost:8042/exports
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1142
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1143 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	1144 indefinitely as incoming instances are routed. You can either disable
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1145 this logging by setting the option ``LogExportedResources`` to ``false``
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1146 in the :ref:`configuration file <configuration>`, or periodically
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1147 clear this log by DELETE-ing this URI::
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1148
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1149 $ curl -X DELETE http://localhost:8042/exports
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1150
155 498c9e42c99d exported resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 139 diff changeset	1151 NB: Starting with Orthanc 1.4.0, the ``LogExportedResources`` is set
498c9e42c99d exported resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 139 diff changeset	1152 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	1153 ``true``.
498c9e42c99d exported resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 139 diff changeset	1154
0 901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1155
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1156 Anonymization and modification
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1157 ------------------------------
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1158
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1159 The process of anonymizing and modifying DICOM resources is
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1160 :ref:`documented in a separate page <anonymization>`.
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1161
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1162
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1163 Further reading
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1164 ---------------
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1165
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1166 The examples above have shown you the basic principles for driving an
901e8961f46e initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1167 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	1168 API have not been described:
5737f51ff94e How does Orthanc stores its database Sebastien Jodogne <s.jodogne@gmail.com> parents: 25 diff changeset	1169
224 02399e86f046 starting documentation of jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 223 diff changeset	1170 * 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	1171 <rest-advanced>`.
35 5737f51ff94e How does Orthanc stores its database Sebastien Jodogne <s.jodogne@gmail.com> parents: 25 diff changeset	1172 * 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	1173 advanced samples of the REST API of Orthanc.
577 7d27154e70f9 cheatsheet and full openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 557 diff changeset	1174 * A :ref:`short reference of the REST API of Orthanc <cheatsheet>` is
7d27154e70f9 cheatsheet and full openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 557 diff changeset	1175 part of the Orthanc Book.
7d27154e70f9 cheatsheet and full openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 557 diff changeset	1176 * The full documentation of the REST API in the OpenAPI/Swagger format
7d27154e70f9 cheatsheet and full openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 557 diff changeset	1177 is `available online <https://api.orthanc-server.com/>`__. This
7d27154e70f9 cheatsheet and full openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 557 diff changeset	1178 reference is automatically generated from the source code of
7d27154e70f9 cheatsheet and full openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 557 diff changeset	1179 Orthanc.

Mercurial > hg > orthanc-book

annotate Sphinx/source/users/rest.rst @ 676:109d663abac0