Skip to content

Commit b838393

Browse files
gematik1gematik1
authored
Publish Release 3.0.1-1
Automerge Pull-Request for Release 3.0.1-1
2 parents 193912a + 8a797e5 commit b838393

12 files changed

+145
-87
lines changed

‎ReleaseNotes.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
<img align="right" width="250" height="47" src="images/Gematik_Logo_Flag_With_Background.png"/> <br/>
22

33
# Release Notes ePA Basic
4+
## Release 3.0.1-1
5+
### changes
6+
- bugfix regex UserAgentType (C_11780)
7+
- typo correction in I_Authorization_Service.yaml
8+
- x-useragent mandatory in I_Information_Service.yaml (C_11779)
9+
- changed http-statuscodes from 200 to 201 or 204 in openapis (C_11811)
10+
- all changed consent decisions in response of updateConsentDecision in I_Consent_Decision_Management.yaml (C_11783)
11+
- regex correction TelematikIdType I_Entitlement_Management.yaml and I_Test_Driver_FdV.yaml (C_11782)
412
## Release 3.0.1
513
- release ePA-3.0.1
614
- (all changes from changelist 'ePAfueralle_3.0.1' and final review)

‎src/openapi/I_Audit_Event.yaml

+4-2
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,12 @@ info:
4545
name: Apache 2.0
4646
url: 'https://www.apache.org/licenses/LICENSE-2.0'
4747

48-
version: 1.0.1
48+
version: 1.1.0
4949

5050
# version history:
5151
# ----------------
52+
# version 1.1.0
53+
# - bugfix UserAgentType
5254
# version 1.0.1
5355
# - corrected examples
5456
# - correction of 'Coding' schema
@@ -579,7 +581,7 @@ components:
579581
UserAgentType:
580582
description: "Information about client software with: ClientId(20 characters) + / + VersionNumber (1 to 15 characters)."
581583
type: string
582-
pattern: '^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$'
584+
pattern: '^[a-zA-Z0-9\-]{1,20}\/[a-zA-Z0-9\-\.]{1,15}$'
583585
example: CLIENTID1234567890AB/2.1.12-45
584586
ErrorType:
585587
description: Error object with additional information about the occurred error

‎src/openapi/I_Audit_Event_Render.yaml

+4-2
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,12 @@ info:
3838
name: Apache 2.0
3939
url: 'https://www.apache.org/licenses/LICENSE-2.0'
4040

41-
version: 1.1.1
41+
version: 1.2.0
4242

4343
# version history:
4444
# ----------------
45+
# version 1.2.0
46+
# - bugfix regex UserAgentType
4547
# version 1.1.1
4648
# - changed format for PDF response
4749
# version 1.1.0
@@ -184,7 +186,7 @@ components:
184186
UserAgentType:
185187
description: "Information about client software with: ClientId(20 characters) + / + VersionNumber (1 to 15 characters)."
186188
type: string
187-
pattern: '^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$'
189+
pattern: '^[a-zA-Z0-9\-]{1,20}\/[a-zA-Z0-9\-\.]{1,15}$'
188190
example: CLIENTID1234567890AB/2.1.12-45
189191
ErrorType:
190192
description: Error object with additional information about the occurred error

‎src/openapi/I_Authorization_Service.yaml

+10-6
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,14 @@ info:
3636
name: Apache 2.0
3737
url: 'https://www.apache.org/licenses/LICENSE-2.0'
3838

39-
version: 1.1.2
39+
version: 1.2.0
4040

