This repository has been archived by the owner on Apr 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 22
/
openapi.yaml
964 lines (963 loc) · 26.3 KB
/
openapi.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
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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
openapi: 3.0.0
info:
title: FHIR Works on AWS
description: This is an implementation of FHIR Works on AWS interface
contact:
email: fhir-works-on-aws-dev@amazon.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0
tags:
- name: authorization
description: Calls to authorize the request
- name: bundle
description: Operations to handle bundle requests
- name: history
description: Operations to search non-active FHIR resources
- name: search
description: Operations to search active FHIR resources
- name: persistence
description: Operations for CRUD like behaviors on FHIR resources
paths:
/authz:
post:
tags:
- authorization
summary: Authorizes if user can perform the action
operationId: isAuthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationRequest'
responses:
'204':
description: Access granted
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/authz/bundle:
post:
tags:
- authorization
summary: Authorizes if all elements of a Bundle transactions are authorized
operationId: isBundleAuthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationBundleRequest'
responses:
'204':
description: Access granted
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/bundle/batch:
post:
tags:
- bundle
summary: Process a batch of requests
description: Process a batch of requests that are not dependent on each other
operationId: batch
requestBody:
description: Inventory item to add
content:
application/json:
schema:
$ref: '#/components/schemas/BatchRequest'
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BundleResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/bundle/transaction:
post:
tags:
- bundle
summary: authorize Bundle transactions
description: Used to authorize Bundle transactions
operationId: transaction
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionRequest'
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BundleResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/history/{resourceType}/{id}:
get:
tags:
- history
summary: Search the history of a single FHIR resource instance
description: Search the history of a single FHIR resource instance
operationId: instanceHistory
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not found
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/history/{resourceType}:
get:
tags:
- history
summary: Search the history of a single FHIR resource type
description: Search the history of a single FHIR resource type
operationId: typeHistory
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/history:
get:
tags:
- history
summary: Searches all historical resources in the FHIR server
description: Searches all historical resources in the FHIR server
operationId: globalHistory
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/search/{resourceType}:
get:
tags:
- search
summary: Search across a single FHIR resource type
description: Search across a single FHIR resource type
operationId: typeSearch
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/search:
get:
tags:
- search
summary: Searches all resources in the FHIR server
description: Searches all resources in the FHIR server
operationId: globalSearch
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/persistence/{resourceType}:
post:
tags:
- persistence
summary: create a new FHIR resource
operationId: createResource
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceCreateRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/persistence/{resourceType}/{id}:
get:
tags:
- persistence
summary: read a new FHIR resource
operationId: readResource
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
responses:
'200':
description: Found
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'404':
description: Resource not found
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- persistence
summary: update a new FHIR resource
operationId: updateResource
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUpdateRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not found
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- persistence
summary: delete a FHIR resource
operationId: deleteResource
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
responses:
'204':
description: Deleted
'404':
description: Resource not found
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
patch:
tags:
- persistence
summary: patch a new FHIR resource
operationId: patchResource
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUpdateRequest'
responses:
'200':
description: Patched
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not found
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/persistence/{resourceType}/{id}/{vid}:
get:
tags:
- persistence
summary: read a new FHIR resource
operationId: vReadResource
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
- name: vid
in: path
required: true
style: simple
explode: false
schema:
type: string
example: '1'
responses:
'200':
description: Found
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/persistence/conditional/{resourceType}:
post:
tags:
- persistence
summary: conditionally create a new FHIR resource
operationId: conditionalCreateResource
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConditionalResourceRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/persistence/conditional/{resourceType}/{id}:
put:
tags:
- persistence
summary: conditionally update a new FHIR resource
operationId: conditionalUpdateResource
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConditionalResourceRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- persistence
summary: conditionally delete a FHIR resource
operationId: conditionalDeleteResource
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
responses:
'204':
description: Deleted
'404':
description: Resource not found
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
patch:
tags:
- persistence
summary: conditionally patch a FHIR resource
operationId: conditionalPatchResource
parameters:
- name: resourceType
in: path
required: true
style: simple
explode: false
schema:
type: string
example: Patient
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConditionalResourceRequest'
responses:
'200':
description: Patched
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
'400':
description: Request invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
AuthorizationRequest:
required:
- accessToken
- operation
properties:
acessToken:
type: string
example: eyJhbGciOUz9.eyJzdWxMjMQ.SflMeKKF2QT
operation:
type: string
example: create
resourceType:
type: string
example: Patient
id:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
vid:
type: string
example: '1'
description: Request to authorize the user based on what they are trying to
do
AuthorizationBundleRequest:
required:
- accessToken
- requests
properties:
acessToken:
type: string
example: eyJhbGciOUz9.eyJzdWxMjMQ.SflMeKKF2QT
requests:
type: array
items:
$ref: '#/components/schemas/BatchReadWriteRequest'
description: Request to authorize the user based on all the things this bundle
is trying to do
ErrorResponse:
required:
- message
properties:
message:
type: string
example: Could not find entry
description: Response when errors occur
BundleResponse:
required:
- batchReadWriteResponses
- requests
properties:
batchReadWriteResponses:
type: array
items:
$ref: '#/components/schemas/BatchReadWriteResponse'
description: Response for Bundle interactions
BatchRequest:
required:
- requests
- startTime
properties:
startTime:
type: string
format: date-time
example: 2017-07-21T17:32:28Z
requests:
type: array
items:
$ref: '#/components/schemas/BatchReadWriteRequest'
description: Request to process many operations that are independent of each
other
TransactionRequest:
required:
- requests
- startTime
properties:
startTime:
type: string
format: date-time
example: 2017-07-21T17:32:28Z
requests:
type: array
items:
$ref: '#/components/schemas/BatchReadWriteRequest'
description: Request to process many operations that are dependent of each other
BatchReadWriteRequest:
required:
- id
- operation
- resource
- resourceType
properties:
operation:
type: string
example: create
resourceType:
type: string
example: Patient
id:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
resource:
type: object
vid:
type: string
example: '1'
fullUrl:
type: string
format: url
example: https://www.acme-corp.com/Patient/1234
references:
type: array
items:
$ref: '#/components/schemas/Reference'
description: A single request representing a Bundle entry
BatchReadWriteResponse:
required:
- operation
- resource
properties:
operation:
type: string
example: create
resourceType:
type: string
example: Patient
id:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
resource:
type: object
vid:
type: string
example: '1'
description: A single response correlating to a single a Bundle entry
GenericResponse:
required:
- resource
properties:
resource:
type: object
additionalProperties: true
properties:
id:
type: string
description: 'Unique id of the created resource'
resourceType:
type: string
description: A generic response for a successful operation. Response should include the full resource along with a required id field for the resource.
Reference:
required:
- id
- referenceFullUrl
- referencePath
- resourceType
- rootUrl
- vid
properties:
resourceType:
type: string
example: Patient
id:
type: string
format: uuid
example: fd8bcf46-ea06-4f9f-af5b-b62f68702d6d
vid:
type: string
example: '1'
rootUrl:
type: string
format: url
example: https://www.test-FHIR.com/
referenceFullUrl:
type: string
format: url
example: https://www.test-FHIR.com/Patient/123
referencePath:
type: string
description: Where to find the reference in the Bundle entry
example: provider.reference
description: A connection between entries in a Bundle
ResourceCreateRequest:
required:
- resourceType
type: object
additionalProperties: true
properties:
resourceType:
type: string
ResourceUpdateRequest:
required:
- id
- resourceType
type: object
additionalProperties: true
properties:
id:
type: string
resourceType:
type: string
ConditionalResourceRequest:
properties:
resource:
type: object
query:
type: object