Skip to content

Commit 21b6285

Browse files
lelliott-hippolelliott-hippo
committed
NPA-5629: OperationOutcome IOPS update
1 parent 215c563 commit 21b6285

21 files changed

+64
-44
lines changed

‎postman/Validated Relationship Service Sandbox.postman_collection.json‎

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"info": {
3-
"_postman_id": "66c6bd03-3fda-4ff7-9be9-bace275b60cf",
4-
"name": "Validated Relationship Service Sandbox 08/09/25",
3+
"_postman_id": "76babb13-02c0-42b3-84ec-d64ebe45e7b8",
4+
"name": "Validated Relationship Service Sandbox 17/09/25",
55
"description": "This Postman collection includes example scenarios for each of the Validated Relationship Service (VRS) API endpoints, covering both valid and invalid request scenarios.\n\nThe collection is pointed towards the VRS sandbox environment, which will return a specific example response based on the request sent. All data shown in the requests or responses is test data.\n\nOur sandbox environment only covers the scenarios listed in the Postman collection and is open access. It does not allow you to test authorisation or any scenarios beyond the ones documented.\n\nFull specification is available at [https://digital.nhs.uk/developer/api-catalogue/validated-relationship-service](https://digital.nhs.uk/developer/api-catalogue/validated-relationship-service)",
66
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
77
"_exporter_id": "45653607",
8-
"_collection_link": "https://www.postman.com/lukeelliott-8674106/workspace/validated-relationship-service-sandbox-08-11-2025/collection/45653607-66c6bd03-3fda-4ff7-9be9-bace275b60cf?action=share&source=collection_link&creator=45653607"
8+
"_collection_link": "https://www.postman.com/lukeelliott-8674106/workspace/validated-relationship-service-sandbox-17-09-2025/collection/45653607-76babb13-02c0-42b3-84ec-d64ebe45e7b8?action=share&source=collection_link&creator=45653607"
99
},
1010
"item": [
1111
{
@@ -1760,7 +1760,9 @@
17601760
" ]",
17611761
" },",
17621762
" \"diagnostics\": \"Not a valid NHS Number provided for the 'identifier' parameter\",",
1763-
" \"expression\": \"RelatedPerson.identifier\",",
1763+
" \"expression\": [",
1764+
" \"RelatedPerson.identifier\"",
1765+
" ],",
17641766
" \"severity\": \"error\"",
17651767
" }",
17661768
" ],",
@@ -1919,6 +1921,7 @@
19191921
" }",
19201922
" ]",
19211923
" },",
1924+
" \"diagnostics\": \"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved\",",
19221925
" \"severity\": \"error\"",
19231926
" }",
19241927
" ],",
@@ -1939,7 +1942,8 @@
19391942
" pm.expect(responseJson).to.eql(expectedResponseBody);",
19401943
"});"
19411944
],
1942-
"type": "text/javascript"
1945+
"type": "text/javascript",
1946+
"packages": {}
19431947
}
19441948
}
19451949
],
@@ -1997,6 +2001,7 @@
19972001
" }",
19982002
" ]",
19992003
" },",
2004+
" \"diagnostics\": \"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved\",",
20002005
" \"severity\": \"error\"",
20012006
" }",
20022007
" ],",
@@ -2017,7 +2022,8 @@
20172022
" pm.expect(responseJson).to.eql(expectedResponseBody);",
20182023
"});"
20192024
],
2020-
"type": "text/javascript"
2025+
"type": "text/javascript",
2026+
"packages": {}
20212027
}
20222028
}
20232029
],
@@ -7296,9 +7302,7 @@
72967302
" \"resourceType\": \"OperationOutcome\",",
72977303
" \"issue\": [",
72987304
" {",
7299-
" \"severity\": \"error\",",
73007305
" \"code\": \"invalid\",",
7301-
" \"diagnostics\": \"Invalid request with error - status parameter is invalid.\",",
73027306
" \"details\": {",
73037307
" \"coding\": [",
73047308
" {",
@@ -7308,7 +7312,9 @@
73087312
" \"display\": \"Required parameter(s) are invalid.\"",
73097313
" }",
73107314
" ]",
7311-
" }",
7315+
" },",
7316+
" \"diagnostics\": \"Invalid request with error - status parameter is invalid.\",",
7317+
" \"severity\": \"error\"",
73127318
" }",
73137319
" ]",
73147320
"}",
@@ -7375,10 +7381,10 @@
73757381
" }",
73767382
" ]",
73777383
" },",
7384+
" \"diagnostics\": \"Invalid request with error - _include parameter is invalid.\",",
73787385
" \"severity\": \"error\"",
73797386
" }",
7380-
" ],",
7381-
" \"diagnostics\": \"Invalid request with error - _include parameter is invalid.\"",
7387+
" ]",
73827388
"}",
73837389
"",
73847390
"const responseJson = pm.response.json();",
@@ -7435,8 +7441,7 @@
74357441
"const expectedResponseBody = {",
74367442
" \"resourceType\": \"OperationOutcome\",",
74377443
" \"issue\": [",
7438-
" {",
7439-
" \"severity\": \"error\",",
7444+
" { ",
74407445
" \"code\": \"processing\",",
74417446
" \"details\": {",
74427447
" \"coding\": [",
@@ -7447,7 +7452,10 @@
74477452
" \"display\": \"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved\"",
74487453
" }",
74497454
" ]",
7450-
" }",
7455+
" },",
7456+
" \"diagnostics\": \"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved\",",
7457+
" \"severity\": \"error\",",
7458+
" ",
74517459
" }",
74527460
" ]",
74537461
"}",
@@ -7466,7 +7474,8 @@
74667474
" pm.expect(responseJson).to.eql(expectedResponseBody);",
74677475
"});"
74687476
],
7469-
"type": "text/javascript"
7477+
"type": "text/javascript",
7478+
"packages": {}
74707479
}
74717480
}
74727481
],
@@ -7502,7 +7511,6 @@
75027511
" \"issue\": [",
75037512
" {",
75047513
" \"code\": \"invalid\",",
7505-
" \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier parameter is invalid.\",",
75067514
" \"details\": {",
75077515
" \"coding\": [",
75087516
" {",
@@ -7513,6 +7521,7 @@
75137521
" }",
75147522
" ]",
75157523
" },",
7524+
" \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier parameter is invalid.\",",
75167525
" \"severity\": \"error\"",
75177526
" }",
75187527
" ],",
@@ -7570,7 +7579,6 @@
75707579
" \"issue\": [",
75717580
" {",
75727581
" \"code\": \"invalid\",",
7573-
" \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier system parameter is invalid.\",",
75747582
" \"details\": {",
75757583
" \"coding\": [",
75767584
" {",
@@ -7581,6 +7589,7 @@
75817589
" }",
75827590
" ]",
75837591
" },",
7592+
" \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier system parameter is invalid.\",",
75847593
" \"severity\": \"error\"",
75857594
" }",
75867595
" ],",
@@ -7638,7 +7647,6 @@
76387647
" \"issue\": [",
76397648
" {",
76407649
" \"code\": \"invalid\",",
7641-
" \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier parameter not found.\",",
76427650
" \"details\": {",
76437651
" \"coding\": [",
76447652
" {",
@@ -7649,6 +7657,7 @@
76497657
" }",
76507658
" ]",
76517659
" },",
7660+
" \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier parameter not found.\",",
76527661
" \"severity\": \"error\"",
76537662
" }",
76547663
" ],",
@@ -7710,6 +7719,7 @@
77107719
" }",
77117720
" ]",
77127721
" },",
7722+
" \"diagnostics\": \"GP Practice could not be found\",",
77137723
" \"severity\": \"error\"",
77147724
" }",
77157725
" ],",
@@ -9414,7 +9424,6 @@
94149424
" \"issue\": [",
94159425
" {",
94169426
" \"code\": \"invalid\",",
9417-
" \"diagnostics\": \"Invalid request with error - ID must be a valid UUID.\",",
94189427
" \"details\": {",
94199428
" \"coding\": [",
94209429
" {",
@@ -9425,6 +9434,7 @@
94259434
" }",
94269435
" ]",
94279436
" },",
9437+
" \"diagnostics\": \"Invalid request with error - ID must be a valid UUID.\",",
94289438
" \"severity\": \"error\"",
94299439
" }",
94309440
" ],",
@@ -9484,10 +9494,11 @@
94849494
" }",
94859495
" ]",
94869496
" },",
9497+
" \"diagnostics\": \"Invalid request with error - _include parameter is invalid.\",",
94879498
" \"severity\": \"error\"",
9499+
" ",
94889500
" }",
94899501
" ],",
9490-
" \"diagnostics\": \"Invalid request with error - _include parameter is invalid.\"",
94919502
"}",
94929503
"",
94939504
"const responseJson = pm.response.json();",
@@ -9549,10 +9560,10 @@
95499560
" }",
95509561
" ]",
95519562
" },",
9563+
" \"diagnostics\": \"Invalid request with error - _include parameter is invalid.\",",
95529564
" \"severity\": \"error\"",
95539565
" }",
95549566
" ],",
9555-
" \"diagnostics\": \"Invalid request with error - _include parameter is invalid.\"",
95569567
"}",
95579568
"",
95589569
"const responseJson = pm.response.json();",
@@ -9613,6 +9624,7 @@
96139624
" }",
96149625
" ]",
96159626
" },",
9627+
" \"diagnostics\": \"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved\",",
96169628
" \"severity\": \"error\"",
96179629
" }",
96189630
" ],",
@@ -10264,8 +10276,7 @@
1026410276
"variable": [
1026510277
{
1026610278
"key": "api_base_url",
10267-
"value": "https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4",
10268-
"type": "string"
10279+
"value": "https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4"
1026910280
}
1027010281
]
1027110282
}