4141
# version history:
4242
# ----------------
43+
# version 1.2.0
44+
# - bugfix UserAgentType
45+
# - typo in VauUserPseudonymType corrected
46+
# - changed http-statuscode in operation logoutFdv to 204
4347
# version 1.1.2
4448
# - correction of typos in descriptions
4549
# - changed amr for representative authentication via ePA-FdV
@@ -692,7 +696,7 @@ paths:
692696
693697
| Conditions | Status code | Error code | Remarks |
694698
|------------|-------------|------------|---------|
695-
| Successful logout | 200 |||
699+
| Successful logout | 204 |||
696700
| Request does not match schema | 400 | malformedRequest ||
697701
| Any other error | 500 | internalError ||
698702
@@ -702,7 +706,7 @@ paths:
702706
| The user session and all related temporary data is terminated / deleted ||
703707
704708
responses:
705-
'200':
709+
'204':
706710
description: "OK"
707711
'400':
708712
$ref: '#/components/responses/Error400BadRequest'
@@ -761,7 +765,7 @@ components:
761765
type: object
762766
properties:
763767
vau-np:
764-
$ref: '#/components/schemas/VauUserPreudonymType'
768+
$ref: '#/components/schemas/VauUserPseudonymType'
765769
required:
766770
- vau-np
767771

@@ -833,7 +837,7 @@ components:
833837
UserAgentType:
834838
description: "Information about client software with: ClientId(20 characters) + / + VersionNumber (1 to 15 characters)."
835839
type: string
836-
pattern: '^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$'
840+
pattern: '^[a-zA-Z0-9\-]{1,20}\/[a-zA-Z0-9\-\.]{1,15}$'
837841
example: CLIENTID1234567890AB/2.1.12-45
838842
DeviceIdentifierType:
839843
description: A device identifier
@@ -874,7 +878,7 @@ components:
874878
- authorizationCode
875879
example:
876880
authorizationCode: 2435623452hkjlk34t
877-
VauUserPreudonymType:
881+
VauUserPseudonymType:
878882
description: The VAU user pseudonym (VAU-NP), a string of hexadecimal digits (e.g. 64 digits)
879883
type: string
880884
example: "4aadc671bf058fb6df5f181ad94f4130b3d3e86f3a7ffd53e6ea6a3f01e65608"

‎src/openapi/I_Consent_Decision_Management.yaml

+28-17
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,13 @@ info:
3939
Whenever a _Postcondition_ mandates a log-entry, this entry shall contain
4040
data as defined in A_24055*.
4141
42-
version: 1.1.1
42+
version: 1.2.0
4343

4444
# version history:
4545
# ----------------
46+
# version 1.2.0
47+
# - bugfix UserAgentType
48+
# - return all changed consent decisions in response of updateConsentDecision
4649
# version 1.1.1
4750
# - reworked the correction of depending consent decision change 'medication' and 'erp-submission'
4851
# version 1.1.0
@@ -134,7 +137,9 @@ paths:
134137
135138
An email shall be sent to the insurant using the registered mail address after a successful change of
136139
a decision for notification. The mail shall contain understandable information about the changed consent
137-
decision and timestamp of change (according to A_24844*)
140+
decision(s) and timestamp of change (according to A_24844*)."
141+
142+
The response of a successful operation shall contain all changed consent decisions.
138143
139144
| Conditions | Status code | Error code | Remarks |
140145
|------------|-------------|------------|---------|
@@ -169,11 +174,11 @@ paths:
169174
application/json:
170175
examples:
171176
Permit:
172-
summary: Permit request
177+
summary: Permit request (e.g functionid == medication)
173178
value:
174179
decision: "permit"
175180
Deny:
176-
summary: Deny request
181+
summary: Deny request (e.g functionid == erp-submission)
177182
value:
178183
decision: "deny"
179184
schema:
@@ -185,22 +190,28 @@ paths:
185190
application/json:
186191
examples:
187192
Permit_Medication:
188-
summary: Permit medication request response
193+
summary: Permit functionid == medication (permits erp-submission internally) response
189194
value:
190-
functionId: "medication"
191-
decision: "permit"
192-
Deny_Medication:
193-
summary: Deny medication request response
195+
- functionId: "medication"
196+
decision: "permit"
197+
- functionId: "erp-submission"
198+
decision: "permit"
199+
Deny_erp-submission:
200+
summary: Deny functionid == erp-submission (denies medication internally) response
194201
value:
195-
functionId: "medication"
196-
decision: "deny"
197-
Deny_Erp-submission:
198-
summary: Deny erp-submission request response
202+
- functionId: "medication"
203+
decision: "deny"
204+
- functionId: "erp-submission"
205+
decision: "deny"
206+
Deny_erp-submission2:
207+
summary: Deny functionid == erp-submission (medication already denied) response
199208
value:
200-
functionId: "erp-submission"
201-
decision: "deny"
209+
- functionId: "erp-submission"
210+
decision: "deny"
202211
schema:
203-
$ref: "#/components/schemas/ConsentDecisionsResponseType"
212+
type: array
213+
items:
214+
$ref: "#/components/schemas/ConsentDecisionsResponseType"
204215
'400':
205216
$ref: "#/components/responses/Error400BadRequest"
206217
'403':
@@ -418,7 +429,7 @@ components:
418429
UserAgentType:
419430
description: "Information about client software with: ClientId(20 characters) + / + VersionNumber (1 to 15 characters)."
420431
type: string
421-
pattern: '^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$'
432+
pattern: '^[a-zA-Z0-9\-]{1,20}\/[a-zA-Z0-9\-\.]{1,15}$'
422433
example: CLIENTID1234567890AB/2.1.12-45
423434
FunctionIdType:
424435
type: string

