-
Notifications
You must be signed in to change notification settings - Fork 9
/
swagger.yaml
418 lines (404 loc) · 13.1 KB
/
swagger.yaml
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
swagger: "2.0"
info:
description: >
<h2>Authentication</h2>
This server uses auth0.com for authentication.
<h2>Web Sockets</h2>
This server uses [socket.io](https://socket.io/) to communicate in real-time between the client and the server when performing lengthy requests, such as in the export process.
Each interaction is a type of "message" sent to the client from the server. The message is a JSON object that has the following properties:
**packageId**: The id of the package in which the status message is intended for; in case the same client has requested multiple exports simultaneously - which is not advised.
**status**: The status of the export (ex: "progress", "error", "complete")
**message**: A message associated with the status that should be displayed to the user or logged
version: "1.0.0"
title: "Trfiolia-on-FHIR"
contact:
email: "sean.mcilvenna@lantanagroup.com"
externalDocs:
description: "The latest FHIR documentation is located here"
url: "http://build.fhir.org"
host: "##host##"
basePath: "/api"
schemes:
- "##scheme##"
securityDefinitions:
auth0:
type: oauth2
flow: authorizationCode
authorizationUrl: https://trifolia.auth0.com/authorize
tokenUrl: https://trifolia.auth0.com/oauth/token
scopes: {}
parameters:
fhirserver:
name: "fhirserver"
in: header
description: "The ID of the configured FHIR server to use for the request. Defaults to the first server in the list of fhir servers as returned by the /config endpoint."
required: false
schema:
type: string
components:
responses:
Unauthorized:
description: The request is not authorized
##swagger-definitions.yaml##
paths:
/config:
get:
summary: "Gets configuration information for this installation of the Trifolia-on-FHIR server. This includes a list of the FHIR servers that be used with the 'fhirserver' header."
tags:
- Config
responses:
200:
application/json:
/config/fhir:
get:
summary: "Gets the /metadata fhirResources for the FHIR server specified by the 'fhirserver' header."
tags:
- Config
responses:
200:
application/json:
/export/{implementationGuideId}:
post:
summary: requests that a new export be produced
security:
- auth0: []
tags:
- Export
parameters:
- $ref: '#/parameters/fhirserver'
- name: implementationGuideId
in: path
description: ImplementationGuide.id
required: true
schema:
type: string
- name: exportFormat
in: query
description: "The type of export to produce (ex: bundle vs. ig publisher). 1 = bundle, 2 = ig publisher"
required: true
schema:
type: number
- name: _format
in: query
description: "The format that the resource(s) in the export. Can be either 'application/xml' or 'application/json'. Defaults to 'application/json'."
schema:
type: string
example: application/json
- name: executeIgPublisher
in: query
description: "*Only applies to ig publisher package exports (exportFormat = 2)*. Indicates whether to execute the IG publisher against the prepared package prior."
schema:
type: boolean
- name: useTerminologyServer
in: query
description: "*Only applies to ig publisher package exports (exportFormat = 2)*. Indicates whether to use the terminology server when executing the ig publisher."
schema:
type: boolean
- name: downloadOutput
in: query
description: "*Only applies to ig publisher package exports (exportFormat = 2)*. Indicates that you want to download the package after it is prepared. This ensures that the output is saved until the GET /export method is called for the package. Otherwise, the output/content is immediately published to the /igs location within ToF and the temporary files used to perform the export are immediately deleted."
schema:
type: boolean
- name: useLatest
in: query
description: "*Only applies to ig publisher package exports (exportFormat = 2)*. Indicates that the export should be executed using the latest version of the IG publisher from build.fhir.org."
schema:
type: boolean
responses:
'200-a':
description: When the request is to produce a bundle, the response content is a file download of the .xml or .json bundle
content:
application/octet-stream:
schema:
type: string
format: binary
headers:
Content-Disposition:
schema:
type: string
description: attachment; filename=ig-bundle.XXX
'200-b':
description: When the request is to produce an IG Publisher package, the response is a package id that can be used with a sockets connection to the server. The sockets connection reports the status of the export as it is being prepared, and reports the status using the package id in this response.
content:
application/json:
schema:
type: string
/export/{packageId}:
get:
summary: "Retrieves an export package requested using the packageId returned by the POST operation."
tags:
- Export
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
- name: packageId
in: path
required: true
description: "The ID of the package. This ID is provided by the POST response."
responses:
'200':
description: "If the package has been successfully produced by the POST export request, this response is a file download representing the prepared ig publisher package (in the form of a zip file)"
content:
application/octet-stream:
schema:
type: string
format: binary
headers:
Content-Disposition:
schema:
type: string
description: attachment; filename=ig-bundle.zip
/import:
post:
tags:
- Import
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
/import/phinVads:
get:
summary: "TODO: Not yet implemented"
tags:
- Import
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
- name: queryText
description: "Text that should be use to search phin vads for a value set"
in: query
schema:
type: string
post:
summary: "TODO: Not yet implemented"
tags:
- Import
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
/import/excelValueSet:
post:
tags:
- Import
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
/import/vsac/{resourceType}/{id}:
get:
tags:
- Import
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
- name: vsacauthorization
description: "The authorization header to use when making a VSAC request"
in: header
schema:
type: string
- name: id
description: "The OID of the value set to import from vsac"
in: path
schema:
type: string
- name: resourceType
description: "The type of resource to get from VSAC's FHIR API"
in: path
schema:
type: string
- name: id
description: "The id of the resource to import from VSAC's FHIR API"
in: path
schema:
type: string
/fhir:
get:
summary: "Proxy to underlying FHIR server. All query parameters, path, etc. are redirected to FHIR server specified by the 'fhirserver' header."
tags:
- FHIR Proxy
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
/fhir/{resourceType}/{id}/$change-id:
post:
summary: 'A custom operation to change the id of a resource on the FHIR server'
tags:
- Custom FHIR Operations
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
- name: resourceType
description: 'The type of the FHIR resource'
in: path
schema:
type: string
example: DiagnosticReport
- name: id
description: 'The current ID of the resource that is going to be changed'
in: path
- name: newId
description: 'The new ID of the resource'
in: query
#
# AUDIT EVENT
#
/auditEvent:
get:
summary: "Retrieves all audit events from the FHIR server"
tags:
- Audit
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
responses:
'200':
description: "Success"
type: array
items:
$ref: '#/definitions/AuditEvent'
'401':
$ref: '#/components/responses/Unauthorized'
post:
summary: "Creates a new audit event"
tags:
- Audit
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
responses:
'200':
description: "Success"
'401':
$ref: '#/components/responses/Unauthorized'
/auditEvent/{id}:
get:
summary: "Retrieves the details of a particular audit event"
tags:
- Audit
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: "Success"
schema:
$ref: '#/definitions/AuditEvent'
'401':
$ref: '#/components/responses/Unauthorized'
#
# BINARY
#
/binary:
get:
summary: "Retrieves Binary resources from the FHIR server. Supports any query parameters supported by the FHIR server. See http://build.fhir.org/binary.html#search for possible query parameters."
descriptions:
tags:
- Binary
security:
- auth0: []
responses:
'200':
description: "Success"
type: array
items:
$ref: '#/definitions/Binary'
'401':
$ref: '#/components/responses/Unauthorized'
parameters:
- $ref: '#/parameters/fhirserver'
post:
summary: "Creates a new Binary resource on the FHIR server"
tags:
- Binary
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
- in: body
required: true
schema:
$ref: '#/definitions/Binary'
responses:
'200':
description: "Success. Binary resource is returned with the generated ID."
schema:
$ref: '#/definitions/Binary'
'401':
$ref: '#/components/responses/Unauthorized'
/binary/{id}:
get:
summary: "Retrieves a specific Binary resource by ID from the FHIR server"
tags:
- Binary
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
- in: path
name: id
required: true
description: "The ID of the resource to retrieve"
type: string
responses:
'200':
description: "Success"
schema:
$ref: '#/definitions/Binary'
'401':
$ref: '#/components/responses/Unauthorized'
put:
summary: "Updates a specific Binary resource or creates a Binary resource with a specific ID if it does not already exist (assuming the underlying FHIR server supports it)"
tags:
- Binary
security:
- auth0: []
parameters:
- $ref: '#/parameters/fhirserver'
- in: path
name: id
required: true
description: "The ID of the resource to update or create"
type: string
- in: body
description: "The Binary resource to create/update the server with"
required: true
schema:
$ref: '#/definitions/Binary'
responses:
'200':
description: "Success. The Binary resource was updated."
schema:
$ref: '#/definitions/Binary'
'401':
$ref: '#/components/responses/Unauthorized'
delete:
summary: "Deletes a specific Binary resource by ID from the FHIR server"
tags:
- Binary
security:
- auth0: []
parameters:
- in: path
name: id
required: true
description: "The ID of the resource to delete"
type: string
responses:
'200':
description: 'Success. Binary resource was deleted.'
'401':
$ref: '#/components/responses/Unauthorized'