Skip to content

NPA-5825: Updated examples and postman to align with Proxy Role Data … #267

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
ellie-bound1-NHSD merged 8 commits into from
Nov 26, 2025
Merged

NPA-5825: Updated examples and postman to align with Proxy Role Data … #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
12792f4
NPA-5825: Updated examples and postman to align with Proxy Role Data …
ellie-bound1-NHSD Nov 21, 2025
f9675f3
NPA-5825: Fixing Schema and reference to new error response example
ellie-bound1-NHSD Nov 21, 2025
e5d28a4
Update specification/examples/requests/POST_Consent/adult_to_adult_pr…
ellie-bound1-NHSD Nov 26, 2025
b302b97
Update specification/examples/responses/GET_Consent/filtered-relation…
ellie-bound1-NHSD Nov 26, 2025
d693534
Update specification/examples/requests/POST_Consent/parent_child_prox…
ellie-bound1-NHSD Nov 26, 2025
f15fc6c
Update specification/examples/responses/GET_Consent/filtered-relation…
ellie-bound1-NHSD Nov 26, 2025
311ea63
NPA-5825: Fix Postman collection
ellie-bound1-NHSD Nov 26, 2025
c500bfd
Update specification/examples/responses/GET_Consent/single-mother-chi…
ellie-bound1-NHSD Nov 26, 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
1,200 changes: 964 additions & 236 deletions postman/Validated Relationship Service Sandbox.postman_collection.json
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ ConsentAdultToAdultGuardianRequest:
status: active
scope:
coding:
- system: "http://terminology.hl7.org/CodeSystem/consentscope"
- system: "https://terminology.hl7.org/CodeSystem/consentscope"
code: patient-privacy
display: "Privacy Consent"
text: "Patient Privacy Consent"
category:
- coding:
- system: "http://terminology.hl7.org/CodeSystem/v3-ActCode"
- system: "https://terminology.hl7.org/CodeSystem/v3-ActCode"
code: INFA
display: "Information Access"
text: "Information Access Consent"
Expand All @@ -32,9 +32,9 @@ ConsentAdultToAdultGuardianRequest:
actor:
- role:
coding:
- system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
code: GUARD
display: Guardian
- system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
code: court-appointed-personal-welfare-deputy
display: Court appointed personal welfare deputy
reference:
type: RelatedPerson
identifier:
Expand All @@ -44,6 +44,6 @@ ConsentAdultToAdultGuardianRequest:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
coding:
- system: http://terminology.hl7.org/CodeSystem/consent-reason
code: TBC
display: TBC
- system: https://terminology.hl7.org/CodeSystem/consent-reason
code: ROLE_CREATED
display: Role created from scratch by GP
16 changes: 8 additions & 8 deletions specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ ConsentParentChildProxyCreationRequest:
status: active
scope:
coding:
- system: "http://terminology.hl7.org/CodeSystem/consentscope"
- system: "https://terminology.hl7.org/CodeSystem/consentscope"
code: patient-privacy
display: "Privacy Consent"
text: "Patient Privacy Consent"
category:
- coding:
- system: "http://terminology.hl7.org/CodeSystem/v3-ActCode"
- system: "https://terminology.hl7.org/CodeSystem/v3-ActCode"
code: INFA
display: "Information Access"
text: "Information Access Consent"
Expand All @@ -33,9 +33,9 @@ ConsentParentChildProxyCreationRequest:
actor:
- role:
coding:
- system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
code: PRN
display: Parent
- system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
code: parental-responsibility
display: Parental responsibility
reference:
type: RelatedPerson
identifier:
Expand All @@ -45,6 +45,6 @@ ConsentParentChildProxyCreationRequest:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
coding:
- system: http://terminology.hl7.org/CodeSystem/consent-reason
code: TBC
display: TBC
- system: https://terminology.hl7.org/CodeSystem/consent-reason
code: ROLE_CREATED
display: Role created from scratch by GP
34 changes: 24 additions & 10 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
Expand Up @@ -77,13 +77,13 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
status: active
scope:
coding:
- system: "http://terminology.hl7.org/CodeSystem/consentscope"
- system: "https://terminology.hl7.org/CodeSystem/consentscope"
code: patient-privacy
display: "Privacy Consent"
text: "Patient Privacy Consent"
category:
- coding:
- system: "http://terminology.hl7.org/CodeSystem/v3-ActCode"
- system: "https://terminology.hl7.org/CodeSystem/v3-ActCode"
code: INFA
display: "Information Access"
text: "Information Access Consent"
Expand All @@ -107,12 +107,19 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
value: "9000000017"
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
- code: parental-responsibility
display: Parental responsibility
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
period:
end: "2026-02-11"
start: "2025-02-11"
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
coding:
- system: https://terminology.hl7.org/CodeSystem/consent-reason
code: ROLE_CREATED
display: Role created from scratch by GP
search:
mode: match
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720"
Expand Down Expand Up @@ -173,13 +180,13 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
status: active
scope:
coding:
- system: "http://terminology.hl7.org/CodeSystem/consentscope"
- system: "https://terminology.hl7.org/CodeSystem/consentscope"
code: patient-privacy
display: "Privacy Consent"
text: "Patient Privacy Consent"
category:
- coding:
- system: "http://terminology.hl7.org/CodeSystem/v3-ActCode"
- system: "https://terminology.hl7.org/CodeSystem/v3-ActCode"
code: INFA
display: "Information Access"
text: "Information Access Consent"
Expand All @@ -203,11 +210,18 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
value: "9000000017"
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
- code: parental-responsibility
display: Parental responsibility
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
period:
end: "2026-02-11"
start: "2025-02-11"
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
coding:
- system: https://terminology.hl7.org/CodeSystem/consent-reason
code: ROLE_CREATED
display: Role created from scratch by GP
search:
mode: match
34 changes: 24 additions & 10 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
Expand Up @@ -17,13 +17,13 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
status: inactive
scope:
coding:
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
code: patient-privacy
display: Privacy Consent
text: Patient Privacy Consent
category:
- coding:
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
code: INFA
display: Information Access
text: Information Access Consent
Expand All @@ -47,12 +47,19 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
value: '9000000017'
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
- code: parental-responsibility
display: Parental responsibility
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
coding:
- system: https://terminology.hl7.org/CodeSystem/consent-reason
code: ROLE_DEACTIVATED_END_DATE_REACHED
display: End-date reached
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/ABCD12B3
Expand All @@ -62,13 +69,13 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
status: inactive
scope:
coding:
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
code: patient-privacy
display: Privacy Consent
text: Patient Privacy Consent
category:
- coding:
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
code: INFA
display: Information Access
text: Information Access Consent
Expand All @@ -92,11 +99,18 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
value: '9000000017'
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
- code: parental-responsibility
display: Parental responsibility
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
coding:
- system: https://terminology.hl7.org/CodeSystem/consent-reason
code: ROLE_DEACTIVATED_END_DATE_REACHED
display: End-date reached
search:
mode: match
68 changes: 48 additions & 20 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 @@ -17,13 +17,13 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
status: active
scope:
coding:
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
code: patient-privacy
display: Privacy Consent
text: Patient Privacy Consent
category:
- coding:
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
code: INFA
display: Information Access
text: Information Access Consent
Expand All @@ -47,12 +47,19 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
value: '9000000017'
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
- code: parental-responsibility
display: Parental responsibility
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
coding:
- system: https://terminology.hl7.org/CodeSystem/consent-reason
code: ROLE_CREATED
display: Role created from scratch by GP
search:
mode: match