‎src/openapi/I_Device_Management_Insurant.yaml

+6-3
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,13 @@ info:
4141
name: Apache 2.0
4242
url: 'https://www.apache.org/licenses/LICENSE-2.0'
4343

44-
version: 1.1.0
44+
version: 1.2.0
4545

4646
# version history:
4747
# ----------------
48+
# version 1.2.0
49+
# - bugfix UserAgentType
50+
# - changed http-statuscode in description of operation deleteDevice to 204
4851
# version 1.1.0
4952
# - API change to support confirmation of device registration with a confirmation code
5053
# - added operations to register and confirm devices.
@@ -633,7 +636,7 @@ paths:
633636
634637
| Conditions | Status code | Error code | Remarks |
635638
|------------|-------------|------------|---------|
636-
| Successful operation | 200|||
639+
| Successful operation | 204 |||
637640
| Request does not match schema | 400 | malformedRequest ||
638641
| Requestor role is not _oid_versicherter_ | 403 | invalidOid ||
639642
| Device registration (_deviceidentifier_) does not exist | 404 | noResource | also if device is not associated to requestor kvnr |
@@ -766,7 +769,7 @@ components:
766769
UserAgentType:
767770
description: "Information about client software with: ClientId(20 characters) + / + VersionNumber (1 to 15 characters)."
768771
type: string
769-
pattern: '^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$'
772+
pattern: '^[a-zA-Z0-9\-]{1,20}\/[a-zA-Z0-9\-\.]{1,15}$'
770773
example: CLIENTID1234567890AB/2.1.12-45
771774
BaseDeviceType:
772775
type: object

‎src/openapi/I_Email_Management.yaml

+4-2
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,12 @@ info:
3535
name: Apache 2.0
3636
url: 'https://www.apache.org/licenses/LICENSE-2.0'
3737

38-
version: 1.0.0
38+
version: 1.1.0
3939

4040
# version history:
4141
# ----------------
42+
# version 1.1.0
43+
# - bugfix UserAgentType
4244
# version 1.0.0
4345
# - initial version
4446

@@ -406,7 +408,7 @@ components:
406408
UserAgentType:
407409
description: "Information about client software with: ClientId(20 characters) + / + VersionNumber (1 to 15 characters)."
408410
type: string
409-
pattern: '^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$'
411+
pattern: '^[a-zA-Z0-9\-]{1,20}\/[a-zA-Z0-9\-\.]{1,15}$'
410412
example: CLIENTID1234567890AB/2.1.12-45
411413
InsurantIdType:
412414
type: string

‎src/openapi/I_Entitlement_Management.yaml

+10-4
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,14 @@ info:
4141
name: Apache 2.0
4242
url: 'https://www.apache.org/licenses/LICENSE-2.0'
4343

