-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSDC Swagger YAMML
446 lines (446 loc) · 12.1 KB
/
SDC Swagger YAMML
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
swagger: '2.0'
info:
description: |
This is the test of the SDC REST API
[SDC REST API Doc](https://goo.gl/YLo7Fq) and more on SDC at
[http://wiki.ihe.net/index.php/Structured_Data_Capture](http://wiki.ihe.net/index.php/Structured_Data_Capture).
version: 1.0.0
title: IHE Structured Data Capture API
termsOfService: http://swagger.io/terms/
contact:
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
# basePath: /ihe/sdc/v.0.1
tags:
- name: SDC API Test
description: Testing the SDC API
externalDocs:
description: SDC API Doc
url: https://goo.gl/YLo7Fq
# schemes:
# - http
paths:
/manager/formPackage:
post:
tags:
- SDC API Test
summary: Upload submit a form to Form Manager
operationId: insertPackage
consumes:
- application/json
- application/xml
produces:
#- application/json
- application/xml
parameters:
- in: body
name: body
description: The SDC Form Package
required: true
schema:
$ref: '#/definitions/SDCFormPackage'
responses:
405:
description: Invalid input
security:
- SDC_auth:
- write:pets
- read:pets
get:
tags:
- SDC API Test
summary: Retrieves a Form Package
description: Form Filler requests a Form Package from Form Manager
operationId: RetrievePackage
produces:
- application/json
- application/xml
parameters:
- name: _baseURI
in: query
description: The ID that uniquely identifies the author organization
required: false
type: string
- name: _sdcSchemaVersion
in: query
description: The Schema version the Package is using
required: false
type: string
- name: _lineage
in: query
description: Shared ID for all versions of an SDC package
required: false
type: string
- name: _version
in: query
description: The version of the package you wish to retrieve
required: false
type: array
items:
type: string
enum:
#had to change from * to all because * was invalid character
- last
- first
- version_string
default: last
- name: _offset
in: query
description: An integer which can be set to retrieve version prior or later than requested version (e.g. -1 will retrieve version before)
required: false
type: integer
- name: _docType
in: query
description: the type of document being requested
type: array
items:
type: string
enum:
- sdcPKG
- sdcFDF
- sdcDE
default: sdcPKG
collectionFormat: multi
responses:
200:
description: successful operation
schema:
type: array
items:
$ref: '#/definitions/SDCFormPackage'
400:
description: Invalid status value
security:
- SDC_auth:
- write:pets
- read:pets
/manager/formPackage/list:
get:
tags:
- SDC API Test
summary: Retrieves a list of Form Packages
description: Form Filler requests a list of Form Packages from Form Manager
operationId: RetrievePackageList
produces:
- application/json
- application/xml
parameters:
- name: _baseURI
in: query
description: The ID that uniquely identifies the author organization
required: false
type: string
- name: _contentDomain
in: query
description: The specialty the form is related to. contentDomain can be specified as Pathology, Radiology, Surgery, etc
required: false
type: string
#do we want to define this as an Array. Do we have an appropriate value set for this? Ability to submit multiple should be allowed?
- name: _sdcSchemaVersion
in: query
description: The Schema version the Package is using
required: false
type: string
- name: _lineage
in: query
description: Shared ID for all versions of an SDC package
required: false
type: string
- name: _version
in: query
description: The version of the package you wish to retrieve
required: false
type: array
items:
type: string
enum:
- all
#had to change from * to all because * was invalid character
- last
- current
- first
default: last
- name: _offset
in: query
description: An integer which can be set to retrieve version prior or later than requested version (e.g. -1 will retrieve version before)
required: false
type: integer
collectionFormat: multi
- name: status
in: query
description: The current status of the form
required: false
type: string
responses:
200:
description: successful operation
schema:
type: array
items:
$ref: '#/definitions/SDCFormPackageMetaData'
400:
description: Invalid status value
security:
- SDC_auth:
- write:pets
- read:pets
/receiver/responsePackage:
post:
tags:
- SDC API Test
summary: Submit a form to Form Receiver
operationId: submitPackage
consumes:
- application/json
- application/xml
produces:
#- application/json
- application/xml
parameters:
- in: body
name: body
description: The SDC Form Package
required: true
schema:
$ref: '#/definitions/SDCFormPackage'
responses:
405:
description: Invalid input
security:
- SDC_auth:
- write:pets
- read:pets
get:
tags:
- SDC API Test
summary: Retrieves a response package
operationId: retrieveResponsePackage
consumes:
- application/json
- application/xml
produces:
#- application/json
- application/xml
#define parameters
parameters:
- name: _pkgInstanceID
in: query
description: The ID for a particular instance of a package
required: false
type: string
- name: _pkgInstanceVersionID
in: query
description: The ID for a particular version of an instance of a package
required: false
type: string
- name: _baseURI
in: query
description: The ID that uniquely identifies the author organization
required: false
type: string
- name: _fullPkgURI
in: query
description: The full URI of a package, including the baseURI
required: false
type: string
- name: _patientID1
in: query
description: A single ID for a particular patient
required: false
type: string
responses:
405:
description: Invalid input
security:
- SDC_auth:
- write:pets
- read:pets
/receiver/responsePackage/list:
get:
tags:
- SDC API Test
summary: Retrieves a response package list
operationId: retrieveResponsePackagelist
consumes:
- application/json
- application/xml
produces:
#- application/json
- application/xml
#define parameters
parameters:
- name: _baseURI
in: query
description: The ID that uniquely identifies the author organization
required: false
type: string
- name: _contentDomain
in: query
description: The specialty the form is related to. contentDomain can be specified as Pathology, Radiology, Surgery, etc
required: false
type: string
#do we want to define this as an Array. Do we have an appropriate value set for this? Ability to submit multiple should be allowed?
- name: _sdcSchemaVersion
in: query
description: The Schema version the Package is using
required: false
type: string
- name: _lineage
in: query
description: Shared ID for all versions of an SDC package
required: false
type: string
- name: _version
in: query
description: The version of the package you wish to retrieve
required: false
type: array
items:
type: string
enum:
- all
#had to change from * to all because * was invalid character
- last
- current
- first
default: last
- name: _offset
#Do we need offset for
in: query
description: An integer which can be set to retrieve version prior or later than requested version (e.g. -1 will retrieve version before)
required: false
type: integer
collectionFormat: multi
- name: status
in: query
description: The current status of the form
required: false
type: string
responses:
200:
description: successful operation
schema:
type: array
items:
$ref: '#/definitions/SDCFormPackage'
405:
description: Invalid input
security:
- SDC_auth:
- write:pets
- read:pets
securityDefinitions:
#left SDC_auth as petstore example for now
SDC_auth:
type: oauth2
authorizationUrl: http://petstore.swagger.io/oauth/dialog
flow: implicit
scopes:
write:pets: modify pets in your account
read:pets: read your pets
api_key:
type: apiKey
name: api_key
in: header
definitions:
SDCFormPackageMetaData:
type: object
required:
- _baseURI
- _contentDomain
- _formManagerURI
- _sdcSchemaVersion
- _pkgLineage
- _version
- _format
properties:
_baseURI:
type: string
example: www.cap.org/eCC/SDC/IHE
_contentDomain:
type: string
example: test
_formManagerURI:
type: string
example: www.cap.org/eCC/SDC/IHE/FormManager
_sdcSchemaVersion:
type: string
example:
_pkgLineage:
type: string
example: PKG_Adrenal
_version:
type: "array"
xml:
name: "version"
wrapped: true
items:
type: "string"
_format:
type: "string"
enum:
- XML
- JSON
- HTML
- URL
example: XML
xml:
name: SDCFormPackage
SDCFormPackage:
type: object
required:
- _baseURI
- _contentDomain
- _sdcSchemaVersion
- _pkgLineage
- _version
- _offset
properties:
_baseURI:
type: string
example: www.cap.org/eCC/SDC/IHE
_contentDomain:
type: string
example: test
_sdcSchemaVersion:
type: string
example:
_pkgLineage:
type: string
example: PKG_Adrenal
_version:
type: "array"
xml:
name: "version"
wrapped: true
items:
type: "string"
_offset:
type: integer
example: -1
xml:
name: SDCFormPackage
#add ApiResponse when necessary
#ApiResponse:
# type: object
# properties:
# code:
# type: integer
# format: int32
# type:
# type: string
# message:
# type: string
externalDocs:
description: Find out more about Swagger
url: http://swagger.io
# Added by API Auto Mocking Plugin
host: virtserver.swaggerhub.com
#basePath: /IHE-SDC4/ihesdc0/1.0.0
schemes:
- https
- http
# Added by API Auto Mocking Plugin
basePath: /IHE-SDC4/ihesdc0/1.0.0