Skip to content

Commit d1e52f2

Browse files
Akol125Akol125
committed
resolve markdown interface for error response
1 parent 11e5ae6 commit d1e52f2

File tree

1 file changed

+40
-83
lines changed

1 file changed

+40
-83
lines changed

‎specification/immunisation-fhir-api.yaml‎

Lines changed: 40 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -3994,48 +3994,38 @@ components:
39943994
---------------------------------------------
39953995
|--------------------------------------------------------------------------------------|
39963996
3997-
| 400 | Bad Request | Invalid resourceType in body
3998-
|
3997+
| 400 | Bad Request | Invalid resourceType in body |
39993998
4000-
| 400 | Bad Request | Invalid resourceType within
4001-
contained |
3999+
| 400 | Bad Request | Invalid resourceType within contained |
40024000
40034001
| 400 | Bad Request | Invalid status value |
40044002
4005-
40064003
| 400 | Bad Request | Invalid value for a datetime
40074004
(string) field e.g. occurrenceDateTime.<br>Note : The error format will
40084005
remain same for any datetime (string) field; only the field name will
40094006
change under diagnostics. |
40104007
40114008
| 400 | Bad Request | Invalid value for a string
40124009
field e.g. postalCode<br>Note : The error format will remain same for
4013-
any string field; only the field location will change under diagnostics.
4014-
|
4010+
any string field; only the field location will change under diagnostics. |
40154011
40164012
| 400 | Bad Request | Invalid value for an integer
40174013
field e.g. doseNumberPositiveInt<br>Note : The error format will remain
40184014
same for any integer field; only the field location will change under
40194015
diagnostics. |
40204016
4021-
| 400 | Bad Request | Invalid top level element
4022-
e.g. test |
4017+
| 400 | Bad Request | Invalid top level element e.g. test |
40234018
40244019
| 400 | Bad Request | Missing mandatory field e.g.
4025-
contained<br>Note : The error format will remain same for any mandatory
4026-
field; only the field name will change under diagnostics. |
4020+
contained<br>Note : The error format will remain same for any mandatory field; only the field name will change under diagnostics. |
40274021
4028-
| 401 | Unauthorized | Authorization is required
4029-
for the interaction that was attempted |
4022+
| 401 | Unauthorized | Authorization is required for the interaction that was attempted |
40304023
4031-
| 403 | Forbidden | The sender does not have
4032-
permissions to access this resource |
4024+
| 403 | Forbidden | The sender does not have permissions to access this resource |
40334025
4034-
| 403 | Forbidden | The sender does not have
4035-
permission for the specific operation or vaccine type |
4026+
| 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type |
40364027
4037-
| 422 | Unprocessable Entity | Duplicate
4038-
Identifier value |
4028+
| 422 | Unprocessable Entity | Duplicate Identifier value |
40394029
content:
40404030
application/fhir+json:
40414031
schema:
@@ -4063,38 +4053,28 @@ components:
40634053
error codes, which could be returned in the event of a fault.
40644054
40654055
4066-
| HTTP status | Error code | Description
4056+
| HTTP status | Error code | Description |
40674057
|
40684058
40694059
| ----------- | -------------------------- |
40704060
---------------------------------------------
40714061
|--------------------------------------------------------------------------------------|
40724062
4073-
| 400 | Bad Request | Search parameter
4074-
immunization.target is either missing or not in the expected format. |
4075-
4063+
| 400 | Bad Request | Search parameter immunization.target is either missing or not in the expected format. |
40764064
4077-
| 400 | Bad Request | Search parameter
4078-
patient.identifier is either missing or not in the expected format. |
4065+
| 400 | Bad Request | Search parameterpatient.identifier is either missing or not in the expected format. |
40794066
4067+
| 400 | Bad Request | Invalid value for patient.identifier |
40804068
4081-
| 400 | Bad Request | Invalid value for
4082-
patient.identifier |
4069+
| 400 | Bad Request | Invalid date.to/date.from format |
40834070
4084-
| 400 | Bad Request | Invalid date.to/date.from
4085-
format |
4071+
| 400 | Bad Request | Invalid value for "-immunization.target" |
40864072
4087-
| 400 | Bad Request | Invalid value for
4088-
"-immunization.target" |
4073+
| 401 | Unauthorized | Authorization is required for the interaction that was attempted |
40894074
4090-
| 401 | Unauthorized | Authorization is required
4091-
for the interaction that was attempted |
4075+
| 403 | Forbidden | The sender does not have permissions to access this resource |
40924076
4093-
| 403 | Forbidden | The sender does not have
4094-
permissions to access this resource |
4095-
4096-
| 403 | Forbidden | The sender does not have
4097-
permission for the specific operation or vaccine type |
4077+
| 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type |
40984078
content:
40994079
application/fhir+json:
41004080
schema:
@@ -4122,28 +4102,22 @@ components:
41224102
error codes, which could be returned in the event of a fault.
41234103
41244104
4125-
| HTTP status | Error code | Description
4105+
| HTTP status | Error code | Description |
41264106
|
41274107
41284108
| ----------- | -------------------------- |
41294109
---------------------------------------------
41304110
|--------------------------------------------------------------------------------------|
41314111
4132-
| 400 | Bad Request | Missing immunization event
4133-
identifier (id) |
4134-
4135-
| 401 | Unauthorized | Authorization is required
4136-
for the interaction that was attempted |
4112+
| 400 | Bad Request | Missing immunization event identifier (id) |
41374113
4138-
| 403 | Forbidden | The sender does not have
4139-
permissions to access this resource |
4114+
| 401 | Unauthorized | Authorization is required for the interaction that was attempted |
41404115
4141-
| 403 | Forbidden | The sender does not have
4142-
permission for the specific operation or vaccine type |
4116+
| 403 | Forbidden | The sender does not have permissions to access this resource |
41434117
4118+
| 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type |
41444119
4145-
| 404 | Not Found | Unrecognized immunization
4146-
event identifier (id) |
4120+
| 404 | Not Found | Unrecognized immunization event identifier (id) |
41474121
content:
41484122
application/fhir+json:
41494123
schema:
@@ -4171,48 +4145,37 @@ components:
41714145
error codes, which could be returned in the event of a fault.
41724146
41734147
4174-
| HTTP status | Error code | Description | Example
4148+
| HTTP status | Error code | Description |
41754149
|
41764150
41774151
| ----------- | -------------------------- |
41784152
---------------------------------------------
41794153
|--------------------------------------------------------------------------------------|
41804154
4181-
| 400 | Bad Request | All validation errors &
4182-
mandatory field errors from the Record scenario | All validation errors
4155+
| 400 | Bad Request | All validation errors & mandatory field errors from the Record scenario | All validation errors
41834156
& mandatory field errors from POST /Immunization |
41844157
4185-
| 400 | Bad Request | Missing id in request
4186-
parameter |
4158+
| 400 | Bad Request | Missing id in request parameter |
41874159
4188-
| 400 | Bad Request | Missing id parameter in
4189-
request body<br>or<br>mismatch between id provided within request body
4190-
and request parameter |
4160+
| 400 | Bad Request | Missing id parameter in request body<br>or<br>mismatch between id provided within request body and request parameter |
41914161
4192-
| 400 | Bad Request | Mismatch between identifier
4162+
| 400 | Bad Request | Mismatch between identifier
41934163
value and stored event |
41944164
4195-
| 400 | Bad Request | Missing E-Tag (version)
4196-
header |
4165+
| 400 | Bad Request | Missing E-Tag (version)header |
41974166
4198-
| 400 | Bad Request | Wrong version number passed
4199-
in E-Tag header<br>e.g. passing version no. > 1 in case of first-time
4200-
update |
4167+
| 400 | Bad Request | Wrong version number passed in E-Tag header<br>e.g. passing version no. > 1 in case of first-time update |
42014168
4202-
| 400 | Bad Request | Empty value for E-Tag header
4169+
| 400 | Bad Request | Empty value for E-Tag header
42034170
|
42044171
4205-
| 400 | Bad Request | E-Tag value <= current
4206-
stored value |
4172+
| 400 | Bad Request | E-Tag value <= current stored value |
42074173
4208-
| 401 | Unauthorized | Authorization is required
4209-
for the interaction that was attempted |
4174+
| 401 | Unauthorized | Authorization is required for the interaction that was attempted |
42104175
4211-
| 403 | Forbidden | The sender does not have
4212-
permissions to access this resource |
4176+
| 403 | Forbidden | The sender does not have permissions to access this resource |
42134177
4214-
| 403 | Forbidden | The sender does not have
4215-
permission for the specific operation or vaccine type |
4178+
| 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type |
42164179
42174180
| 404 | Not Found | Provided id not available |
42184181
@@ -4252,19 +4215,13 @@ components:
42524215
42534216
| 400 | Bad Request | Missing or invalid id |
42544217
4255-
| 401 | Unauthorized | Authorization is required
4256-
for the interaction that was attempted |
4257-
4258-
4259-
| 403 | Forbidden | The sender does not have
4260-
permissions to access this resource |
4218+
| 401 | Unauthorized | Authorization is required for the interaction that was attempted |
42614219
4220+
| 403 | Forbidden | The sender does not have permissions to access this resource |
42624221
4263-
| 403 | Forbidden | The sender does not have
4264-
permission for the specific operation or vaccine type |
4222+
| 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type |
42654223
4266-
| 404 | Not Found | Non existing id in query
4267-
parameter<br>or<br>Trying to deleted an already deleted record |
4224+
| 404 | Not Found | Non existing id in query parameter<br>or<br>Trying to deleted an already deleted record |
42684225
42694226
content:
42704227
application/fhir+json:

0 commit comments

Comments
 (0)