44-
version: 1.1.1
44+
version: 1.2.0
45+
4546
# version history:
4647
# ----------------
48+
# version 1.2.0
49+
# - bugfix UserAgentType
50+
# - correction in regex TelematikIdType
51+
# - changed http-statuscode in description of operation setBlockedUserPolicyAssignment to 201
4752
# version 1.1.1
4853
# - deleteEntitlement: requirement to delete representatives email address removed
4954
# version 1.1.0
@@ -747,7 +752,7 @@ paths:
747752
748753
| Conditions | Status code | Error code | Remarks |
749754
|------------|-------------|------------|---------|
750-
| Successful operation | 200 |||
755+
| Successful operation | 201 |||
751756
| Request does not match schema | 400 | malformedRequest ||
752757
| Requestor has no valid entitlement | 403 | notEntitled ||
753758
| Requestor role is not _oid_versicherter_ or _oid_ombudsstelle_ | 403 | invalidOid ||
@@ -1029,7 +1034,8 @@ components:
10291034
example: Z123456789
10301035
TelematikIdType:
10311036
type: string
1032-
pattern: '[0-9]{1}[-]{1}\d{1,126}$'
1037+
pattern: '^[1-9][0-9]?-[\x{21}-\x{7E}]+$'
1038+
maxLength: 128
10331039
example: 2-883110000118994
10341040
OidType:
10351041
description: A professionOID
@@ -1151,7 +1157,7 @@ components:
11511157
UserAgentType:
11521158
description: "Information about client software with: ClientId(20 characters) + / + VersionNumber (1 to 15 characters)."
11531159
type: string
1154-
pattern: '^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$'
1160+
pattern: '^[a-zA-Z0-9\-]{1,20}\/[a-zA-Z0-9\-\.]{1,15}$'
11551161
example: CLIENTID1234567890AB/2.1.12-45
11561162
InsurantIdType:
11571163
type: string

‎src/openapi/I_Health_Record_Relocation_Service.yaml

+9-6
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,13 @@ info:
4747
name: Apache 2.0
4848
url: 'https://www.apache.org/licenses/LICENSE-2.0'
4949

50-
version: 1.0.0
50+
version: 1.1.0
5151

5252
# version history:
5353
# ----------------
54+
# version 1.1.0
55+
# - bugfix UserAgentType
56+
# - changed http-statuscode in operation startPackageCreation and startPackageImport to 201
5457
# version 1.0.0
5558
# - first release version
5659
# version 0.0.1
@@ -132,7 +135,7 @@ paths:
132135
133136
| Conditions | Status code | Error code | Remarks |
134137
|------------|-------------|------------|---------|
135-
| Successful operation | 200 |||
138+
| Successful operation | 201 |||
136139
| Request does not match schema | 400 | malformedRequest ||
137140
| Requestor has no valid entitlement | 403 | notEntitled ||
138141
| Requestor role is not _oid_kostentraeger__ | 403 | invalidOid ||
@@ -165,7 +168,7 @@ paths:
165168
required:
166169
- requestId
167170
responses:
168-
'200':
171+
'201':
169172
description: Ok.
170173
content:
171174
application/json:
@@ -251,7 +254,7 @@ paths:
251254
252255
| Conditions | Status code | Error code | Remarks |
253256
|------------|-------------|------------|---------|
254-
| Successful operation | 200 |||
257+
| Successful operation | 201 |||
255258
| Request does not match schema | 400 | malformedRequest ||
256259
| Requestor has no valid entitlement | 403 | notEntitled ||
257260
| Requestor role is not _oid_kostentraeger_ | 403 | invalidOid ||
@@ -288,7 +291,7 @@ paths:
288291
- requestId
289292
- downloadurl
290293
responses:
291-
'200':
294+
'201':
292295
description: Ok.
293296
'400':
294297
$ref: '#/components/responses/Error400BadRequest'
@@ -383,7 +386,7 @@ components:
383386
UserAgentType:
384387
description: "Information about client software with: ClientId(20 characters) + / + VersionNumber (1 to 15 characters)."
385388
type: string
386-
pattern: '^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$'
389+
pattern: '^[a-zA-Z0-9\-]{1,20}\/[a-zA-Z0-9\-\.]{1,15}$'
387390
example: CLIENTID1234567890AB/2.1.12-45
388391
InsurantIdType:
389392
type: string

0 commit comments

Comments
 (0)