Mercurial > hg > orthanc-book

annotate OpenAPI/orthanc-openapi.yaml @ 265:4e1a034ace3f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
initial publication of openapi
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 16 Aug 2019 15:10:58 +0200
parents
children 0a97b61ae021
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 openapi: 3.0.0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 info:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 title: Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 version: 1.0.0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 description: >-
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 One of the major strengths of Orthanc lies in its built-in RESTful API, that can be used to drive Orthanc from external applications, independently of the programming language that is used to develop these applications. The REST API of Orthanc gives a full programmatic access to all the core features of Orthanc. Importantly, Orthanc Explorer (the embedded administrative interface of Orthanc) entirely resorts to this REST API for all its features. This implies that anything that can be done through Orthanc Explorer, can also be done through REST queries.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 servers:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 - url: 'https://demo.orthanc-server.com'
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 paths:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 /instances:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 description: The upload of DICOM files is possible by querying the REST API using the following syntax.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 description: DICOM file
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 application/dicom: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 description: New instance successfully posted
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 description: New Orthanc instance ID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 description: URL path for the instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 Status:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 description: Status
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 - Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 description: Get all DICOM instances ID's in Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 description: Array of all instances ID's
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 example: [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 /instances/{Id}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 description: Get an instance from Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 description: Orthanc instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 FileSize:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 FileUuid:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 IndexInSeries:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 MainDicomTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 AcquisitionNumber:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 ImageIndex:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 ImagePositionPatient:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 InstanceNumber:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 SOPInstanceUID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 ParentSeries:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 Type:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 - Instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 "FileSize" : 35440,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 "FileUuid" : "7976ad32-4d15-439b-8789-bf70f52200ec",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 "ID" : "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 "IndexInSeries" : 59,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 "MainDicomTags" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 "AcquisitionNumber" : "2",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 "ImageIndex" : "59",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 "ImagePositionPatient" : "-134.74816\\-272.14441\\-712.764",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 "InstanceNumber" : "59",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 "SOPInstanceUID" : "1.3.12.2.1107.5.1.4.36085.2.0.3752288429331748"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 "ParentSeries" : "318603c5-03e8cffc-a82b6ee1-3ccd3c1e-18d7e3bb",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 "Type" : "Instance"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 tags : [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 description: Delete an instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 /instances/{Id}/simplified-tags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 description: Get the human readable tags for the DICOM instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
131 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
132 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
134 description: DICOM tags and values
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
135 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
140 "ACR_NEMA_2C_VariablePixelDataGroupLength" : "57130",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
141 "AccessionNumber" : null,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
142 "AcquisitionDate" : "20120716",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143 "AcquisitionDateTime" : "20120716171219",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
144 "AcquisitionTime" : "171219",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
145 "ActualFrameDuration" : "3597793",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
146 "AttenuationCorrectionMethod" : "CTAC-SG",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147 "PatientID" : "000000185",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
148 "PatientName" : "Anonymous^Unknown",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
149 "PatientOrientationCodeSequence" : [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
150 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
151 "CodeMeaning" : "recumbent",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
152 "CodeValue" : "F-10450",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
153 "CodingSchemeDesignator" : "99SDM",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
154 "PatientOrientationModifierCodeSequence" : [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
155 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
156 "CodeMeaning" : "supine",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
157 "CodeValue" : "F-10340",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
158 "CodingSchemeDesignator" : "99SDM"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
159 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
160 ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
161 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
162 ],
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
163 "StudyDescription" : "TestSUVce-TF",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
164 "StudyID" : "23848",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
165 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
166 "StudyTime" : "171117",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
167 "TypeOfDetectorMotion" : "NONE",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
168 "Units" : "BQML",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
169 "Unknown" : null,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
170 "WindowCenter" : "1.496995e+04",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
171 "WindowWidth" : "2.993990e+04"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
172 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
173 /instances/{Id}/tags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
174 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
175 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
176 description: Get the detailed tags for the DICOM instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
177 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
178 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
179 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
180 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
181 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
182 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
183 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
184 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
185 description: DICOM tags and values
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
186 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
187 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
188 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
189 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
190 example:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
191 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
192 "0008,0005" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
193 "Name" : "SpecificCharacterSet",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
194 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
195 "Value" : "ISO_IR 100"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
196 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
197 "0008,0008" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
198 "Name" : "ImageType",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
199 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
200 "Value" : "ORIGINAL\\PRIMARY\\HEADER_CORRECTED"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
201 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
202 "0008,0016" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
203 "Name" : "SOPClassUID",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
204 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
205 "Value" : "1.2.840.10008.5.1.4.1.1.128"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
206 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
207 "0008,0018" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
208 "Name" : "SOPInstanceUID",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
209 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
210 "Value" : "1.3.12.2.1107.5.1.4.36085.2.0.3752288429331748"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
211 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
212 "0008,0020" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
213 "Name" : "StudyDate",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
214 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
215 "Value" : "20040304"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
216 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
217 "0008,0021" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
218 "Name" : "SeriesDate",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
219 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
220 "Value" : "20040304"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
221 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
222 "0008,0022" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
223 "Name" : "AcquisitionDate",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
224 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
225 "Value" : "20040304"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
226 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
227 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
228 /instances/{Id}/content/{Tag}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
229 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
230 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
231 description: Get the value for a single tag of a DICOM instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
232 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
233 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
234 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
235 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
236 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
237 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
238 - name: Tag
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
239 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
240 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
241 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
242 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
243 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
244 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
245 description: Returns the DICOM tag value or value sub-structure.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
246 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
247 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
248 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
249 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
250 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
251 example: Anonymous^Unknown
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
252 /instances/{Id}/file:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
253 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
254 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
255 description: Download the DICOM instance file in DCM format.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
256 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
257 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
258 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
259 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
260 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
261 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
262 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
263 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
264 description: DICOM file contents
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
265 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
266 application/dicom: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
267 /instances/{Id}/preview:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
268 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
269 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
270 description: Download a preview image of the DICOM instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
271 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
272 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
273 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
274 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
275 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
276 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
277 - name: Accept
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
278 description: Default is image/png
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
279 required: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
280 in: header
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
281 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
282 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
283 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
284 - image/png
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
285 - image/jpeg
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
286 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
287 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
288 description: DICOM preview
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
289 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
290 image/png: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
291 image/jpg: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
292 /instances/{Id}/{PixelFormat}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
293 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
294 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
295 description: Download a preview image of the DICOM instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
296 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
297 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
298 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
299 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
300 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
301 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
302 - name: PixelFormat
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
303 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
304 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
305 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
306 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
307 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
308 - image-uint8
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
309 - image-uint16
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
310 - image-int16
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
311 - name: Accept
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
312 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
313 in: header
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
314 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
315 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
316 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
317 - image/png
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
318 - image/jpeg
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
319 - image/x-portable-arbitrarymap
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
320 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
321 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
322 description: DICOM preview
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
323 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
324 image/png: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
325 image/jpg: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
326 image/x-portable-arbitrarymap: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
327 /instances/{Id}/pdf:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
328 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
329 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
330 description: Download the embedded PDF of the DICOM instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
331 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
332 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
333 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
334 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
335 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
336 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
337 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
338 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
339 description: The raw PDF bytes are returned.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
340 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
341 application/pdf: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
342 404:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
343 description: The instance does not contain an encapsulated PDF or the instance is not found.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
344 /series:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
345 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
346 tags: [Series]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
347 description: Get all DICOM series ID's in Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
348 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
349 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
350 description: Array of all series ID's
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
351 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
352 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
353 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
354 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
355 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
356 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
357 example: [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
358 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
359 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
360 ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
361 /series/{Id}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
362 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
363 tags: [Series]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
364 description: Get a series from Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
365 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
366 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
367 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
368 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
369 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
370 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
371 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
372 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
373 description: Orthanc series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
374 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
375 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
376 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
377 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
378 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
379 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
380 ExpectedNumberOfInstances:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
381 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
382 Instances:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
383 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
384 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
385 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
386 MainDicomTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
387 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
388 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
389 Manufacturer:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
390 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
391 Modality:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
392 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
393 NumberOfSlices:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
394 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
395 ProtocolName:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
396 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
397 SeriesDate:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
398 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
399 SeriesDescription:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
400 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
401 SeriesInstanceUID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
402 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
403 SeriesNumber:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
404 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
405 SeriesTime:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
406 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
407 StationName:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
408 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
409 ParentStudy:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
410 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
411 Type:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
412 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
413 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
414 - Series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
415 Status:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
416 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
417 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
418 - Complete
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
419 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
420 "ExpectedNumberOfInstances" : 45,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
421 "ID" : "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
422 "Instances" : [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
423 "41bc3f74-360f9d10-6ae9ffa4-01ea2045-cbd457dd",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
424 "1d3de868-6c4f0494-709fd140-7ccc4c94-a6daa3a8",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
425 "1010f80b-161b71c0-897ec01b-c85cd206-e669a3ea",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
426 "e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
427 ],
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
428 "MainDicomTags" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
429 "Manufacturer" : "Philips Medical Systems",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
430 "Modality" : "PT",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
431 "NumberOfSlices" : "45",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
432 "ProtocolName" : "CHU/Body_PET/CT___50",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
433 "SeriesDate" : "20120716",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
434 "SeriesDescription" : "[WB_CTAC] Body",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
435 "SeriesInstanceUID" : "1.3.46.670589.28.2.12.30.26407.37145.2.2516.0.1342458737",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
436 "SeriesNumber" : "587370",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
437 "SeriesTime" : "171121",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
438 "StationName" : "r054-svr"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
439 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
440 "ParentStudy" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
441 "Status" : "Complete",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
442 "Type" : "Series"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
443 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
444 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
445 tags : [Series]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
446 description: Delete a series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
447 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
448 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
449 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
450 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
451 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
452 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
453 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
454 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
455 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
456 /studies:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
457 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
458 tags: [Studies]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
459 description: Get all DICOM studies ID's in Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
460 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
461 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
462 description: Array of all study ID's
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
463 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
464 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
465 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
466 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
467 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
468 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
469 example: [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
470 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
471 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
472 ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
473 /studies/{Id}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
474 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
475 tags: [Studies]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
476 description: Get a study from Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
477 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
478 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
479 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
480 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
481 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
482 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
483 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
484 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
485 description: Orthanc study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
486 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
487 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
488 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
489 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
490 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
491 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
492 Series:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
493 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
494 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
495 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
496 MainDicomTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
497 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
498 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
499 AccesionNumber:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
500 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
501 StudyDate:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
502 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
503 StudyDescription:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
504 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
505 StudyID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
506 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
507 StudyInstanceUID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
508 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
509 StudyTime:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
510 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
511 ParentPatient:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
512 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
513 Type:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
514 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
515 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
516 - Study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
517 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
518 "ID" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
519 "MainDicomTags" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
520 "AccessionNumber" : "(null)",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
521 "StudyDate" : "20120716",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
522 "StudyDescription" : "TestSUVce-TF",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
523 "StudyID" : "23848",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
524 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
525 "StudyTime" : "170728"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
526 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
527 "ParentPatient" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
528 "Series" : [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
529 "6821d761-31fb55a9-031ebecb-ba7f9aae-ffe4ddc0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
530 "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
531 "7384c47e-6398f2a8-901846ef-da1e2e0b-6c50d598"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
532 ],
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
533 "Type" : "Study"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
534 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
535 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
536 tags : [Studies]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
537 description: Delete a study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
538 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
539 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
540 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
541 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
542 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
543 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
544 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
545 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
546 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
547 /patients:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
548 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
549 tags: [Patients]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
550 description: Get all DICOM patient ID's in Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
551 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
552 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
553 description: Array of all patient ID's
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
554 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
555 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
556 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
557 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
558 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
559 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
560 example: [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
561 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
562 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
563 ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
564 /patients/{Id}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
565 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
566 tags: [Patients]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
567 description: Get a patient from Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
568 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
569 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
570 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
571 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
572 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
573 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
574 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
575 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
576 description: Orthanc patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
577 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
578 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
579 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
580 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
581 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
582 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
583 Studies:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
584 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
585 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
586 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
587 MainDicomTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
588 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
589 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
590 OtherPatientIDs:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
591 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
592 PatientBirthDate:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
593 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
594 PatientName:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
595 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
596 PatientSex:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
597 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
598 ParentPatient:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
599 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
600 Type:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
601 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
602 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
603 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
604 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
605 "ID" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
606 "MainDicomTags" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
607 "OtherPatientIDs" : "(null)",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
608 "PatientBirthDate" : "0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
609 "PatientID" : "000000185",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
610 "PatientName" : "Anonymous^Unknown",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
611 "PatientSex" : "O"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
612 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
613 "Studies" : [ "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15" ],
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
614 "Type" : "Patient"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
615 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
616 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
617 tags : [Patients]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
618 description: Delete a patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
619 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
620 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
621 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
622 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
623 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
624 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
625 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
626 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
627 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
628
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
629 /peers:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
630 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
631 tags: [Orthanc Peers]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
632 description: Get a list of Orthanc peers.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
633 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
634 - name: expand
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
635 in: query
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
636 required: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
637 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
638 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
639 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
640 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
641 description: List of Orthanc peers
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
642 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
643 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
644 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
645 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
646 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
647 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
648 /peers/{Peer}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
649 put:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
650 tags: [Orthanc Peers]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
651 description: Add a new Orthanc peer. Note that this will only be stored in memory unless the 'OrthancPeersInDatabase' configuration option is set.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
652 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
653 - name: Peer
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
654 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
655 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
656 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
657 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
658 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
659 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
660 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
661 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
662 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
663 Url:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
664 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
665 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
666 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
667 description: Peer created
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
668 /peers/{Peer}/store:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
669 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
670 tags: [Orthanc Peers]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
671 description: Send a resource to an Orthanc peer. Resource ID's are provided either as JSON array or a raw string.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
672 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
673 - name: Peer
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
674 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
675 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
676 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
677 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
678 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
679 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
680 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
681 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
682 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
683 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
684 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
685 description: Resource ID (patient, study, series or instance) to send to the peer.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
686 example: ["d4b46c8e-74b16992-b0f5ca11-f04a60fa-8eb13a88","d5604121-7d613ce6-c315a5-a77b3cf3-9c253b23","cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e"]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
687 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
688 example: d4b46c8e-74b16992-b0f5ca11-f04a60fa-8eb13a88
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
689 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
690 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
691 description: Resources sent
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
692
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
693 /modalities/{Modality}/store:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
694 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
695 tags: [Orthanc Peers]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
696 description: Once you have identified the Orthanc identifier of the DICOM resource that would like to send you would use the following command to send it.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
697 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
698 - name: Modality
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
699 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
700 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
701 description: The Modality to invoke C-STORE from within the Orthanc configuration file
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
702 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
703 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
704 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
705 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
706 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
707 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
708 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
709 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
710 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
711 description: Resource ID (patient, study, series or instance) to send to the remote modality.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
712 example: ["d4b46c8e-74b16992-b0f5ca11-f04a60fa-8eb13a88","d5604121-7d613ce6-c315a5-a77b3cf3-9c253b23","cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e"]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
713 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
714 example: d4b46c8e-74b16992-b0f5ca11-f04a60fa-8eb13a88
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
715 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
716 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
717 description: Resources sent
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
718 /modalities/{Modality}/query:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
719 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
720 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
721 description: To initiate a query you perform a POST command against the Modality with the identifiers you are looking for. This search is case insensitive unless configured otherwise within the Orthanc configuration file. Note that queries are cleaned up after a period of inactivity, which can sometimes be very short. You will need to access the query results quickly.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
722 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
723 - name: Modality
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
724 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
725 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
726 description: The Modality to be queried from within the Orthanc configuration file
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
727 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
728 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
729 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
730 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
731 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
732 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
733 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
734 Level:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
735 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
736 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
737 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
738 - Study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
739 - Series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
740 - Instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
741 Query:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
742 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
743 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
744 PatientID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
745 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
746 StudyDescription:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
747 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
748 description: Match the study description. Note that wildcard "*" can be used to match any text (eg. "*Chest*").
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
749 PatientName:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
750 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
751 StudyDate:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
752 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
753 description: This is the study date in the format "20160504". Note that ranges can be used using a hyphen (eg. "20160504-" and "20160504-20170504").
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
754 StudyTime:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
755 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
756 required: [Level, Query]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
757 example: {"Level":"Study","Query": {"PatientID":"","StudyDescription":"*Chest*","PatientName":""}}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
758 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
759 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
760 description: Query successful
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
761 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
762 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
763 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
764 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
765 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
766 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
767 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
768 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
769 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
770 "ID": "5af318ac-78fb-47ff-b0b0-0df18b0588e0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
771 "Path": "/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
772 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
773 /queries/{QueryID}/level:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
774 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
775 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
776 description: Review the query level, such as Patient, Study, Series or Instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
777 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
778 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
779 description: This is the query ID that comes from posting a query to the modality.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
780 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
781 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
782 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
783 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
784 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
785 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
786 description: Return the level of the query, whether Patient, Study, Series or Instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
787 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
788 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
789 example: Series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
790 /queries/{QueryID}/modality:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
791 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
792 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
793 description: Review the query modality name that the query was originally performed against.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
794 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
795 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
796 description: This is the query ID that comes from posting a query to the modality.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
797 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
798 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
799 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
800 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
801 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
802 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
803 description: Return the name of the modality that the query was run against.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
804 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
805 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
806 example: SomeModalityName
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
807 /queries/{QueryID}/query:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
808 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
809 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
810 description: Review the query that was posted.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
811 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
812 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
813 description: This is the query ID that comes from posting a query to the modality.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
814 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
815 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
816 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
817 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
818 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
819 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
820 description: Return the query identifiers that were used originally when it was posted.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
821 /queries/{QueryID}/answers:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
822 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
823 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
824 description: Review the query answers.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
825 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
826 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
827 description: This is the query ID that comes from posting a query to the modality.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
828 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
829 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
830 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
831 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
832 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
833 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
834 description: Return the query answers.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
835 /queries/{QueryID}/answers/{Idx}/content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
836 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
837 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
838 description: Review a specific query answer. If there are content items missing, you may add them by adding that identifier to the original query. For example if we wanted Modalities listed in this JSON answer in the initial query we would add to the POST body "ModalitiesInStudy":""
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
839 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
840 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
841 description: This is the query ID that comes from posting a query to the modality.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
842 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
843 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
844 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
845 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
846 - name: Idx
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
847 description: This is the index of a specific answer in the list of answers of the query.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
848 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
849 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
850 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
851 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
852 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
853 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
854 description: Return a single query answer
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
855 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
856 application/json: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
857 /queries/{QueryID}/retrieve:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
858 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
859 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
860 description: You can perform a C-Move to retrieve all studies within the original query using a post command and identifying the Modality (named in this example Orthanc), to be one to in the POST contents. The C-Move can be done asynchronously using an Orthanc job using a JSON parameter in the request body.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
861 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
862 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
863 description: This is the query ID that comes from posting a query to the modality.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
864 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
865 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
866 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
867 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
868 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
869 description: The request body is the name of the modality to perform the C-Move or a JSON structure with additional information.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
870 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
871 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
872 example: Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
873 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
874 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
875 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
876 TargetAet:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
877 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
878 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
879 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
880 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
881 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
882 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
883 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
884 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
885 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
886 example: {"TargetAet":"Orthanc","Synchronous":false}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
887 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
888 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
889 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
890 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
891 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
892 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
893 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
894 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
895 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
896 description: The ID of the job if the retrieve is asynchronous (ie. Synchronous is set to true)
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
897 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
898 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
899 description: The URL path of the job if the retrieve is asynchronous (ie. Synchronous is set to false)
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
900 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
901 "ID" : "11541b16-e368-41cf-a8e9-3acf4061d238",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
902 "Path" : "/jobs/11541b16-e368-41cf-a8e9-3acf4061d238"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
903 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
904 /queries/{QueryID}/answers/{Idx}/retrieve:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
905 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
906 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
907 description: You can perform a C-Move to retrieve a specific study within the original query using a post command and identifying the Modality (named in this example Orthanc), to be one to in the POST contents.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
908 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
909 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
910 description: This is the query ID that comes from posting a query to the modality.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
911 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
912 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
913 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
914 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
915 - name: Idx
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
916 description: This is the index of a specific answer in the list of answers of the query.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
917 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
918 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
919 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
920 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
921 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
922 description: The request body is the name of the modality to perform the C-Move.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
923 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
924 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
925 example: Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
926 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
927 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
928 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
929 /tools/find:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
930 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
931 tags: [Find]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
932 description: Performing a find within Orthanc is very similar to using Queries against DICOM modalities and the additional options listed above work with find also. When performing a find, you will receive the Orthanc ID’s of all the matched items within your find. For example if you perform a study level find and 5 Studies match you will receive 5 study level Orthanc ID’s in JSON format as a response.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
933 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
934 description: The request body gives the parameters for the find much like when querying a remote modality.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
935 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
936 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
937 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
938 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
939 Level:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
940 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
941 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
942 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
943 - Study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
944 - Series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
945 - Instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
946 Limit:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
947 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
948 Query:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
949 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
950 Modality:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
951 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
952 StudyDate:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
953 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
954 PatientID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
955 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
956 example: {"Level":"Instance","Limit": 2, "Query":{"Modality":"CR","StudyDate":"20180323-","PatientID":"*"}}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
957 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
958 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
959 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
960 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
961 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
962 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
963 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
964 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
965 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
966 example: [ "6821d761-31fb55a9-031ebecb-ba7f9aae-ffe4ddc0", "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35" ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
967 /changes:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
968 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
969 tags: [Tracking Changes]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
970 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
971 - name: limit
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
972 description: Limit the number of changes to a maximum of the provided number.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
973 in: query
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
974 required: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
975 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
976 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
977 - name: since
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
978 description: Show only changes that have happened after the change with the provided sequence number.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
979 in: query
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
980 required: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
981 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
982 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
983 description: Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called “Changes Log”. This enables remote scripts to react to the arrival of new DICOM resources. A typical application is auto-routing, where an external script waits for a new DICOM instance to arrive into Orthanc, then forward this instance to another modality.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
984 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
985 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
986 description: The list of recent changes
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
987 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
988 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
989 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
990 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
991 Changes:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
992 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
993 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
994 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
995 ChangeType:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
996 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
997 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
998 - NewPatient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
999 - NewStudy
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1000 - NewSeries
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1001 - NewInstance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1002 - StablePatient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1003 - StableStudy
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1004 - StableSeries
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1005 - StableInstance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1006 Date:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1007 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1008 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1009 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1010 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1011 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1012 ResourceType:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1013 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1014 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1015 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1016 - Study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1017 - Series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1018 - Instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1019 Seq:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1020 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1021 Done:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1022 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1023 description: The flag Done is set to true if no further event has occurred after this lastly returned event. If Done is set to false, further events are available and can be retrieved. This is done by setting the since option that specifies from which sequence number the changes must be returned.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1024 Last:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1025 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1026 description: The flag Last records the sequence number of the lastly returned event.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1027 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1028 "Changes" : [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1029 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1030 "ChangeType" : "NewInstance",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1031 "Date" : "20130507T143902",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1032 "ID" : "8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1033 "Path" : "/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1034 "ResourceType" : "Instance",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1035 "Seq" : 921
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1036 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1037 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1038 "ChangeType" : "NewSeries",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1039 "Date" : "20130507T143902",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1040 "ID" : "cceb768f-e0f8df71-511b0277-07e55743-9ef8890d",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1041 "Path" : "/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1042 "ResourceType" : "Series",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1043 "Seq" : 922
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1044 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1045 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1046 "ChangeType" : "NewStudy",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1047 "Date" : "20130507T143902",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1048 "ID" : "c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1049 "Path" : "/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1050 "ResourceType" : "Study",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1051 "Seq" : 923
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1052 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1053 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1054 "ChangeType" : "NewPatient",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1055 "Date" : "20130507T143902",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1056 "ID" : "dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1057 "Path" : "/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1058 "ResourceType" : "Patient",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1059 "Seq" : 924
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1060 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1061 ],
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1062 "Done" : true,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1063 "Last" : 924
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1064 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1065 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1066 tags : [Tracking Changes]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1067 description: Clear the content of the changes log
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1068 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1069 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1070 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1071
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1072 /exports:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1073 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1074 tags: [Exported Resources]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1075 description: For medical traceability, Orthanc can be configured to store a log of all the resources that have been exported to remote modalities.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1076 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1077 200: {description: Success}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1078
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1079 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1080 tags: [Exported Resources]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1081 description: In auto-routing scenarios, it is important to prevent this log to grow indefinitely as incoming instances are routed. You can either disable this logging by setting the option LogExportedResources to false in the configuration file, or periodically clear this log by DELETE-ing this URI.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1082 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1083 200: {description: Success}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1084
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1085 /instances/{Id}/anonymize:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1086 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1087 tags: [Anonymization]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1088 description: Anonymize the instance by erasing all the tags that are specified in Table E.1-1 from PS 3.15 of the DICOM standard 2008 or 2017c (default). The response will contain the anonymized DICOM result. New UUIDs are automatically generated for the instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1089 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1090 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1091 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1092 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1093 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1094 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1095 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1096 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1097 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1098 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1099 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1100 DicomVersion:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1101 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1102 description: Specifies which version of the DICOM standard shall be used for anonymization. Allowed values are 2008 and 2017c (default value if the parameter is absent). This parameter has been introduced in Orthanc 1.3.0. In earlier version, the 2008 standard was used.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1103 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1104 - 2017c
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1105 - 2008
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1106 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1107 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1108 description: Replace is an associative array that associates a DICOM tag with its new string value. The value is dynamically cast to the proper DICOM data type (an HTTP error will occur if the cast fails). Replacements are applied after all the tags to anonymize have been removed.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1109 Keep:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1110 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1111 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1112 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1113 description: List of DICOM tags that should be kept through the anonymization process.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1114 KeepPrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1115 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1116 description: If KeepPrivateTags is set to true in the JSON request, private tags (i.e. manufacturer-specific tags) are not removed by the anonymization process. The default behavior consists in removing the private tags, as such tags can contain patient-specific information.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1117 example: {"Replace":{"PatientName":"Hello","0010-1001":"World"},"Keep":["StudyDescription", "SeriesDescription"],"KeepPrivateTags": true, "DicomVersion" : "2017c"}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1118 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1119 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1120 description: The response contains a DICOM file that has been anonymized.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1121 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1122 application/dicom: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1123
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1124 /patients/{Id}/anonymize:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1125 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1126 tags: [Anonymization]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1127 description: Anonymize the patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1128 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1129 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1130 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1131 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1132 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1133 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1134 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1135 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1136 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1137 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1138 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1139 DicomVersion:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1140 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1141 description: Specifies which version of the DICOM standard shall be used for anonymization. Allowed values are 2008 and 2017c (default value if the parameter is absent). This parameter has been introduced in Orthanc 1.3.0. In earlier version, the 2008 standard was used.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1142 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1143 - 2017c
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1144 - 2008
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1145 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1146 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1147 description: Replace is an associative array that associates a DICOM tag with its new string value. The value is dynamically cast to the proper DICOM data type (an HTTP error will occur if the cast fails). Replacements are applied after all the tags to anonymize have been removed.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1148 Keep:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1149 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1150 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1151 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1152 description: List of DICOM tags that should be kept through the anonymization process.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1153 KeepPrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1154 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1155 description: If KeepPrivateTags is set to true in the JSON request, private tags (i.e. manufacturer-specific tags) are not removed by the anonymization process. The default behavior consists in removing the private tags, as such tags can contain patient-specific information.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1156 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1157 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1158 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1159 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1160 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1161 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1162 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1163 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1164 example: {"Replace":{"PatientName":"Hello","0010-1001":"World"},"Keep":["StudyDescription", "SeriesDescription"],"KeepPrivateTags": true, "DicomVersion" : "2017c"}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1165 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1166 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1167 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1168 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1169 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1170 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1171 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1172 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1173 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1174 description: The ID of the new anonymized patient.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1175 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1176 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1177 description: The URL of the new anonymized patient.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1178 PatientID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1179 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1180 Type:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1181 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1182 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1183 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1184 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1185 "ID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1186 "Path" : "/patients/f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1187 "PatientID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1188 "Type" : "Patient"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1189 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1190
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1191 /studies/{Id}/anonymize:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1192 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1193 tags: [Anonymization]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1194 description: Anonymize the study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1195 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1196 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1197 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1198 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1199 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1200 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1201 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1202 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1203 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1204 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1205 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1206 DicomVersion:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1207 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1208 description: Specifies which version of the DICOM standard shall be used for anonymization. Allowed values are 2008 and 2017c (default value if the parameter is absent). This parameter has been introduced in Orthanc 1.3.0. In earlier version, the 2008 standard was used.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1209 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1210 - 2017c
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1211 - 2008
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1212 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1213 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1214 description: Replace is an associative array that associates a DICOM tag with its new string value. The value is dynamically cast to the proper DICOM data type (an HTTP error will occur if the cast fails). Replacements are applied after all the tags to anonymize have been removed.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1215 Keep:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1216 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1217 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1218 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1219 description: List of DICOM tags that should be kept through the anonymization process.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1220 KeepPrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1221 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1222 description: If KeepPrivateTags is set to true in the JSON request, private tags (i.e. manufacturer-specific tags) are not removed by the anonymization process. The default behavior consists in removing the private tags, as such tags can contain patient-specific information.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1223 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1224 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1225 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1226 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1227 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1228 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1229 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1230 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1231 example: {"Replace":{"PatientName":"Hello","0010-1001":"World"},"Keep":["StudyDescription", "SeriesDescription"],"KeepPrivateTags": true, "DicomVersion" : "2017c"}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1232 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1233 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1234 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1235 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1236 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1237 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1238 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1239 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1240 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1241 description: The ID of the new anonymized study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1242 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1243 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1244 description: The URL of the new anonymized study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1245 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1246 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1247 "Path" : "/studies/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1248 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1249
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1250 /series/{Id}/anonymize:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1251 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1252 tags: [Anonymization]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1253 description: Anonymize the series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1254 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1255 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1256 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1257 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1258 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1259 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1260 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1261 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1262 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1263 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1264 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1265 DicomVersion:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1266 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1267 description: Specifies which version of the DICOM standard shall be used for anonymization. Allowed values are 2008 and 2017c (default value if the parameter is absent). This parameter has been introduced in Orthanc 1.3.0. In earlier version, the 2008 standard was used.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1268 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1269 - 2017c
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1270 - 2008
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1271 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1272 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1273 description: Replace is an associative array that associates a DICOM tag with its new string value. The value is dynamically cast to the proper DICOM data type (an HTTP error will occur if the cast fails). Replacements are applied after all the tags to anonymize have been removed.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1274 Keep:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1275 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1276 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1277 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1278 description: List of DICOM tags that should be kept through the anonymization process.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1279 KeepPrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1280 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1281 description: If KeepPrivateTags is set to true in the JSON request, private tags (i.e. manufacturer-specific tags) are not removed by the anonymization process. The default behavior consists in removing the private tags, as such tags can contain patient-specific information.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1282 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1283 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1284 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1285 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1286 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1287 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1288 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1289 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1290 example: {"Replace":{"PatientName":"Hello","0010-1001":"World"},"Keep":["StudyDescription", "SeriesDescription"],"KeepPrivateTags": true, "DicomVersion" : "2017c"}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1291 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1292 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1293 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1294 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1295 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1296 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1297 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1298 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1299 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1300 description: The ID of the new anonymized series.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1301 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1302 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1303 description: The URL of the new anonymized series.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1304 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1305 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1306 "Path" : "/series/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1307 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1308
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1309 /instances/{Id}/modify:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1310 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1311 tags: [Modification]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1312 description: Orthanc allows to modify a set of specified tags in a single DICOM instance and to download the resulting modified DICOM file.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1313 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1314 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1315 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1316 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1317 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1318 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1319 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1320 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1321 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1322 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1323 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1324 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1325 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1326 description: The Replace associative array specifies the substitions to be applied (cf. anonymization).
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1327 Remove:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1328 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1329 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1330 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1331 description: The Remove array specifies the list of the tags to remove.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1332 RemovePrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1333 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1334 description: If RemovePrivateTags is set to true, the private tags (i.e. manufacturer-specific tags) are removed.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1335 Force:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1336 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1337 description: The Force option must be set to true, in order to allow the modification of the PatientID, as such a modification of the DICOM identifiers might lead to breaking the DICOM model of the real-world. In general, any explicit modification to one of the PatientID, StudyInstanceUID, SeriesInstanceUID, and SOPInstanceUID requires Force to be set to true, in order to prevent any unwanted side effect.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1338 default: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1339 example: {"Replace":{"PatientName":"hello","PatientID":"world"},"Remove":["InstitutionName"],"RemovePrivateTags": true, "Force": true}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1340 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1341 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1342 description: The response contains a DICOM file that has been anonymized.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1343 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1344 application/dicom: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1345
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1346 /studies/{Id}/modify:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1347 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1348 tags: [Modification]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1349 description: It is possible to modify all the instances from a study or from a series in a single request. In this case, the modified instances are stored back into the Orthanc store.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1350 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1351 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1352 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1353 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1354 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1355 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1356 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1357 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1358 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1359 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1360 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1361 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1362 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1363 description: The Replace associative array specifies the substitions to be applied (cf. anonymization).
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1364 Remove:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1365 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1366 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1367 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1368 description: The Remove array specifies the list of the tags to remove.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1369 RemovePrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1370 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1371 description: If RemovePrivateTags is set to true, the private tags (i.e. manufacturer-specific tags) are removed.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1372 Force:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1373 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1374 description: The Force option must be set to true, in order to allow the modification of the PatientID, as such a modification of the DICOM identifiers might lead to breaking the DICOM model of the real-world. In general, any explicit modification to one of the PatientID, StudyInstanceUID, SeriesInstanceUID, and SOPInstanceUID requires Force to be set to true, in order to prevent any unwanted side effect.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1375 default: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1376 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1377 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1378 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1379 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1380 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1381 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1382 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1383 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1384 example: {"Replace":{"InstitutionName":"My own clinic"}}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1385 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1386 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1387 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1388 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1389 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1390 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1391 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1392 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1393 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1394 description: The ID of the new modified study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1395 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1396 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1397 description: The URL of the new modified study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1398 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1399 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1400 "Path" : "/studies/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1401 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1402
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1403 /series/{Id}/modify:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1404 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1405 tags: [Modification]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1406 description: It is possible to modify all the instances from a study or from a series in a single request. In this case, the modified instances are stored back into the Orthanc store.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1407 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1408 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1409 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1410 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1411 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1412 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1413 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1414 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1415 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1416 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1417 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1418 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1419 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1420 description: The Replace associative array specifies the substitions to be applied (cf. anonymization).
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1421 Remove:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1422 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1423 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1424 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1425 description: The Remove array specifies the list of the tags to remove.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1426 RemovePrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1427 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1428 description: If RemovePrivateTags is set to true, the private tags (i.e. manufacturer-specific tags) are removed.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1429 Force:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1430 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1431 description: The Force option must be set to true, in order to allow the modification of the PatientID, as such a modification of the DICOM identifiers might lead to breaking the DICOM model of the real-world. In general, any explicit modification to one of the PatientID, StudyInstanceUID, SeriesInstanceUID, and SOPInstanceUID requires Force to be set to true, in order to prevent any unwanted side effect.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1432 default: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1433 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1434 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1435 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1436 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1437 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1438 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1439 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1440 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1441 example: {"Replace":{"InstitutionName":"My own clinic"}}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1442 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1443 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1444 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1445 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1446 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1447 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1448 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1449 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1450 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1451 description: The ID of the new modified study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1452 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1453 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1454 description: The URL of the new modified study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1455 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1456 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1457 "Path" : "/series/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1458 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1459
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1460 /patients/{Id}/modify:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1461 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1462 tags: [Modification]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1463 description: Starting with Orthanc 0.7.5, Orthanc can also modify all the instances of a patient with a single REST call.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1464 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1465 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1466 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1467 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1468 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1469 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1470 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1471 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1472 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1473 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1474 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1475 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1476 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1477 description: The Replace associative array specifies the substitions to be applied (cf. anonymization).
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1478 Remove:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1479 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1480 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1481 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1482 description: The Remove array specifies the list of the tags to remove.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1483 RemovePrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1484 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1485 description: If RemovePrivateTags is set to true, the private tags (i.e. manufacturer-specific tags) are removed.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1486 Force:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1487 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1488 description: The Force option must be set to true, in order to allow the modification of the PatientID, as such a modification of the DICOM identifiers might lead to breaking the DICOM model of the real-world. In general, any explicit modification to one of the PatientID, StudyInstanceUID, SeriesInstanceUID, and SOPInstanceUID requires Force to be set to true, in order to prevent any unwanted side effect.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1489 default: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1490 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1491 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1492 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1493 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1494 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1495 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1496 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1497 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1498 example: {"Replace":{"PatientID":"Hello","PatientName":"Sample patient name"},"Force":true}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1499 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1500 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1501 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1502 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1503 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1504 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1505 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1506 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1507 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1508 description: The ID of the new modified patient.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1509 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1510 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1511 description: The URL of the new modified patient.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1512 PatientID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1513 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1514 Type:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1515 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1516 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1517 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1518 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1519 "ID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1520 "Path" : "/patients/f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1521 "PatientID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1522 "Type" : "Patient"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1523 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1524
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1525 /studies/{Id}/split:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1526 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1527 tags: [Split/merge DICOM studies]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1528 description: "Starting with Orthanc 1.5.0, Orthanc supports splitting and merging DICOM studies through its REST API. By issuing the example command, the series whose Orthanc identifier is 6ca4c9f3-5e895cb3-4d82c6da-09e060fe-9c59f228, and that is part of the source study with identifier in the URL, will be removed from the source study, and will be moved to a brand new study. This is done by generating a new value for all the following DICOM tags in the DICOM instances of the series of interest: StudyInstanceUID (0x0020, 0x000d), SeriesInstanceUID (0x0020, 0x000e), and SOPInstanceUID (0x0008, 0x0018)"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1529 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1530 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1531 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1532 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1533 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1534 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1535 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1536 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1537 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1538 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1539 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1540 Series:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1541 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1542 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1543 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1544 description: Series gives the list of series to be separated from the parent study (mandatory option). These series must all be children of the same source study, that is specified in the URI.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1545 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1546 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1547 description: Replace allows to overwrite the DICOM tags that are part of the "Patient Module Attributes" and the "General Study Module Attributes", as specified by the DICOM 2011 standard in Tables C.7-1 and C.7-3.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1548 Remove:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1549 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1550 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1551 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1552 description: Remove allows to remove DICOM tags from the same modules as in the Replace options.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1553 KeepSource:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1554 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1555 description: KeepSource (Boolean value), if set to true, instructs Orthanc to keep a copy of the original series in the source study. By default, the original series are deleted from Orthanc.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1556 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1557 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1558 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1559 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1560 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1561 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1562 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1563 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1564 example: {"Series":["6ca4c9f3-5e895cb3-4d82c6da-09e060fe-9c59f228"],"Replace":{"PatientName":"HELLO"},"Remove":["AccessionNumber"]}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1565 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1566 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1567 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1568
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1569 /studies/{Id}/merge:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1570 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1571 tags: [Split/merge DICOM studies]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1572 description: "Merge DICOM series into another DICOM study. By issuing this command, the DICOM series whose Orthanc identifier is ef2ce55f-9342856a-aee23907-2667e859-9f3b734d, will be merged into target study with identifier Id in the URL. As in the case of splitting, this is done by updating the following DICOM tags: StudyInstanceUID (0x0020, 0x000d), SeriesInstanceUID (0x0020, 0x000e), and SOPInstanceUID (0x0008, 0x0018). Furthermore, all the DICOM tags that are part of the “Patient Module Attributes” and the “General Study Module Attributes” (as specified by the DICOM 2011 standard in Tables C.7-1 and C.7-3), are modified to match the target study."
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1573 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1574 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1575 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1576 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1577 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1578 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1579 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1580 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1581 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1582 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1583 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1584 Resources:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1585 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1586 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1587 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1588 description: Resources gives the list of source studies or source series that are to be merged into the target study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1589 KeepSource:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1590 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1591 description: KeepSource (Boolean value), if set to true, instructs Orthanc to keep the source studies and series. By default, the original resources are deleted from Orthanc.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1592 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1593 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1594 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1595 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1596 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1597 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1598 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1599 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1600 example: {"Resources":["ef2ce55f-9342856a-aee23907-2667e859-9f3b734d"]}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1601 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1602 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1603 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1604
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1605 /jobs:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1606 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1607 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1608 description: The list of all jobs can be retrieved as follows.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1609 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1610 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1611 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1612 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1613 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1614 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1615 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1616 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1617 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1618 example: [ "e0d12aac-47eb-454f-bb7f-9857931e2904" ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1619
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1620 /jobs/{Id}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1621 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1622 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1623 description: The list of all jobs can be retrieved as follows.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1624 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1625 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1626 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1627 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1628 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1629 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1630 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1631 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1632 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1633 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1634 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1635 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1636 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1637 CompletionTime:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1638 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1639 Content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1640 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1641 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1642 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1643 Description:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1644 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1645 InstanceCount:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1646 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1647 UncompressedSizeMB:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1648 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1649 CreationTime:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1650 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1651 EffectiveRuntime:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1652 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1653 ErrorCode:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1654 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1655 ErrorDescription:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1656 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1657 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1658 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1659 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1660 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1661 Progress:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1662 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1663 State:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1664 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1665 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1666 - Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1667 - Failure
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1668 - Pending
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1669 - Running
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1670 - Paused
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1671 - Retry
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1672 Timestamp:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1673 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1674 Type:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1675 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1676 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1677 "CompletionTime" : "20190306T095223.753851",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1678 "Content" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1679 "Description" : "REST API",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1680 "InstancesCount" : 1,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1681 "UncompressedSizeMB" : 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1682 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1683 "CreationTime" : "20190306T095223.750666",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1684 "EffectiveRuntime" : 0.001,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1685 "ErrorCode" : 0,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1686 "ErrorDescription" : "Success",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1687 "ID" : "e0d12aac-47eb-454f-bb7f-9857931e2904",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1688 "Priority" : 0,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1689 "Progress" : 100,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1690 "State" : "Success",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1691 "Timestamp" : "20190306T095408.556082",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1692 "Type" : "Archive"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1693 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1694 /jobs/{Id}/cancel:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1695 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1696 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1697 description: Cancel the job
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1698 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1699 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1700 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1701 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1702 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1703 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1704 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1705 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1706 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1707 /jobs/{Id}/pause:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1708 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1709 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1710 description: Pause the job
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1711 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1712 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1713 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1714 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1715 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1716 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1717 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1718 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1719 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1720 /jobs/{Id}/resume:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1721 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1722 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1723 description: Resume the job
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1724 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1725 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1726 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1727 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1728 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1729 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1730 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1731 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1732 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1733 /jobs/{Id}/resubmit:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1734 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1735 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1736 description: Retry the job
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1737 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1738 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1739 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1740 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1741 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1742 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1743 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1744 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1745 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1746
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1747 /tools/create-dicom:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1748 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1749 tags: [PDF]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1750 description: The /tools/create-dicom URI can be used to upload a PDF file to Orthanc. You can retrieve the PDF from the instance using /instances/{Id}/pdf.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1751 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1752 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1753 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1754 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1755 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1756 Tags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1757 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1758 PatientName:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1759 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1760 Modality:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1761 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1762 Content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1763 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1764 pattern: 'data:application/pdf;base64,.*'
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1765 description: Base 64 encoded bytes of the PDF to store.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1766 example: {"Tags" : {"PatientName" : "Benjamino", "Modality" : "CT"},"Content" : "data:application/pdf;base64,<base64contentsofpdf>"}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1767 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1768 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1769 description: The ID of the new DICOM instance is returned.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1770 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1771 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1772 example: "e0d12aac-47eb-454f-bb7f-9857931e2904"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1773
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1774 /tools/metrics-prometheus:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1775 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1776 tags: [Prometheus Metrics]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1777 description: Orthanc publishes its metrics according to the text-based format of Prometheus (check also the OpenMetrics project), onto the /tools/metrics-prometheus URI of the REST API.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1778 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1779 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1780 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1781 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1782 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1783 example: |
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1784 orthanc_count_instances 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1785 orthanc_count_patients 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1786 orthanc_count_series 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1787 orthanc_count_studies 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1788 orthanc_disk_size_mb 0.0135002136 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1789 orthanc_jobs_completed 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1790 orthanc_jobs_failed 0 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1791 orthanc_jobs_pending 0 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1792 orthanc_jobs_running 0 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1793 orthanc_jobs_success 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1794 orthanc_rest_api_active_requests 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1795 orthanc_rest_api_duration_ms 0 1551868094265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1796 orthanc_storage_create_duration_ms 0 1551865919315
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1797 orthanc_storage_read_duration_ms 0 1551865943752
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1798 orthanc_store_dicom_duration_ms 5 1551865919319
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1799 orthanc_uncompressed_size_mb 0.0135002136 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1800
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1801 /tools/metrics:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1802 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1803 tags: [Prometheus Metrics]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1804 description: Get the enablement state of the metrics gathering.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1805 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1806 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1807 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1808 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1809 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1810 example: "1"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1811 put:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1812 tags: [Prometheus Metrics]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1813 description: Set the enablement state of the metrics gathering.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1814 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1815 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1816 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1817 example: "1"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1818 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1819 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1820 description: Success