‎proxies/live/apiproxy/policies/RaiseFault.404NotFound.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
}
3333
]
3434
},
35+
"diagnostics": "Resource that has been marked as invalid was requested - invalid resources cannot be retrieved",
3536
"severity": "error"
3637
}
3738
],

‎specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ ConsentInvalidIDError:
44
value:
55
issue:
66
- code: invalid
7-
diagnostics: "Invalid request with error - ID must be a valid UUID."
87
details:
98
coding:
109
- code: "INVALID_ID_VALUE"
1110
display: "Required parameter(s) are invalid."
1211
system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
1312
version: "1"
13+
diagnostics: "Invalid request with error - ID must be a valid UUID."
1414
severity: error
1515
resourceType: "OperationOutcome"

‎specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ GPPracticeNotFoundError:
1010
version: "1"
1111
code: "GP_PRACTICE_NOT_FOUND"
1212
display: "GP Practice could not be found - invalid resources cannot be retrieved"
13+
diagnostics: "GP Practice could not be found"
1314
severity: error
1415
resourceType: "OperationOutcome"

‎specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ ConsentInvalidIdentifierSystemError:
44
value:
55
issue:
66
- code: invalid
7-
diagnostics: "Invalid request with error - performer:identifier or patient:identifier system parameter is invalid."
87
details:
98
coding:
109
- code: "INVALID_IDENTIFIER_SYSTEM"
1110
display: "Required parameter(s) are invalid."
1211
system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
1312
version: '1'
13+
diagnostics: "Invalid request with error - performer:identifier or patient:identifier system parameter is invalid."
1414
severity: error
1515
resourceType: "OperationOutcome"

