-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathtesttreiber_fdv.yaml
2228 lines (2228 loc) · 83.8 KB
/
testtreiber_fdv.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
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Testtreiber ePA-Frontend des Versicherten
description: REST Schnittstelle einer Test-App fuer das ePA-Modul FdV
version: 2.7.1
contact:
name: gematik GmbH
email: [email protected]
url: 'https://www.gematik.de'
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0'
servers:
- url: 'https://localhost:9107/'
paths:
/login:
post:
tags:
- user
summary: Login Aktensession
description: 'Diese Operation führt ein explizites Login für ein Aktenkonto mit dem RecordIdenfier für insurantId aus. Für die Verwendung einer eGK können die zu verwendende PIN sowie die CAN (für NFC) übergeben werden. Für die Verwendung einer alvi-Identität kann der zu verwendende Authentisierungstoken übergeben werden. Falls die insurantID übergeben wird, dann referenziert die insurantID die AUT-identität des Nutzers, welche über eine eGK oder einen Signaturdienst (Konfigurationsparameter UseEGK) verfügbar ist. Falls keine insurantID übergeben wird, dann wird eine PKCS12-Datei übergeben. Das C.CH.AUT Zertifikat und der private Schlüssel aus der PKCS12-Datei werden im Testtreiber genutzt (bspw. Signatur bei der Authentisierung und der Schlüsselerzeugung mit SGD).'
operationId: login_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ProtocolResponseDTO'
/logout:
post:
tags:
- user
summary: Logout Aktensession
description: Diese Operation führt ein Logout für eine mit insurantId identifizierte Aktensession aus.
operationId: logout_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/storeDocuments:
post:
tags:
- 'documents, folders, submissionsets, associations'
summary: Dokumente in ein Aktenkonto laden
description: Diese Operation führt den Anwendungsfall "Dokumente einstellen" in einer mit insurantId identifizierten Aktensession aus.
operationId: storeDocuments_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StoreDocumentRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/findObjects:
post:
tags:
- 'documents, folders, submissionsets, associations'
summary: 'Dokumente, Ordner, Submission Sets und/oder Verknüpfungen in einem Aktenkonto finden'
description: 'Diese Operation führt den Anwendungsfall "Dokumente / Ordner suchen" in einer mit insurantId identifizierten Aktensession aus. Die Parameter returnType (Werte sind „LeafClass“ oder „ObjectRef“), startIndex und maxResults werden zum Gruppieren der Ergebnisse für das Blättern verwendet. Die für die Suchoperation zu verwendende Stored Query wird durch den Parameter vorgegeben. Falls dieser nicht angegeben ist, muss eine geeignete Stored Query gewählt werden. Wenn die Suchparameter ein SubmissionSet adressieren, dann soll der Response die Metadaten der im SubmissionSet enthaltenen Dokumente (unter Beachtung ggf. zusätzlich angegebenener Suchkriterien zu Dokumenten) beinhalten. Die Response enthält Metadaten zu Dokumenten aber nicht die Dokumente selbst.'
operationId: findObjects_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FindObjectsRequestDTO'
examples:
example-1:
value:
account:
account: stringstri
insurantId: stringstri
pkcs12: ''
passwordPrivateKey: string
passwordKeyStore: string
pin: 0
can: string
token: string
queryMetadata:
XDSSubmissionSetEntryUUID:
- string
XDSSubmissionSetUniqueId:
- string
XDSSubmissionSetSubmissionTimeFrom: '2017-07-21T17:32:28Z'
XDSSubmissionSetSubmissionTimeTo: '2017-07-21T17:32:28Z'
XDSDocumentEntryEntryUUID:
- string
XDSDocumentEntryUniqueId:
- string
XDSDocumentEntryClassCode:
- string
XDSDocumentEntryPracticeSettingCode:
- string
XDSDocumentEntryCreationTimeFrom: '2017-07-21T17:32:28Z'
XDSDocumentEntryCreationTimeTo: '2017-07-21T17:32:28Z'
XDSDocumentEntryServiceStartTimeFrom: '2017-07-21T17:32:28Z'
XDSDocumentEntryServiceStartTimeTo: '2017-07-21T17:32:28Z'
XDSDocumentEntryServiceStopTimeFrom: '2017-07-21T17:32:28Z'
XDSDocumentEntryServiceStopTimeTo: '2017-07-21T17:32:28Z'
XDSDocumentEntryHealthcareFacilityTypeCode:
- string
XDSDocumentEntryEventCodeList:
- string
XDSDocumentEntryConfidentialityCode:
- string
XDSDocumentEntryAuthorPerson:
- string
XDSDocumentEntryFormatCode:
- string
XDSDocumentEntryTypeCode:
- string
XDSDocumentEntryTitle:
- string
XDSDocumentEntryAuthorInstitution:
- string
XDSDocumentEntryStatus: string
XDSFolderUniqueId: string
XDSFolderStatus: string
XDSFolderCodeList:
- string
XDSFolderLastUpdateTimeFrom: '2017-07-21T17:32:28Z'
XDSFolderLastUpdateTimeTo: '2017-07-21T17:32:28Z'
XDSFolderEntryUUID: string
query: FindDocuments
returnType: LeafClass
description: ''
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/FindObjectsResponseDTO'
examples:
example-1:
value:
success: true
statusMessage: string
registryObjectLists:
submissionSetsMetadata:
- author:
identifier: '165746304'
familyName: Weber
givenName: Thilo
otherName: string
nameAffix: string
title: Dr.
authorInstitution:
- name: string
identifier: string
authorRole:
- string
authorSpecialty:
- string
authorTelecommunication:
- string
comments: string
contentTypeCode: string
submissionTime: '2017-07-21T17:32:28Z'
entryUUID: string
uniqueId: string
documentsMetadata:
- author:
- identifier: '165746304'
familyName: Weber
givenName: Thilo
otherName: string
nameAffix: string
title: Dr.
authorInstitution:
- name: string
identifier: string
authorRole:
- string
authorSpecialty:
- string
authorTelecommunication:
- string
availabilityStatus: string
confidentialityCode:
- string
classCode: string
comments: string
creationTime: '2017-07-21T17:32:28Z'
entryUUID: string
eventCodeList:
- string
formatCode: string
hash: string
healthcareFacilityTypeCode: string
languageCode: string
legalAuthenticator: string
mimeType: application/pdf
practiceSettingCode: string
referenceIdList:
- string
serviceStartTime: '2017-07-21T17:32:28Z'
serviceStopTime: '2017-07-21T17:32:28Z'
size: 0
title: string
typeCode: string
uniqueId: string
uri: string
foldersMetadata:
- comments: string
codeList:
- string
lastUpdateTime: '2017-07-21T17:32:28Z'
title: string
uniqueId: string
entryUUID: Folder-1
availabilityStatus: 'urn:oasis:names:tc:ebxml-regrep:StatusType:Approved, Approved'
associations:
- id: 'urn:uuid:7804b22f-7400-4fd7-a4de-d6a5cdd8352d'
associationType: HasMember
sourceObject: 'urn:uuid:32ec5972-a5a3-4dab-8322-e46c56656d70'
targetObject: 'urn:uuid:3277f905-6550-4160-bd3b-c8e4fdc70611'
/retrieveDocuments:
post:
tags:
- 'documents, folders, submissionsets, associations'
summary: Dokumente aus Aktenkonto herunterladen
description: Diese Operation führt den Anwendungsfall "Dokumente herunterladen" in einer mit insurantId identifizierten Aktensession aus. Lädt die Dokumente mit den im Request angegebenen Ids aus dem Aktenkonto. Die Ids werden mittels findDocuments ermittelt.
operationId: retrieveDocuments_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentsRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveDocumentsResponseDTO'
/deleteObjects:
post:
tags:
- 'documents, folders, submissionsets, associations'
summary: 'Dokumente, Ordner aus dem Aktenkonto löschen'
description: 'Diese Operation führt den Anwendungsfall "Dokumente löschen" in einer mit insurantId identifizierten Aktensession aus. löscht die Dokumente, Ordner oder mit dem im Request angegebenen Ids aus dem Aktenkonto. Die Ids werden mittels findDocuments ermittelt.'
operationId: deleteObjects_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/findHcpos:
post:
tags:
- directory
summary: Suche nach Leistungserbringerinstitutionen im Verzeichnisdienst
description: Diese Operation führt eine Suchanfrage für Leistungserbringerinstitutionen im Verzeichnisdienst der TI in einer mit insurantId identifizierten Aktensession aus.
operationId: findHcpos_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FindDirectoryRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/FindDirectoryResponseDTO'
/findInsurances:
post:
tags:
- directory
summary: Suche nach Kostenträgern im Verzeichnisdienst
description: Diese Operation führt eine Suchanfrage für Kostenträger im Verzeichnisdienst der TI in einer mit insurantId identifizierten Aktensession aus.
operationId: findInsurances_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FindDirectoryRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/FindDirectoryResponseDTO'
/permissions:
get:
tags:
- permissions
summary: Alle Berechtigungen lesen
description: Diese Operation führt den Anwendungsfall "Vergebene Berechtigungen auflisten" in einer mit insurantId identifizierten Aktensession aus.
operationId: getPermissions_1
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsResponseDTO'
/permissionsForDocument:
post:
tags:
- permissions
summary: Anzeige der auf ein Dokument berechtigten LEI
description: 'Diese Operation führt den Anwendungsfall "Vergebene Berechtigungen eines Dokuments auflisten" in einer mit insurantId identifizierten Aktensession aus. Der Nutzer erhält Informationen darüber, welche Leistungserbringerinstitutionen auf das Dokument Zugriff haben.'
operationId: getDocAuthorized_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsResponseDTO'
/permissionHcpo/add:
post:
tags:
- permissions
summary: Berechtigung für LEI erteilen
description: Diese Operation führt den Anwendungsfall "Berechtigung für LEI vergeben" in einer mit insurantId identifizierten Aktensession aus.
operationId: permissionHcpo_add
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionHcpoDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
parameters: []
/permissionHcpo/update:
post:
tags:
- permissions
summary: Berechtigung für eine LEI ändern
description: |-
Diese Operation führt den Anwendungsfall "Berechtigung für LEI ändern" in einer mit insurantId identifizierten Aktensession aus. Die Policy für eine, bereits berechtigte Identität wird wie folgt geändert:
1. nur Abschnitte (bezogen auf eine RuleId, z.b. blacklist), die auch im Request angegeben werden , werden in der vorhandenen Policy überschrieben.
2. andere eventuell vorhandene Abschnitte (z.b. lei-permission bzw Kategorie basierte Berechtigung) bleiben unverändert
3. die Angabe eines Abschnitts als leere Liste bedeutet das Entfernen dieses Abschnittes aus der Policy bzw der Einträge dieses Abschnittes
operationId: permissionHcpo_update
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionHcpoDTO'
examples:
'permissionAccessCategory wird übergeschrieben, die LEI bekommt auf keine Kategorie ein Leserecht, evtl bereits erteilte feingranulare Berechtigungen bleiben erhalten. Entsprechend ist das Policy Dokument zu erstellen.':
value:
account:
account: K123456789
insurantId: K123456789
pkcs12: ''
passwordPrivateKey: PASSWORD
passwordKeyStore: PASSWORD
hcpoTelematikId: 1-SMC-B-Testkarte-883110000092397
permissionLeiProperties:
validThrough: '2022-07-21'
permissionAccessCategory: []
'permissionAccessCategory wird übergeschrieben, die LEI bekommt ausschließlich auf Kategorie "eab" level "N" ein Leserecht, evtl bereits erteilte feingranulare Berechtigungen bleiben erhalten. Entsprechend ist das Policy Dokument zu erstellen.':
value:
account:
account: K123456789
insurantId: K123456789
pkcs12: ''
passwordPrivateKey: PASSWORD
passwordKeyStore: PASSWORD
hcpoTelematikId: 1-SMC-B-Testkarte-883110000092397
permissionLeiProperties:
validThrough: '2022-07-21'
permissionAccessCategory:
- level: 'N'
category: eab
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
parameters: []
/permissionHcpo/remove:
post:
tags:
- permissions
summary: Berechtigung für eine LEI löschen
description: Diese Operation führt den Anwendungsfall "Berechtigung für LEI löschen" in einer mit insurantId identifizierten Aktensession aus.
operationId: permissionHcpo_remove
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePermissionDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
parameters: []
/permissionRepresentative/add:
post:
tags:
- permissions
summary: Berechtigung für einen Vertreter erteilen
description: Diese Operation führt den Anwendungsfall "Vertretung einrichten" in einer mit insurantId identifizierten Aktensession aus.
operationId: permissionRepresentative_add
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionRepresentativeDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/permissionRepresentative/remove:
post:
tags:
- permissions
summary: Berechtigung für einen Vertreter löschen
description: Diese Operation führt den Anwendungsfall "Berechtigung für Vertreter löschen" in einer mit insurantId identifizierten Aktensession aus.
operationId: permissionRepresentative_remove
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePermissionDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/permissionInsurance/add:
post:
tags:
- permissions
summary: Berechtigung für einen Kostenträger erteilen
description: Diese Operation führt den Anwendungsfall "Berechtigung für Kostenträger vergeben" in einer mit insurantId identifizierten Aktensession aus.
operationId: permissionInsurance_add
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionInsuranceDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/permissionInsurance/remove:
post:
tags:
- permissions
summary: Berechtigung für einen Kostenträger löschen
description: Diese Operation führt den Anwendungsfall "Berechtigung für Kostenträger löschen" in einer mit insurantId identifizierten Aktensession aus.
operationId: permissionInsurance_remove
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePermissionDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/notificationInformation:
post:
tags:
- administration
summary: Benachrichtigungsadresse für Geräteautorisierung aktualisieren
description: Diese Operation führt den Anwendungsfall "Benachrichtigungsadresse für Geräteautorisierung aktualisieren" in einer mit insurantId identifizierte Aktensession aus. Hinterlegt eine Benachrichtigungsadresse für das Aktenkonto.
operationId: putNotificationInformation_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationInformationRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/getNotificationInfoList:
post:
tags:
- administration
summary: Hinterlegte Benachrichtigungsadressen abfragen
description: Diese Operation führt den Anwendungsfall "Benachrichtigungsadresse für Geräteautorisierung abfragen" in einer mit insurantId identifizierte Aktensession aus.
operationId: getNotificationInformation_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetNotificationInformationRequestDTO'
responses:
default:
description: response
content:
application/json:
schema:
$ref: '#/components/schemas/GetNotificationInformationResponseDTO'
/changeProvider:
post:
tags:
- administration
summary: Anbieter wechseln
description: Diese Operation führt den Anwendungsfall "Anbieter wechseln" in einer mit insurantId identifizierten Aktensession aus.
operationId: changeProvider_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeProviderRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/protocol:
post:
tags:
- protocol
summary: Zugriffsprotokolle lesen
description: Diese Operation führt den Anwendungsfall "Zugriffsprotokoll einsehen" in einer mit insurantId identifizierten Aktensession aus. Die vom Aktensystem gelieferten Protokolleinträge werden aufgearbeitet und zurückgegeben. Liefert alle Einträge aus dem §291a und Verwaltungsprotokoll für das Aktenkonto.
operationId: getProtocol_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ProtocolResponseDTO'
/signedProtocol:
post:
tags:
- protocol
summary: Zugriffsprotokolle mit PAdES-Signatur lesen
description: Diese Operation führt den Anwendungsfall "signiertes Zugriffsprotokoll einsehen" in einer mit insurantId identifizierten Aktensession aus. Die vom Aktensystem gelieferten Protokolleinträge werden aufgearbeitet und zurückgegeben. Liefert alle Einträge aus getSignedAuditEvents für das Aktenkonto.
operationId: getSignedProtocol_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/SignedProtocolResponseDTO'
/configuration:
get:
tags:
- configuration
summary: Gesamte Konfiguration lesen
description: 'Die Operation liefert eine Liste aller Konfigurationsparameter des FdV mit den eingestellten Werten. Liefert alle Konfigurationseinträge, die dem Filter entsprechen. Als Filter ist configurationEntryId möglich. Wird kein Filter angegeben, dann werden alle Einträge aus der Konfiguration zurückgegeben.'
operationId: getConfigurationEntries_1
parameters:
- name: uid
in: query
description: Bezeichner eines Konfigurationseintrages (configurationEntryId)
schema:
type: string
responses:
'200':
description: 'successful operation; Es werden alle Konfigurationseinträge zurückgegeben.; Wenn nach einer uid gesucht wurde, wird genau dieser Eintrag zurückgegeben.; Falls der Konfigurationseintrag vorab nicht gesetzt wurde, wird ein Leerstring zurückgegeben.'
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationEntries'
'400':
description: Invalid ID supplied
content: {}
'404':
description: Entry not found
content: {}
put:
tags:
- configuration
summary: Konfigurationseintrag ändern
description: Diese Operation setzt ein oder mehrere Werte für eine Liste von Konfigurationsparametern sowie für herstellerspezifische Konfigurationsparameter. Die Liste der herstellerspezifischen Konfigurationsparameter sind in der Betriebsdokumentation zu beschreiben.
operationId: updateConfigurationEntries_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationEntry'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/productinformation:
post:
summary: Gibt die Informationen zur Produktinformation zurück
description: Die Operation liefert eine Liste mit den Werten der Produktinformation.
operationId: getProductInformation_1
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseProductInformationDTO'
/ping:
post:
summary: Prüft die Erreichbarkeit der Schnittstelle auf Anwendungsebene
description: 'Ping prüft die Erreichbarkeit der Schnittstelle auf Anwendungsebene. In der Response wird die Schnittstellenversion zurückgegeben, was der Prüfung der Interoberabilität dient.'
operationId: ping_1
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponsePingDTO'
/updateMetadata:
post:
tags:
- 'documents, folders, submissionsets, associations'
summary: 'Aktualisierung der Informationen zu einem Dokument, Ordner des Nutzers oder einer Verknüpfung'
description: Diese Operation führt den Anwendungsfall "Änderung der Vertraulichkeit eines Dokumentes" in einer mit insurantId identifizierten Aktensession aus. Der Nutzer kann die ConfidentialityCode eines Dokumentes ändern.
operationId: updateMetadata_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMetadataRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/updateKeys:
post:
summary: Umschlüsselung durchführen
description: 'Diese Operation führt den Anwendungsfall "Umschlüsselung" in einer mit insurantId identifizierten Aktensession aus. Es werden neue Aktenschlüssel, Kontextschlüssel bzw. Dokumentenschlüssel für den Versicherten, die Berechtigten und die Dokumentenverwaltung erzeugt.'
operationId: updateKeys_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateKeysResponseDTO'
/replaceDocument:
post:
tags:
- 'documents, folders, submissionsets, associations'
summary: Ersetzen eines Dokuments
description: Diese Operation führt den Anwendungsfall "Ersetzen eines Dokumentes" in einer mit insurantId identifizierten Aktensession aus.
operationId: replaceDocument_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReplaceDocumentRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDTO'
/pseudomiseMio:
post:
summary: PseudoAnonymise MIO
operationId: pseudomise-mio
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PseudomiseResponseDTO'
examples:
Beispiel Antwort:
value:
success: true
statusMessage: Operation Completed
documents:
- content: PEJ1bmRsZSB4bWxucz0iaHR0cDovL2hsNy5vcmcvZmhpciI+CiAgICA8aWQgdmFsdWU9IjAwMTU3OGY4LTBiNzYtNDE5Ny1hZmQ5LWQ4MzIyNzUxNmU0NiIgLz4KICAgIDxtZXRhPgogICAgICAgIDxsYXN0VXBkYXRlZCB2YWx1ZT0iMjAxOS0xMi0yNFQxMjozMDowMloiIC8+CiAgICAgICAgPHByb2ZpbGUgdmFsdWU9Imh0dHBzOi8vZmhpci5rYnYuZGUvU3RydWN0dXJlRGVmaW5pdGlvbi9LQlZfUFJfTUlPX1ZhY2NpbmF0aW9uX0J1bmRsZV9FbnRyeXwxLjEuMCIgLz4KICAgIDwvbWV0YT4KPC9CdW5kbGU+
formatCode: 'urn:gematik:ig:Impfausweis:v1.1.0'
description: Operation für die Prüfung der pseudonymisierung der Dokumente
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PseudomiseRequestDTO'
examples:
Beispiel Request:
value:
documents:
- content: PEJ1bmRsZSB4bWxucz0iaHR0cDovL2hsNy5vcmcvZmhpciI+CiAgICA8aWQgdmFsdWU9IjAwMTU3OGY4LTBiNzYtNDE5Ny1hZmQ5LWQ4MzIyNzUxNmU0NiIgLz4KICAgIDxtZXRhPgogICAgICAgIDxsYXN0VXBkYXRlZCB2YWx1ZT0iMjAxOS0xMi0yNFQxMjozMDowMloiIC8+CiAgICAgICAgPHByb2ZpbGUgdmFsdWU9Imh0dHBzOi8vZmhpci5rYnYuZGUvU3RydWN0dXJlRGVmaW5pdGlvbi9LQlZfUFJfTUlPX1ZhY2NpbmF0aW9uX0J1bmRsZV9FbnRyeXwxLjEuMCIgLz4KICAgIDwvbWV0YT4KPC9CdW5kbGU+
formatCode: 'urn:gematik:ig:Impfausweis:v1.1.0'
description: ''
components:
schemas:
ResponseDTO:
type: object
properties:
success:
type: boolean
statusMessage:
type: string
required:
- success
Login:
type: object
description: Eingangsdaten für den Anwendungsfall Login sowie für das implizite Login vor weiteren Anwendungsfällen
properties:
account:
type: string
minLength: 10
maxLength: 10
description: 'referenziert eine Aktensession, in der die Operation ausgeführt werden soll; Wenn keine Aktensession besteht, dann muss für dieses Aktenkonto (entspricht OwnerInsurantId oder RepresentationXInsurantId in der Konfiguration) eine Aktensession eröffnet werden (implizites Login).'
insurantId:
type: string
minLength: 10
maxLength: 10
description: 'Versicherten-ID des Nutzers (Aktenkontoinhaber oder Vertreter) des FdV; Wenn dieser Parameter gesetzt ist, dann wird für die Authentisierung entsprechend dem Konfigurationsparameter useEGK eine angebundene eGK oder der Signaturdienst genutzt.; Wenn dieser Parameter gesetzt ist, dann werden die Parameter pkcs12, passwordPrivateKey und passwordKeyStore ignoriert.'
pkcs12:
type: string
format: byte
description: C.CH.AUT-Zertifikat des Nutzers mit private Key im pkcs12 Format; Aus dem C.CH.AUT-Zertifikat wird die Versicherten-ID des Nutzers (Aktenkontoinhaber oder Vertreter) bestimmt.; Mit dem private Key werden die Signaturen bei der Authentisierung und der Schlüsselerzeugung (SGD) erstellt
passwordPrivateKey:
type: string
description: Passwort für private Key in pkcs12
passwordKeyStore:
type: string
pin:
type: integer
description: Für die Verwendung einer eGK kann die zu verwendende PIN übergeben werden.
can:
type: string
description: Für die Verwendung einer eGK kann die zu verwendende CAN für NFC übergeben werden.
token:
type: string
description: Für die Verwendung einer alvi-Identität kann der zu verwendende Authentisierungstoken übergeben werden.
required:
- account
RequestDTO:
type: object
properties:
account:
$ref: '#/components/schemas/Login'
pageSize:
type: integer
minimum: 1
pageNumber:
type: integer
minimum: 1
lastDay:
type: string
format: date
example: '2021-07-01'
required:
- account
DocumentsRequestDTO:
type: object
properties:
account:
$ref: '#/components/schemas/Login'
documentUniqueIds:
type: array
description: Liste von UniqueIDs von DocumentEntries
items:
type: string
required:
- account
- documentUniqueIds
x-examples: {}
ObjectDTO:
type: object
title: ObjectDTO
properties:
entryUUID:
type: string
description: EntryUUID eines Dokumentes
ObjectRequestDTO:
type: object
properties:
account:
$ref: '#/components/schemas/Login'
objects:
type: array
items:
$ref: '#/components/schemas/ObjectDTO'
required:
- account
- objects
AuthorInstitution:
type: object
description: 'Institution, die dem Autor zugeordnet ist'
properties:
name:
type: string
description: Name der Leistungserbringerinstitution oder Name des Kostenträgers
identifier:
type: string
description: Institutionskennzeichen der Leistungserbringerinstitution oder Betriebsnummer des Kostenträgers
Author:
type: object
description: Inhalte für Metadaten für author; entspricht für ein DocumentEntry dem Autor; entspricht für ein Submission Set der einstellenden Person oder einstellendem System
properties:
identifier:
type: string
description: 'authorPerson, für Leistungserbringer Lebenslange Identifikationsnummer eines Arztes, für Versicherte Versicherten-ID (unveränderliche Teil der KVNR)'
example: '165746304'
familyName:
type: string
description: 'authorPerson, Nachname'
example: Weber
givenName:
type: string
description: 'authorPerson, Vorname'
example: Thilo
otherName:
type: string
description: 'authorPerson, weiterer Vorname'
nameAffix:
type: string
description: 'authorPerson, Nameszusatz'
title:
type: string
description: 'authorPerson, Titel'
example: Dr.
authorInstitution:
type: array
items:
$ref: '#/components/schemas/AuthorInstitution'
authorRole:
type: array
items:
type: string
description: 'Rolle des Autors; ein Code der in [IHE-ITI-VS] definierten Value Sets für DocumentEntry.authorRole. Da hier mehrere Value Sets verwendet werden können, SOLL an dieser Stelle ein Coded String gesetzt werden, bei dem die OID des ValueSets (1.3.6.1.4.1.19376.3.276.1.5.14 oder 1.3.6.1.4.1.19376.3.276.1.5.13) mit angegeben werden muss. Der Coded String muss dem Format von [IHE-ITI-TF Vol3], Kap. 4.2.3.1.7 entsprechen: Code^^^&CodeSystemID&ISO. Vgl. auch ebd. Kap. 4.2.3.1.4.3'
authorSpecialty:
type: array
items:
type: string
description: 'Fachliche Spezialisierung des Autors; ein Code des in [IHE-ITI-VS] definierten Value Sets für DocumentEntry.authorSpecialty oder aus der Tabelle in der Anforderung A_15744-XX'
authorTelecommunication:
type: array
items:
type: string
description: Telekommunikationsdaten des Autors
SubmissionSetMetadata:
type: object
description: Inhalte für Metadaten für ein SubmissionSet
x-examples:
example-1:
author:
identifier: '165746304'
familyName: Weber
givenName: Thilo
otherName: string
nameAffix: string
title: Dr.
authorInstitution:
- name: string
identifier: string
authorRole:
- string
authorSpecialty:
- string
authorTelecommunication:
- string
comments: string
contentTypeCode: string
submissionTime: '2017-07-21T17:32:28Z'
entryUUID: string
uniqueId: string
properties:
author:
$ref: '#/components/schemas/Author'
comments:
type: string
description: Ergänzende Hinweise zum Submission Set in Freitext
contentTypeCode:
type: string
submissionTime:
type: string
format: date-time
description: 'date-time notation as defined by RFC 3339, section 5.6'
example: '2017-07-21T17:32:28Z'
entryUUID:
type: string
description: 'Eindeutige Kennung des Submission Sets, intern'
uniqueId:
type: string
description: 'Eindeutige Kennung des Submission Sets, extern'
title: ''
DocumentWithMetadata:
type: object
properties:
metadata:
$ref: '#/components/schemas/DocumentMetadata'
document:
$ref: '#/components/schemas/Document'
folder_reference:
$ref: '#/components/schemas/FolderReference'
required:
- metadata
- document
x-examples: {}
Document:
type: object
properties:
document:
type: string
format: byte
description: Dokument (Base64 kodiert)
required:
- document
DocumentMetadata:
type: object
description: Metadaten zu einem Dokument
properties:
author:
type: array
items:
$ref: '#/components/schemas/Author'
availabilityStatus:
type: string
description: Status eines Dokumentes
confidentialityCode:
type: array
items:
type: string
description: 'Vertraulichkeitskennzeichnung des Dokuments; N, R oder V des in [IHE-ITI-VS] definierten Value Sets für DocumentEntry.confidentialityCode'
classCode:
type: string
description: 'Grobe Klassifizierung des Dokuments, einem Code des in [IHE-ITI-VS] definierten Value Sets für DocumentEntry.classCode'
comments:
type: string