generated from gematik/spec-TemplateForSimplifierProjects
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathvsdm2.yaml
452 lines (448 loc) · 17.3 KB
/
vsdm2.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
openapi: 3.1.0
info:
title: VSDM2
description: HTTP-based "Versichertenstammdatendienst" (VSDD) interface to request "Versichertenstammdaten" (vsd).
This API document specifies the contract between a vsdm-client ("Primaersystem") and the resource server of the "Versichertenstammdatendienst".
The ressource server ist protected by a proxy component. Details about the interface description of the proxy component can be found (soon) at a separate GitHub project https://github.com/gematik/spec-t20r/tree/develop/src/openapi.
Practitioners software clients "Primaersysteme" can request data about patients by using this interface to support a current treatment.
contact:
name: gematik GmbH
url: 'https://www.gematik.de'
license:
name: Apache 2.0
url: "https://www.apache.org/licenses/LICENSE-2.0"
version: 1.0.0
# Changes in 0.0.1
# - initial version
externalDocs:
description: FHIR Specification VSDM 2
url: https://simplifier.net/vsdm2
servers:
- url: https://101575519.vsdm2.ti-dienste.de
description: TK Production server (PU)
- url: https://109723913.vsdm2.ti-dienste.de
description: BKK VBU Production server (PU)
- url: https://{iknummer}.vsdm2.ti-dienste.de
description: address schema vsdm backends - productive environment
variables:
iknummer:
default: "111111111"
description: Institutional identifier for a specific health insurer.
- url: https://{iknummer}.ref.vsdm2.ti-dienste.de
description: address schema vsdm backends - reference environment
variables:
iknummer:
default: "111111111"
description: Institutional identifier for a specific health insurer.
- url: https://{iknummer}.test.vsdm2.ti-dienste.de
description: address schema vsdm backends - test environment
variables:
iknummer:
default: "111111111"
description: Institutional identifier for a specific health insurer.
- url: https://{iknummer}.dev.vsdm2.ti-dienste.de
description: address schema vsdm backends - development environment
variables:
iknummer:
default: "111111111"
description: Institutional identifier for a specific health insurer.
tags:
- name: Vsdm
description: Endpoint of the application "Versichertenstammdatenmanagement" (VSDM) to retrieve a VSDMBundle FHIR-Resource (Versichertenstammdaten; VSD) of a specific patient.
VSDMBundle contains the VSDMPatient and VSDMCoverage FHIR-Resources.
paths:
/vsdservice/v1/vsdmbundle:
get:
tags:
- Vsdm
summary: Returns a VSDMBundle for the specified patient.
description: Returns a VSDMBundle with VSD about a specific patient that is addressed within the PoPP-Token in the request header.
operationId: getVSDMBundle
security:
- oAuthVsdm: [ vsdservice ]
parameters:
- name: Authorization
in: header
description: OAuth2 Bearer AccessToken granting access to the VSDService-API.
The Access-Token is verified by the HTTP-Proxy component of the "Versichertenstammdatendienst".
The Access-Token is bound via "demonstrating proof of possession" (DPoP) to the requesting client, according to RFC 9449 6.1. JWK Thumbprint Confirmation Method.
schema:
type: string
- name: PoPP
in: header
description: Bearer Token containing proof of patient presence (Versorgungskontextnachweis).
This token represents the proof of an actual encounter between patient and practitioner as a resource access condition.
The HTTP-Proxy verifies the Token and sends the Token-Payload within the custom header "ZETA-PoPP-Token-Content" to the resource server.
The Header contains the "Krankenversichertennummer" (KVNR) as the identifier for the corresponding VSDMBundle instance.
schema:
type: string
- name: DPoP
in: header
description: The DPoP-Header holds the DPoP-JWT to demonstrate possession of a local client key and to bind a local client to his oauth2 AccessToken according to RFC 9449.
The DPoP is verified by the HTTP-Proxy component of the "Versichertenstammdatendienst".
schema:
type: string
- name: If-None-Match
description: Header for conditional resource response
in: header
schema:
type: string
- name: Accept
in: header
description: Specifies the format of the FHIR response requested by a client which could be application/fhir+json or application/fhir+xml.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetVSDMBundleResponse'
headers:
ETag:
$ref: '#/components/parameters/ETag'
VSDM-Pz:
$ref: '#/components/parameters/VSDM-Pz'
'304':
description: Bundle was found but not modified
headers:
ETag:
$ref: '#/components/parameters/ETag'
VSDM-Pz:
$ref: '#/components/parameters/VSDM-Pz'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/VSDMOperationOutcome'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/VSDMOperationOutcome'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/VSDMOperationOutcome'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/VSDMOperationOutcome'
'428':
description: Precondition Required
content:
application/json:
schema:
$ref: '#/components/schemas/VSDMOperationOutcome'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/VSDMOperationOutcome'
'502':
description: Bad Gateway
content:
application/json:
schema:
$ref: '#/components/schemas/VSDMOperationOutcome'
'504':
description: Gateway Timeout
content:
application/json:
schema:
$ref: '#/components/schemas/VSDMOperationOutcome'
components:
parameters:
ETag:
name: ETag
in: header
description: Value according rfc7232 to represent the version of the VSDMBundle.
schema:
type: string
example: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
VSDM-Pz:
name: VSDM-Pz
in: header
description: Base64URL encoded "Pruefziffer"
schema:
type: string
example: VDAyMzU5MDA1MDE3MjY3Mzc2MDFVVDLYyBOm-EDF0oe1aW_ndQe2p36MGAzvyBk
schemas:
GetVSDMBundleResponse:
description: Response including the requested VSDMBundle
type: object
properties:
VSDMBundle:
$ref: '#/components/schemas/VSDMBundle'
VSDMBundle:
type: object
description: 'https://gematik.de/fhir/vsdm2/StructureDefinition/VSDMBundle'
examples:
[
{
"resourceType": "Bundle",
"id": "9b6ac30d-246d-4eab-af83-544564792089",
"meta": {
"profile": [
"https://gematik.de/fhir/vsdm2/StructureDefinition/VSDMBundle"
]
},
"type": "document",
"identifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:9b6ac30d-246d-4eab-af83-544564792089"
},
"signature": {
"sigFormat": "application/pkcs7-mime",
"who": {
"identifier": {
"system": "https://fhir.de/sid/arge-ik/iknr",
"value": "12345678"
}
},
"type": [
{
"system": "urn:iso-astm:E1762-95:2013",
"code": "1.2.840.10065.1.12.1.7",
"display": "Consent Signature"
}
],
"when": "2023-11-03T12:02:23.157+01:00",
"data": "dGhpcyBibG9iIGlzIHNuaXBwZWQ="
},
"timestamp": "2023-11-03T12:02:23.157+01:00",
"entry": [
{
"fullUrl": "https://gematik.de/fhir/Composition/c624cf47-e235-4624-af71-0a09dc9254dc",
"resource": {
"resourceType": "Composition",
"id": "c624cf47-e235-4624-af71-0a09dc9254dc",
"meta": {
"profile": [
"https://gematik.de/fhir/vsdm2/StructureDefinition/VSDMComposition"
]
},
"status": "final",
"author": [
{
"identifier": {
"system": "https://fhir.de/sid/arge-ik/iknr",
"value": "12345678"
}
}
],
"type": {
"coding": [
{
"code": "not-applicable",
"system": "https://terminology.hl7.org/CodeSystem/data-absent-reason"
}
]
},
"date": "2023-11-03T12:02:23.157+01:00",
"title": "VSDM 2 data",
"section": [
{
"entry": [
{
"reference": "Patient/437f2555-2396-4c64-a656-e9553161ca3c"
}
]
},
{
"entry": [
{
"reference": "Coverage/2d4da53a-413a-48fe-b908-2e67b5761523"
}
]
}
]
}
},
{
"fullUrl": "https://gematik.de/fhir/Patient/437f2555-2396-4c64-a656-e9553161ca3c",
"resource": {
"resourceType": "Patient",
"id": "437f2555-2396-4c64-a656-e9553161ca3c",
"meta": {
"profile": [
"https://gematik.de/fhir/vsdm2/StructureDefinition/VSDMPatient"
]
},
"name": [
{
"use": "official",
"family": "Königstein",
"_family": {
"extension": [
{
"url": "https://hl7.org/fhir/StructureDefinition/humanname-own-name",
"valueString": "Königstein"
}
]
},
"given": [
"Ludger"
]
}
],
"identifier": [
{
"system": "https://fhir.de/sid/gkv/kvid-10",
"value": "T024791905"
}
],
"address": [
{
"line": [
"Blumenweg 14"
],
"_line": [
{
"extension": [
{
"url": "https://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
"valueString": "14"
},
{
"url": "https://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
"valueString": "Blumenweg"
}
]
}
],
"type": "both",
"city": "Esens",
"postalCode": "26427",
"country": "D"
}
],
"birthDate": "1935-06-22",
"telecom": [
{
"system": "url",
"value": "matrix:@T024791905:aok-nord.de"
}
],
"photo": [
{
"contentType": "image/gif",
"data": "R0lGODlhEwARAPcAAAAAAAAA/+"
}
]
}
},
{
"fullUrl": "https://gematik.de/fhir/Coverage/2d4da53a-413a-48fe-b908-2e67b5761523",
"resource": {
"resourceType": "Coverage",
"id": "2d4da53a-413a-48fe-b908-2e67b5761523",
"meta": {
"profile": [
"https://gematik.de/fhir/vsdm2/StructureDefinition/VSDMCoverage"
]
},
"status": "active",
"payor": [
{
"identifier": {
"system": "https://fhir.de/sid/arge-ik/iknr",
"value": "12345678"
},
"display": "Test GKV Krankenkasse"
}
],
"extension": [
{
"url": "https://gematik.de/fhir/vsdm2/StructureDefinition/VSDMFestzuschusshoeheEX",
"valueCoding": {
"code": "1",
"system": "https://gematik.de/fhir/vsdm2/CodeSystem/VSDMFestzuschusshoeheCS",
"display": "70 % / fünf Jahre durchgehend"
}
}
],
"type": {
"coding": [
{
"system": "https://fhir.de/CodeSystem/versicherungsart-de-basis",
"code": "GKV",
"display": "Gesetzliche Krankenversicherung"
}
]
},
"period": {
"start": "2022-04-01",
"end": "2027-07-31"
},
"beneficiary": {
"reference": "Patient/437f2555-2396-4c64-a656-e9553161ca3c"
}
}
}
]
}
]
VSDMOperationOutcome:
type: object
description: 'https://gematik.de/fhir/vsdm2/StructureDefinition/VSDMOperationOutcome'
examples:
[
{
"resourceType": "OperationOutcome",
"id": "example-vsdm-operationoutcome",
"meta": {
"profile": [
"https://gematik.de/fhir/vsdm2/StructureDefinition/VSDMOperationOutcome"
]
},
"issue": [
{
"severity": "fatal",
"code": "invalid",
"details": {
"coding": [
{
"system": "https://gematik.de/fhir/vsdm2/CodeSystem/VSDMErrorcodeCS",
"code": "VSDSERVICE_INVALID_IK",
"display": "Ungültige oder nicht bekannte Institutionskennung <ik>."
}
],
"text": "Nachweis zum Versorgungskontext mittels eGK oder GesundheitsID am PoPP-Service 1 x erneuern. Bei erneutem Fehler: Abbruch, da wahrscheinlich ein Implementierungsfehler vorliegt (Clientsystem oder PoPP-Service) oder die KTR gar nicht bei diesem FD-Anbieter ist (fehlerhafter DNS-Eintrag)."
}
}
]
}
]
ErrorType:
description: Error object with additional information about the occurred error
type: object
properties:
errorCode:
description: Error condition specifier
type: string
examples: [unauthorized, forbidden, internalError]
errorDetail:
description: Additional details regarding the error condition (if applicable)
type: string
examples: [User is not authorized, Request is forbidden, Server cannot handle request for now]
required:
- errorCode
securitySchemes:
oAuthVsdm:
type: oauth2
description: This API uses OAuth 2, to gain access clients need an Access-Token and to proof "Versorgungskontext" with a PoPP-Token in addition
flows:
authorizationCode:
authorizationUrl: https://101575519.vsdm2.ti-dienste.de/auth
tokenUrl: https://101575519.vsdm2.ti-dienste.de/token
scopes:
vsdservice: allows practitioners to access the VSDService API of the "Versichertenstammdatendienst"