Skip to content

Commit ff21bec

Browse files
ChristopherBaconChristopherBacon
committed
NPA-5608: example changes and spec changes and postman changes
1 parent e7b37e6 commit ff21bec

20 files changed

+172
-220
lines changed

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

Lines changed: 125 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"info": {
3-
"_postman_id": "4c6e58e9-dd6b-42fc-b6d7-5beac34fa4ea",
4-
"name": "Validated Relationship Service Sandbox 18/09/25",
3+
"_postman_id": "9c6dfa73-ac4f-4497-bca6-c2c4048f7c10",
4+
"name": "Validated Relationship Service Sandbox 29/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",
7-
"_exporter_id": "44536620",
8-
"_collection_link": "https://www.postman.com/ellie-bound1-b2ea016f/workspace/validated-relationship-service-sandbox-18-10-2025/collection/44536620-4c6e58e9-dd6b-42fc-b6d7-5beac34fa4ea?action=share&source=collection_link&creator=44536620"
7+
"_exporter_id": "48873809",
8+
"_collection_link": "https://www.postman.com/christopher-bacon1-3957569/workspace/validated-relationship-service-sandbox-29-09-2025/collection/48873809-9c6dfa73-ac4f-4497-bca6-c2c4048f7c10?action=share&source=collection_link&creator=48873809"
99
},
1010
"item": [
1111
{
@@ -8090,8 +8090,7 @@
80908090
" \"identifier\": {",
80918091
" \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",",
80928092
" \"value\": \"9000000010\"",
8093-
" },",
8094-
" \"type\": \"RelatedPerson\"",
8093+
" }",
80958094
" },",
80968095
" \"role\": {",
80978096
" \"coding\": [",
@@ -8127,7 +8126,8 @@
81278126
"});"
81288127
],
81298128
"type": "text/javascript",
8130-
"packages": {}
8129+
"packages": {},
8130+
"requests": {}
81318131
}
81328132
}
81338133
],
@@ -8190,31 +8190,26 @@
81908190
" \"value\": \"ABC1234567\"",
81918191
" }",
81928192
" ],",
8193-
" \"name\": [",
8194-
" {",
8195-
" \"id\": \"123456\",",
8196-
" \"use\": \"usual\",",
8197-
" \"period\": {",
8198-
" \"start\": \"2020-01-01\",",
8199-
" \"end\": \"2021-12-31\"",
8200-
" },",
8201-
" \"given\": [",
8202-
" \"Sally\"",
8203-
" ],",
8204-
" \"family\": \"Evans\",",
8205-
" \"prefix\": [",
8206-
" \"Mrs\"",
8207-
" ]",
8208-
" }",
8209-
" ],",
8193+
" \"name\": {",
8194+
" \"use\": \"usual\",",
8195+
" \"period\": {",
8196+
" \"start\": \"2020-01-01\",",
8197+
" \"end\": \"2021-12-31\"",
8198+
" },",
8199+
" \"given\": [",
8200+
" \"Sally\"",
8201+
" ],",
8202+
" \"family\": \"Evans\",",
8203+
" \"prefix\": [",
8204+
" \"Mrs\"",
8205+
" ]",
8206+
" },",
82108207
" \"birthDate\": \"1995-10-22\",",
82118208
" \"generalPractitioner\": [",
82128209
" {",
8213-
" \"type\": \"Organization\",",
8214-
" \"identifier\": {",
8215-
" \"value\": \"ODS12345\",",
8216-
" \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\"",
8217-
" }",
8210+
" \"identifier\": null,",
8211+
" \"value\": \"ODS12345\",",
8212+
" \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\"",
82188213
" }",
82198214
" ]",
82208215
" },",
@@ -8289,7 +8284,8 @@
82898284
"});"
82908285
],
82918286
"type": "text/javascript",
8292-
"packages": {}
8287+
"packages": {},
8288+
"requests": {}
82938289
}
82948290
}
82958291
],
@@ -8323,110 +8319,109 @@
83238319
"script": {
83248320
"exec": [
83258321
"const expectedResponseBody = {",
8326-
" \"resourceType\": \"Bundle\",",
8327-
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
8328-
" \"total\": 1,",
8329-
" \"type\": \"searchset\",",
8330-
" \"link\": [",
8322+
" \"resourceType\": \"Bundle\",",
8323+
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
8324+
" \"total\": 1,",
8325+
" \"type\": \"searchset\",",
8326+
" \"link\": [",
83318327
" {",
83328328
" \"relation\": \"self\",",
83338329
" \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer\"",
83348330
" }",
83358331
" ],",
8336-
" \"entry\": [",
8337-
" {",
8338-
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720\",",
8339-
" \"resource\": {",
8340-
" \"resourceType\": \"RelatedPerson\",",
8341-
" \"id\": \"RP974720\",",
8342-
" \"identifier\": [",
8343-
" {",
8344-
" \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",",
8345-
" \"value\": \"9000000010\"",
8346-
" },",
8347-
" {",
8348-
" \"system\": \"https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier\",",
8349-
" \"value\": \"ABC0000008\"",
8350-
" }",
8351-
" ],",
8352-
" \"patient\": {",
8353-
" \"type\": \"Patient\",",
8354-
" \"identifier\": {",
8355-
" \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",",
8356-
" \"value\": \"9000000005\"",
8357-
" }",
8358-
" },",
8359-
" \"relationship\": [",
8360-
" {",
8361-
" \"coding\": [",
8362-
" {",
8363-
" \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\",",
8364-
" \"code\": \"Personal\",",
8365-
" \"display\": \"Personal relationship with the patient\"",
8366-
" }",
8367-
" ]",
8368-
" }",
8369-
" ]",
8370-
" },",
8371-
" \"search\": {",
8372-
" \"mode\": \"include\"",
8373-
" }",
8374-
" },",
8375-
" {",
8376-
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1\",",
8377-
" \"resource\": {",
8378-
" \"resourceType\": \"Consent\",",
8379-
" \"id\": \"WWCC67T1\",",
8380-
" \"status\": \"active\",",
8381-
" \"scope\": {",
8382-
" \"coding\": [",
8383-
" {",
8384-
" \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\",",
8385-
" \"code\": \"patient-privacy\",",
8386-
" \"display\": \"Privacy Consent\"",
8332+
" \"entry\": [",
8333+
" {",
8334+
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720\",",
8335+
" \"resource\": {",
8336+
" \"resourceType\": \"RelatedPerson\",",
8337+
" \"id\": \"RP974720\",",
8338+
" \"identifier\": [",
8339+
" {",
8340+
" \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",",
8341+
" \"value\": \"9000000010\"",
8342+
" },",
8343+
" {",
8344+
" \"system\": \"https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier\",",
8345+
" \"value\": \"ABC0000008\"",
8346+
" }",
8347+
" ],",
8348+
" \"patient\": {",
8349+
" \"identifier\": {",
8350+
" \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",",
8351+
" \"value\": \"9000000005\"",
8352+
" }",
8353+
" },",
8354+
" \"relationship\": [",
8355+
" {",
8356+
" \"coding\": [",
8357+
" {",
8358+
" \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\",",
8359+
" \"code\": \"Personal\",",
8360+
" \"display\": \"Personal relationship with the patient\"",
8361+
" }",
8362+
" ]",
8363+
" }",
8364+
" ]",
8365+
" },",
8366+
" \"search\": {",
8367+
" \"mode\": \"include\"",
83878368
" }",
8388-
" ],",
8389-
" \"text\": \"Patient Privacy Consent\"",
8390-
" },",
8391-
" \"category\": [",
8392-
" {",
8393-
" \"coding\": [",
8394-
" {",
8395-
" \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",",
8396-
" \"code\": \"INFA\",",
8397-
" \"display\": \"Information Access\"",
8398-
" }",
8399-
" ],",
8400-
" \"text\": \"Information Access Consent\"",
8401-
" }",
8402-
" ],",
8403-
" \"patient\": {",
8404-
" \"identifier\": {",
8405-
" \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",",
8406-
" \"value\": \"9000000005\"",
8407-
" }",
84088369
" },",
8409-
" \"dateTime\": \"2024-07-21T17:32:28Z\",",
8410-
" \"performer\": [",
8411-
" {",
8412-
" \"identifier\": {",
8413-
" \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",",
8414-
" \"value\": \"9000000010\"",
8415-
" }",
8416-
" }",
8417-
" ],",
8418-
" \"policy\": [",
8419-
" {",
8420-
" \"authority\": \"https://www.england.nhs.uk\",",
8421-
" \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
8370+
" {",
8371+
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1\",",
8372+
" \"resource\": {",
8373+
" \"resourceType\": \"Consent\",",
8374+
" \"id\": \"WWCC67T1\",",
8375+
" \"status\": \"active\",",
8376+
" \"scope\": {",
8377+
" \"coding\": [",
8378+
" {",
8379+
" \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\",",
8380+
" \"code\": \"patient-privacy\",",
8381+
" \"display\": \"Privacy Consent\"",
8382+
" }",
8383+
" ],",
8384+
" \"text\": \"Patient Privacy Consent\"",
8385+
" },",
8386+
" \"category\": [",
8387+
" {",
8388+
" \"coding\": [",
8389+
" {",
8390+
" \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",",
8391+
" \"code\": \"INFA\",",
8392+
" \"display\": \"Information Access\"",
8393+
" }",
8394+
" ],",
8395+
" \"text\": \"Information Access Consent\"",
8396+
" }",
8397+
" ],",
8398+
" \"patient\": {",
8399+
" \"identifier\": {",
8400+
" \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",",
8401+
" \"value\": \"9000000005\"",
8402+
" }",
8403+
" },",
8404+
" \"dateTime\": \"2024-07-21T17:32:28Z\",",
8405+
" \"performer\": [",
8406+
" {",
8407+
" \"identifier\": {",
8408+
" \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",",
8409+
" \"value\": \"9000000010\"",
8410+
" }",
8411+
" }",
8412+
" ],",
8413+
" \"policy\": [",
8414+
" {",
8415+
" \"authority\": \"https://www.england.nhs.uk\",",
8416+
" \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
8417+
" }",
8418+
" ]",
8419+
" },",
8420+
" \"search\": {",
8421+
" \"mode\": \"match\"",
84228422
" }",
8423-
" ],",
8424-
" },",
8425-
" \"search\": {",
8426-
" \"mode\": \"match\"",
8427-
" }",
8428-
" }",
8429-
" ]",
8423+
" }",
8424+
" ]",
84308425
"}",
84318426
"",
84328427
"pm.test(\"Status code is 200\", function () {",
@@ -8439,7 +8434,8 @@
84398434
"});"
84408435
],
84418436
"type": "text/javascript",
8442-
"packages": {}
8437+
"packages": {},
8438+
"requests": {}
84438439
}
84448440
}
84458441
],
@@ -10240,6 +10236,7 @@
1024010236
"script": {
1024110237
"type": "text/javascript",
1024210238
"packages": {},
10239+
"requests": {},
1024310240
"exec": [
1024410241
""
1024510242
]
@@ -10250,6 +10247,7 @@
1025010247
"script": {
1025110248
"type": "text/javascript",
1025210249
"packages": {},
10250+
"requests": {},
1025310251
"exec": [
1025410252
"pm.test(\"Response has FHIR content type\", () => {",
1025510253
" pm.expect(pm.response.headers.get('Content-Type')).to.include('application/fhir+json');",

‎specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
3030
- system: "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
3131
code: PRN
3232
display: parent
33+
- coding:
3334
- system: "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
3435
code: MTH
3536
display: mother
@@ -64,10 +65,9 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
6465
- PhD
6566
birthDate: "2022-10-22"
6667
generalPractitioner:
67-
- type: "Organization"
68-
identifier:
69-
value: "ODS12345"
70-
system: "https://fhir.nhs.uk/Id/ods-organization-code"
68+
- identifier:
69+
value: "ODS12345"
70+
system: "https://fhir.nhs.uk/Id/ods-organization-code"
7171
search:
7272
mode: include
7373
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9"
@@ -105,7 +105,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
105105
identifier:
106106
system: https://fhir.nhs.uk/Id/nhs-number
107107
value: "9000000017"
108-
type: RelatedPerson
109108
role:
110109
coding:
111110
- code: PRN
@@ -162,10 +161,9 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
162161
- Mrs
163162
birthDate: "1995-10-22"
164163
generalPractitioner:
165-
- type: "Organization"
166-
identifier:
167-
value: "ODS12345"
168-
system: "https://fhir.nhs.uk/Id/ods-organization-code"
164+
- identifier:
165+
value: "ODS12345"
166+
system: "https://fhir.nhs.uk/Id/ods-organization-code"
169167
search:
170168
mode: include
171169
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1"
@@ -203,7 +201,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
203201
identifier:
204202
system: https://fhir.nhs.uk/Id/nhs-number
205203
value: "9000000017"
206-
type: RelatedPerson
207204
role:
208205
coding:
209206
- code: PRN

‎specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
4545
identifier:
4646
system: https://fhir.nhs.uk/Id/nhs-number
4747
value: '9000000017'
48-
type: RelatedPerson
4948
role:
5049
coding:
5150
- code: PRN
@@ -91,7 +90,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
9190
identifier:
9291
system: https://fhir.nhs.uk/Id/nhs-number
9392
value: '9000000017'
94-
type: RelatedPerson
9593
role:
9694
coding:
9795
- code: PRN

0 commit comments

Comments
 (0)