Skip to content

NPA-4531: Update GET/Consent examples & Postman collection #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lelliott-hippo merged 13 commits into from
Jun 12, 2025
Merged

NPA-4531: Update GET/Consent examples & Postman collection #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8f931da
NPA-4531: Added provision/extension data
kamran-iqbal4-NHSD Jun 4, 2025
788ca8a
NPA-4531: Corrected structure
kamran-iqbal4-NHSD Jun 4, 2025
c272b52
NPA-4531: Commented all verification nodes to test
lelliott-hippo Jun 9, 2025
25436c3
NPA-4531 Postman tests passed with commented verification, now deleting
lelliott-hippo Jun 10, 2025
6c98fc2
NPA-4531 Missed verification node
lelliott-hippo Jun 10, 2025
86fbadd
NPA-4531 Missing verification node
lelliott-hippo Jun 10, 2025
83458a3
NPA-4531 Postman collection update for GET/Consent
lelliott-hippo Jun 10, 2025
172e3ca
NPA-4531 Updated "Run in Postman" button in specification
lelliott-hippo Jun 10, 2025
b196090
NPA-4531 Fixing missed verification node
lelliott-hippo Jun 11, 2025
379ba4a
NPA-4531 Fixed removal of verification nodes
lelliott-hippo Jun 11, 2025
939a749
NPA-4531: Additional verification nodes removed
lelliott-hippo Jun 11, 2025
9517308
NPA-4531: Postman collection update
lelliott-hippo Jun 11, 2025
c744b37
NPA-4531: Point Postman URL at public API
lelliott-hippo Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8,772 changes: 5,071 additions & 3,701 deletions postman/Validate Relationship Service Sandbox.postman_collection.json
View file
Open in desktop

Large diffs are not rendered by default.

51 changes: 44 additions & 7 deletions .../examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
summary: Multiple active relationships including performer and patient details
description:
A Bundle containing multiple active proxy relationships with varying legal basis' including the details
A Bundle containing multiple active proxy relationships with varying legal bases including the details
of the performer and patient.
value:
resourceType: Bundle
Expand Down Expand Up @@ -90,6 +90,28 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
- identifier:
system: "https://fhir.nhs.uk/Id/nhs-number"
value: "9000000017"
provision:
actor:
- reference:
identifier:
system: https://fhir.nhs.uk/Id/nhs-number
value: "9000000017"
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: "2026-02-11"
start: "2025-02-11"
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720"
Expand Down Expand Up @@ -167,12 +189,27 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
- identifier:
system: "https://fhir.nhs.uk/Id/nhs-number"
value: "9000000017"
verification:
- verified: true
verifiedWith:
provision:
actor:
- reference:
identifier:
system: "https://fhir.nhs.uk/Id/nhs-number"
value: "9000000005"
verificationDate: "2024-07-21T17:32:28Z"
system: https://fhir.nhs.uk/Id/nhs-number
value: "9000000017"
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: "2026-02-11"
start: "2025-02-11"
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match
56 changes: 43 additions & 13 deletions specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ConsentMultipleRelationshipsStatusInactiveBundle:
summary: Multiple inactive relationships
description: A Bundle containing multiple inactive proxy relationships with varying legal basis'
description: A Bundle containing multiple inactive proxy relationships with varying legal basis
value:
resourceType: Bundle
timestamp: '2020-08-26T14:00:00+00:00'
Expand Down Expand Up @@ -33,13 +33,28 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
verification:
- verified: true
verifiedWith:
provision:
actor:
- reference:
identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000006'
verificationDate: '2024-07-21T17:32:28Z'
system: https://fhir.nhs.uk/Id/nhs-number
value: '9000000017'
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/ABCD12B3
Expand Down Expand Up @@ -68,12 +83,27 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
verification:
- verified: true
verifiedWith:
provision:
actor:
- reference:
identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000007'
verificationDate: '2024-07-21T17:32:28Z'
system: https://fhir.nhs.uk/Id/nhs-number
value: '9000000017'
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match
104 changes: 86 additions & 18 deletions ...ication/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,28 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
provision:
actor:
- reference:
identifier:
system: https://fhir.nhs.uk/Id/nhs-number
value: '9000000017'
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match

Expand Down Expand Up @@ -62,13 +84,29 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
verification:
- verified: true
verifiedWith:

provision:
actor:
- reference:
identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000005'
verificationDate: '2024-07-21T17:32:28Z'
system: https://fhir.nhs.uk/Id/nhs-number
value: '9000000017'
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match

Expand Down Expand Up @@ -98,13 +136,28 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
verification:
- verified: true
verifiedWith:
provision:
Comment thread
ellie-bound1-NHSD marked this conversation as resolved.
actor:
- reference:
identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000020'
verificationDate: '2024-07-21T17:32:28Z'
system: https://fhir.nhs.uk/Id/nhs-number
value: '9000000017'
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match

Expand Down Expand Up @@ -134,12 +187,27 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
verification:
- verified: true
verifiedWith:
provision:
Comment thread
ellie-bound1-NHSD marked this conversation as resolved.
actor:
- reference:
identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000021'
verificationDate: '2024-07-21T17:32:28Z'
system: https://fhir.nhs.uk/Id/nhs-number
value: '9000000017'
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match
76 changes: 64 additions & 12 deletions specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,28 @@ ConsentMultipleRelationshipsIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
provision:
actor:
- reference:
identifier:
system: https://fhir.nhs.uk/Id/nhs-number
value: '9000000022'
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5
Expand Down Expand Up @@ -121,13 +143,28 @@ ConsentMultipleRelationshipsIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
verification:
- verified: true
verifiedWith:
provision:
actor:
- reference:
identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000005'
verificationDate: '2024-07-21T17:32:28Z'
system: https://fhir.nhs.uk/Id/nhs-number
value: '9000000022'
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/ZPTT32T3
Expand Down Expand Up @@ -184,13 +221,28 @@ ConsentMultipleRelationshipsIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
verification:
- verified: true
verifiedWith:
provision:
Comment thread
ellie-bound1-NHSD marked this conversation as resolved.
actor:
- reference:
identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000006'
verificationDate: '2024-07-21T17:32:28Z'
system: https://fhir.nhs.uk/Id/nhs-number
value: '9000000022'
type: RelatedPerson
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
- coding:
- code: TBC
display: TBC
system: http://terminology.hl7.org/CodeSystem/consent-reason
search:
mode: match

Loading