Skip to content

Commit 20412cf

Browse files
ClarksonAdamClarksonAdam
committed
docs: updated oas and postman collection
1 parent 393de15 commit 20412cf

File tree

2 files changed

+38
-44
lines changed

2 files changed

+38
-44
lines changed

‎postman/Validate_Relationship_Service_Sandbox.postman_collection.json‎

Lines changed: 34 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -992,18 +992,12 @@
992992
}
993993
],
994994
"url": {
995-
"raw": "{{api_base_url}}/RelatedPerson?patient:identifier=9000000009",
995+
"raw": "{{api_base_url}}/RelatedPerson",
996996
"host": [
997997
"{{api_base_url}}"
998998
],
999999
"path": [
10001000
"RelatedPerson"
1001-
],
1002-
"query": [
1003-
{
1004-
"key": "patient:identifier",
1005-
"value": "9000000009"
1006-
}
10071001
]
10081002
},
10091003
"description": "Example of an error response when the NHS number is missing"
@@ -1098,26 +1092,25 @@
10981092
"script": {
10991093
"exec": [
11001094
"var expectedResponseBody = {",
1101-
" \"resourceType\": \"OperationOutcome\",",
1102-
" \"issue\": [",
1103-
" {",
1104-
" \"severity\": \"error\",",
1105-
" \"code\": \"invalid\",",
1106-
" \"diagnostics\": \"Not a valid NHS Number provided for the 'identifier' parameter\",",
1107-
" \"expression\": \"RelatedPerson.identifier\",",
1108-
" \"details\": {",
1109-
" \"coding\": [",
1110-
" {",
1111-
" \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",",
1112-
" \"version\": \"1\",",
1113-
" \"code\": \"INVALID_IDENTIFIER_VALUE\",",
1114-
" \"display\": \"Provided value is invalid\"",
1115-
" }",
1116-
" ]",
1117-
" }",
1118-
" }",
1119-
" ]",
1120-
"};",
1095+
" \"issue\": [",
1096+
" {",
1097+
" \"code\": \"invalid\",",
1098+
" \"details\": {",
1099+
" \"coding\": [",
1100+
" {",
1101+
" \"code\": \"INVALID_IDENTIFIER_SYSTEM\",",
1102+
" \"display\": \"Invalid identifier system.\",",
1103+
" \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",",
1104+
" \"version\": \"1\"",
1105+
" }",
1106+
" ]",
1107+
" },",
1108+
" \"diagnostics\": \"The identifier system is not valid.\",",
1109+
" \"severity\": \"error\"",
1110+
" }",
1111+
" ],",
1112+
" \"resourceType\": \"OperationOutcome\"",
1113+
"}",
11211114
"",
11221115
"const responseJson = pm.response.json();",
11231116
"",
@@ -1126,7 +1119,7 @@
11261119
"});",
11271120
"",
11281121
"pm.test(\"Should have correct error response\", () => {",
1129-
" pm.expect(responseJson.issue[0].details.coding[0].code).to.eql(\"INVALID_IDENTIFIER_VALUE\");",
1122+
" pm.expect(responseJson.issue[0].details.coding[0].code).to.eql(\"INVALID_IDENTIFIER_SYSTEM\");",
11301123
"});",
11311124
"",
11321125
"pm.test(\"Should have correct response body\", () => {",
@@ -1152,7 +1145,7 @@
11521145
}
11531146
],
11541147
"url": {
1155-
"raw": "{{api_base_url}}/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number/A730675929",
1148+
"raw": "{{api_base_url}}/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|A730675929",
11561149
"host": [
11571150
"{{api_base_url}}"
11581151
],
@@ -1162,7 +1155,7 @@
11621155
"query": [
11631156
{
11641157
"key": "identifier",
1165-
"value": "https://fhir.nhs.uk/Id/nhs-number/A730675929"
1158+
"value": "https://fhir.nhs.uk/Id/nhs-number|A730675929"
11661159
}
11671160
]
11681161
},
@@ -4442,25 +4435,24 @@
44424435
"script": {
44434436
"exec": [
44444437
"const expectedResponseBody = {",
4445-
" \"resourceType\": \"OperationOutcome\",",
44464438
" \"issue\": [",
44474439
" {",
4448-
" \"severity\": \"error\",",
44494440
" \"code\": \"invalid\",",
4450-
" \"diagnostics\": \"Not a valid NHS Number provided for the 'identifier' parameter\",",
4451-
" \"expression\": \"RelatedPerson.identifier\",",
44524441
" \"details\": {",
44534442
" \"coding\": [",
44544443
" {",
4444+
" \"code\": \"INVALID_IDENTIFIER_SYSTEM\",",
4445+
" \"display\": \"Invalid identifier system.\",",
44554446
" \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",",
4456-
" \"version\": \"1\",",
4457-
" \"code\": \"INVALID_IDENTIFIER_VALUE\",",
4458-
" \"display\": \"Provided value is invalid\"",
4447+
" \"version\": \"1\"",
44594448
" }",
44604449
" ]",
4461-
" }",
4450+
" },",
4451+
" \"diagnostics\": \"The identifier system is not valid.\",",
4452+
" \"severity\": \"error\"",
44624453
" }",
4463-
" ]",
4454+
" ],",
4455+
" \"resourceType\": \"OperationOutcome\"",
44644456
"}",
44654457
"",
44664458
"const responseJson = pm.response.json();",
@@ -4470,7 +4462,7 @@
44704462
"});",
44714463
"",
44724464
"pm.test(\"Should have correct error response\", () => {",
4473-
" pm.expect(responseJson.issue[0].details.coding[0].code).to.eql(\"INVALID_IDENTIFIER_VALUE\");",
4465+
" pm.expect(responseJson.issue[0].details.coding[0].code).to.eql(\"INVALID_IDENTIFIER_SYSTEM\");",
44744466
"});",
44754467
"",
44764468
"pm.test(\"Should have correct response body\", () => {",
@@ -4485,7 +4477,7 @@
44854477
"method": "GET",
44864478
"header": [],
44874479
"url": {
4488-
"raw": "{{api_base_url}}/Consent?performer:identifier=90000000011",
4480+
"raw": "{{api_base_url}}/Consent?performer:identifier=https://fhir.nhs.uk/Id/nhs-number|1234567890",
44894481
"host": [
44904482
"{{api_base_url}}"
44914483
],
@@ -4495,7 +4487,7 @@
44954487
"query": [
44964488
{
44974489
"key": "performer:identifier",
4498-
"value": "90000000011"
4490+
"value": "https://fhir.nhs.uk/Id/nhs-number|1234567890"
44994491
}
45004492
]
45014493
}

‎specification/validated-relationships-service-api.yaml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -446,14 +446,16 @@ paths:
446446
$ref: './examples/responses/errors/access-denied.yaml#/AccessDeniedError'
447447
InvalidIdentifierError:
448448
$ref: './examples/responses/errors/invalid-identifier.yaml#/InvalidIdentifierError'
449-
InvalidIncludeParameterBundle:
450-
$ref: './examples/responses/errors/invalid-include-parameter.yaml#/InvalidIncludeParameterBundle'
449+
InvalidIdentifierSystemBundle:
450+
$ref: './examples/responses/errors/invalid-identifier-system.yaml#/InvalidIdentifierSystemBundle'
451451
IdentifierMissingBundle:
452452
$ref: './examples/responses/errors/missing-identifier.yaml#/IdentifierMissingBundle'
453453
NotFoundBundle:
454454
$ref: './examples/responses/errors/not-found.yaml#/NotFoundBundle'
455455
ConsentInvalidStatusParameterBundle:
456456
$ref: './examples/responses/GET_Consent/errors/invalid-status-parameter.yaml#/ConsentInvalidStatusParameterBundle'
457+
InvalidIncludeParameterBundle:
458+
$ref: './examples/responses/errors/invalid-include-parameter.yaml#/InvalidIncludeParameterBundle'
457459
"500":
458460
description: Internal server error
459461
content:

0 commit comments

Comments
 (0)