Expand All @@ -63,13 +70,13 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
status: active
scope:
coding:
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
code: patient-privacy
display: Privacy Consent
text: Patient Privacy Consent
category:
- coding:
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
code: INFA
display: Information Access
text: Information Access Consent
Expand All @@ -93,12 +100,19 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
value: '9000000017'
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
- code: parental-responsibility
display: Parental responsibility
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
coding:
- system: https://terminology.hl7.org/CodeSystem/consent-reason
code: ROLE_CREATED
display: Role created from scratch by GP
search:
mode: match

Expand All @@ -109,13 +123,13 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
status: proposed
scope:
coding:
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
code: patient-privacy
display: Privacy Consent
text: Patient Privacy Consent
category:
- coding:
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
code: INFA
display: Information Access
text: Information Access Consent
Expand All @@ -139,12 +153,19 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
value: '9000000017'
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
- code: parental-responsibility
display: Parental responsibility
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
coding:
- system: https://terminology.hl7.org/CodeSystem/consent-reason
code: APPLICATION_SUBMITTED
display: Application submitted online
search:
mode: match

Expand All @@ -155,13 +176,13 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
status: proposed
scope:
coding:
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
code: patient-privacy
display: Privacy Consent
text: Patient Privacy Consent
category:
- coding:
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
code: INFA
display: Information Access
text: Information Access Consent
Expand All @@ -185,11 +206,18 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
value: '9000000017'
role:
coding:
- code: PRN
display: Parent
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
- code: parental-responsibility
display: Parental responsibility
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
period:
end: '2026-02-11'
start: '2025-02-11'
extension:
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
valueCodeableConcept:
coding:
- system: https://terminology.hl7.org/CodeSystem/consent-reason
code: APPLICATION_SUBMITTED
display: Application submitted online
search:
mode: match
Loading
Loading