‎specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ ConsentInvalidIdentifierError:
44
value:
55
issue:
66
- code: invalid
7-
diagnostics: 'Invalid request with error - performer:identifier or patient:identifier parameter is invalid.'
87
details:
98
coding:
109
- code: "INVALID_IDENTIFIER_VALUE"
1110
display: "Required parameter(s) are invalid."
1211
system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
1312
version: '1'
13+
diagnostics: 'Invalid request with error - performer:identifier or patient:identifier parameter is invalid.'
1414
severity: error
1515
resourceType: "OperationOutcome"
1616

‎specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ ConsentInvalidStatusParameterError:
44
value:
55
issue:
66
- code: invalid
7-
diagnostics: "Invalid request with error - status parameter is invalid."
87
details:
98
coding:
109
- code: "INVALID_PARAMETER"
1110
display: "Required parameter(s) are invalid."
1211
system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
1312
version: "1"
13+
diagnostics: "Invalid request with error - status parameter is invalid."
1414
severity: error
1515
resourceType: "OperationOutcome"

‎specification/examples/responses/GET_Consent/errors/missing-identifier.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ ConsentIdentifierMissingError:
44
value:
55
issue:
66
- code: invalid
7-
diagnostics: "Invalid request with error - performer:identifier or patient:identifier parameter not found."
87
details:
98
coding:
109
- code: "MISSING_IDENTIFIER_VALUE"
1110
display: "Required parameter(s) are missing."
1211
system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
1312
version: "1"
13+
diagnostics: "Invalid request with error - performer:identifier or patient:identifier parameter not found."
1414
severity: error
1515
resourceType: "OperationOutcome"

‎specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ InvalidIdentifierPatientError:
44
value:
55
issue:
66
- code: invalid
7-
diagnostics: "Not a valid NHS Number provided for the 'patient:identifier' parameter"
87
details:
98
coding:
109
- "system": "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
1110
version: "1"
1211
code: "INVALID_PATIENT_IDENTIFIER_VALUE"
1312
display: "Provided value is invalid"
13+
diagnostics: "Not a valid NHS Number provided for the 'patient:identifier' parameter"
1414
severity: error
1515
resourceType: "OperationOutcome"

‎specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ RelatedPersonInvalidIdentifierSystem:
44
value:
55
issue:
66
- code: invalid
7-
diagnostics: The identifier system is not valid.
8-
severity: error
97
details:
108
coding:
119
- code: INVALID_IDENTIFIER_SYSTEM
1210
display: Invalid identifier system.
1311
system: https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode
1412
version: '1'
13+
diagnostics: The identifier system is not valid.
14+
severity: error
1515
resourceType: OperationOutcome

0 commit comments

Comments
 (0)