diff --git a/specification/examples/requests/PATCH_Consent/multiple_updates.yaml b/specification/examples/requests/PATCH_Consent/multiple_updates.yaml new file mode 100644 index 00000000..bbe7442e --- /dev/null +++ b/specification/examples/requests/PATCH_Consent/multiple_updates.yaml @@ -0,0 +1,22 @@ +MultipleUpdates: + summary: Set status to active with an end date + description: | + Example of a combined update to a record. + The status will be changed to active. + The relationship will be considered as ended following this date. + value: + - op: replace + path: /status + value: active + - op: add + path: /extension/- + value: + - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason + valueCodeableConcept: + coding: + - system: http://terminology.hl7.org/CodeSystem/consent-reason + code: "ROLE_ACTIVATED" + display: "Role activated" + - op: add + path: /provision/period/end + value: "2026-12-31T23:59:59Z" diff --git a/specification/examples/requests/PATCH_Consent/replace_legal_basis.yaml b/specification/examples/requests/PATCH_Consent/replace_legal_basis.yaml new file mode 100644 index 00000000..e69de29b diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml index c4686c3f..3d9fb7f7 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml @@ -88,7 +88,7 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: dateTime: "2024-07-21T17:32:28Z" policy: - authority: "https://www.england.nhs.uk" - uri: "REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -99,6 +99,8 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -193,7 +195,7 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: dateTime: "2024-07-21T17:32:28Z" policy: - authority: "https://www.england.nhs.uk" - uri: "REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -204,6 +206,8 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml index aa4b1ea6..6a2473be 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml @@ -31,8 +31,8 @@ ConsentMultipleRelationshipsStatusInactiveBundle: value: '9000000006' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -43,6 +43,8 @@ ConsentMultipleRelationshipsStatusInactiveBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -84,8 +86,8 @@ ConsentMultipleRelationshipsStatusInactiveBundle: value: '9000000007' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -96,6 +98,8 @@ ConsentMultipleRelationshipsStatusInactiveBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml index c925499c..3cb99a6c 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml @@ -31,8 +31,8 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: value: '9000000009' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -43,6 +43,8 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -90,18 +92,20 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: value: '9000000005' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: - reference: identifier: - system: https://fhir.nhs.uk/Id/nhs-number + system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000017' period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -149,8 +153,8 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: value: '9000000020' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -161,6 +165,8 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -208,8 +214,8 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: value: '9000000021' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -220,6 +226,8 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml index 6118be44..12aa3fb8 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml @@ -63,8 +63,8 @@ ConsentMultipleRelationshipsIncludePatientBundle: value: "9000000009" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -75,6 +75,8 @@ ConsentMultipleRelationshipsIncludePatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -150,8 +152,8 @@ ConsentMultipleRelationshipsIncludePatientBundle: value: "9000000005" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -162,6 +164,8 @@ ConsentMultipleRelationshipsIncludePatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -237,8 +241,8 @@ ConsentMultipleRelationshipsIncludePatientBundle: value: "9000000006" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -249,6 +253,8 @@ ConsentMultipleRelationshipsIncludePatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml index 55990492..99b243c7 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml @@ -87,8 +87,8 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: value: "9000000009" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -99,6 +99,8 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -193,8 +195,8 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: value: "9000000005" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -205,6 +207,8 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -299,8 +303,8 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: value: "9000000006" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -311,6 +315,8 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml index 48e91fba..fdf4cdba 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml @@ -56,8 +56,8 @@ ConsentMultipleRelationshipsIncludePerformerBundle: value: '9000000009' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -68,6 +68,8 @@ ConsentMultipleRelationshipsIncludePerformerBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -135,8 +137,8 @@ ConsentMultipleRelationshipsIncludePerformerBundle: value: '9000000005' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -147,6 +149,8 @@ ConsentMultipleRelationshipsIncludePerformerBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -214,8 +218,8 @@ ConsentMultipleRelationshipsIncludePerformerBundle: value: '9000000006' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -226,6 +230,8 @@ ConsentMultipleRelationshipsIncludePerformerBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml index 4940c89a..36e63769 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml @@ -60,8 +60,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: value: "9000000100" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -72,6 +72,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -118,8 +120,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: value: "9000000100" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -130,6 +132,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -176,8 +180,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: value: "9000000100" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -188,6 +192,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml index efc18a0a..e78a842c 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml @@ -82,8 +82,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: value: "9000000100" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -94,6 +94,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -158,8 +160,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: value: "9000000100" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -170,6 +172,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -234,8 +238,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: value: "9000000100" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -246,6 +250,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: period: end: "2026-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml index 593ebf55..e2436536 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml @@ -53,8 +53,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: value: '9000000100' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -65,6 +65,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -129,8 +131,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: value: '9000000100' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -141,6 +143,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -205,8 +209,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: value: '9000000100' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -217,6 +221,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml index 30c14904..0a9e96e8 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml @@ -31,8 +31,8 @@ ConsentMultipleRelationshipsSinglePatientBundle: value: '9000000100' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -43,6 +43,8 @@ ConsentMultipleRelationshipsSinglePatientBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -89,8 +91,8 @@ ConsentMultipleRelationshipsSinglePatientBundle: value: '9000000100' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -101,6 +103,8 @@ ConsentMultipleRelationshipsSinglePatientBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -147,8 +151,8 @@ ConsentMultipleRelationshipsSinglePatientBundle: value: '9000000100' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -159,6 +163,8 @@ ConsentMultipleRelationshipsSinglePatientBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships.yaml b/specification/examples/responses/GET_Consent/multiple-relationships.yaml index 768617a5..68cbd7bd 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships.yaml @@ -31,8 +31,8 @@ ConsentMultipleRelationshipsBundle: value: '9000000009' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -43,6 +43,8 @@ ConsentMultipleRelationshipsBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -89,8 +91,8 @@ ConsentMultipleRelationshipsBundle: value: '9000000005' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -101,6 +103,8 @@ ConsentMultipleRelationshipsBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: @@ -147,8 +151,8 @@ ConsentMultipleRelationshipsBundle: value: '9000000006' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -159,6 +163,8 @@ ConsentMultipleRelationshipsBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml index 1f2011fa..271403c9 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml @@ -60,8 +60,8 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle: value: "9000000005" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -72,6 +72,8 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle: period: end: "2029-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml index 72d243a2..7908be39 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml @@ -81,8 +81,8 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle: value: "9000000005" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -93,6 +93,8 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle: period: end: "2029-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml index 7957a585..166d4602 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml @@ -51,8 +51,8 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerBundle: value: '9000000005' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -63,6 +63,8 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerBundle: period: end: "2029-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml index 423399b1..e9bdb248 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml @@ -31,8 +31,8 @@ ConsentSingleConsentingAdultRelationshipBundle: value: '9000000005' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -43,6 +43,8 @@ ConsentSingleConsentingAdultRelationshipBundle: period: end: '2026-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml index 51011e78..ea945f73 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml @@ -60,8 +60,8 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle: value: "9000000009" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -69,6 +69,8 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle: identifier: system: https://fhir.nhs.uk/Id/nhs-number value: '9000000019' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml index 6572d0fe..13424880 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml @@ -85,8 +85,8 @@ ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle: value: "9000000009" dateTime: "2024-07-21T17:32:28Z" policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: "https://www.england.nhs.uk" + uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" provision: type: permit actor: @@ -97,6 +97,8 @@ ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle: period: end: "2029-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml index e54189fb..337ee62f 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml @@ -54,8 +54,8 @@ ConsentSingleAdultChildRelationshipIncludePerformerBundle: value: '9000000009' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -66,6 +66,8 @@ ConsentSingleAdultChildRelationshipIncludePerformerBundle: period: end: "2029-02-11" start: "2025-02-11" + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml index d28196b6..5a9287aa 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml @@ -31,8 +31,8 @@ ConsentSingleAdultChildRelationshipUnknownLegalBasisBundle: value: '9000000119' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' code: unknown display: Unknown legal basis provision: @@ -46,6 +46,8 @@ ConsentSingleAdultChildRelationshipUnknownLegalBasisBundle: period: start: '2025-02-11' end: '2026-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason valueCodeableConcept: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml index ed0c1f04..a96d5fbe 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml @@ -31,8 +31,8 @@ ConsentSingleAdultChildRelationshipBundle: value: '9000000009' dateTime: '2024-07-21T17:32:28Z' policy: - - authority: https://www.england.nhs.uk - uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD + - authority: 'https://www.england.nhs.uk' + uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' provision: type: permit actor: @@ -43,6 +43,8 @@ ConsentSingleAdultChildRelationshipBundle: period: end: '2029-02-11' start: '2025-02-11' + meta: + lastUpdated: '2025-02-17T14:30:00Z' extension: - url: "http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis" valueCodeableConcept: diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml index f0f106b8..b782975c 100644 --- a/specification/validated-relationships-service-api.yaml +++ b/specification/validated-relationships-service-api.yaml @@ -6,31 +6,28 @@ info: version: "1.16.0" description: | ## Overview - Use this API to access the Validated Relationships Service - the national electronic database of relationships - that have been verified for the purpose of enabling citizens to access patient facing services on behalf of - (as a proxy for) patients they care for. - - The relationships held by this service are strictly for the purpose of enabling access to healthcare services. - This is in contrast to the relationships held by the Personal Demographics Service (PDS), which are largely to - support the provision of direct care. - - You can: - - - get verified relationships (to support decision making when granting proxy access) - - create a new proxy access request - - get proxy roles - - In the future you will be able to: - - - update a proxy access request - - update a proxy relationship - - delete (revoke) a proxy relationship + This service underpins the National Proxy Programme whose core objective is to allow Patients to be supported with + their healthcare by someone they trust (a Proxy) as part of a digitally-enabled journey. The service has two core + uses. Firstly, it surfaces verified candidate relationships (i.e. indicates suitable Proxies for a Patient such as + Birth Mothers) to support GP’s decision-making when granting Proxy access. Secondly, it supports the subsequent + creation, use and management of Proxy roles which are stored in a central, national database. The Proxy roles held + by the database are strictly for the purpose of enabling access to healthcare services, initially in Primary Care. + + With this service you can: + + - Create a new Proxy access request (Submit an online application via NHS App) + - View Pending Proxy access requests + - Get verified candidate relationships (to support decision making when granting proxy access) + - Create a Proxy role + - Get Proxy roles + - Get a Proxy role by ID + - Update (or revoke) a Proxy role ## Who can use this API This API can only be used where there is a legal basis to do so. Make sure you have this and a valid use case before - you go too far with your development by [contacting us](https://digital.nhs.uk/developer/help-and-support) + you go too far with your development by [contacting us](https://digital.nhs.uk/developer/help-and-support). - You must do this before you can go live (see 'Onboarding' below). + You must do this before you can go live (see the 'Onboarding' section below). ## Related APIs The following APIs are related to this API: @@ -60,6 +57,12 @@ info: There are [libraries and SDKs available](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) to help with FHIR API integration. + ## Guidance for developers + + Supplementary documentation and guidance for developers: + + - National Proxy Service developer documentation (link to be added) + ## Network access This API is available on the internet. @@ -77,6 +80,8 @@ info: For more information on access modes and how to use them, see the developer [security and authorisation guide](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation). + Each API operation section of this documentation indicates the access modes that the endpoint supports. + ### User-restricted access User-restricted access meaning an end user must be present, authenticated and authorised. @@ -86,7 +91,8 @@ info: [Review all patient access modes](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#patient-access-mode) - Validated Relationships Service API checks the patient is P9 verified and has a high [vector of trust](https://nhsconnect.github.io/nhslogin/vectors-of-trust/) (VOT). + All API endpoints that support this access mode require that the user has proven their identity to a high level + and authenticated using strong authentication credentials. The combination of these forms a [Vector of Trust](https://nhsconnect.github.io/nhslogin/vectors-of-trust/) profile. Allowed vectors of trust are: - `P9.Cp.Cd` @@ -94,13 +100,15 @@ info: - `P9.Cm` #### Healthcare worker access mode - If the end user is a healthcare worker then you must use this access mode. + If the end user is a healthcare worker then you must use this access mode. All API endpoints that support this + access mode require that the user has been authenticated with a "very high confidence" authenticator ([AAL3](https://digital.nhs.uk/services/care-identity-service/applications-and-services/cis2-authentication/integrate/design-and-build/authenticator-guidance-for-developers)). [Review all CIS2 healthcare worker access modes](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#healthcare-worker-access-mode) ### Application-restricted access - This API is application-restricted, meaning we authenticate the calling application but not the end user. + This API is application-restricted, meaning we authenticate the calling application but not the end user. This + should only be utilised where user-restrcited access modes are not feasible or practical. [Review all application-restricted access modes](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis) @@ -114,7 +122,7 @@ info: * 400 to 499 if it failed because of a client error by your application * 500 to 599 if it failed because of an error on our server - Errors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors. + Errors specific to each API are shown in the Operations section. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more information on errors. ## Open source You might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful: @@ -125,7 +133,7 @@ info: | FHIR libraries and SDKs | Various open source libraries for integrating with FHIR APIs. | [FHIR libraries and SDKs](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) | | nhs-number | Python package containing utilities for NHS numbers including validity checks, normalisation and generation. | [GitHub repo](https://github.com/uk-fci/nhs-number) \| [Python Package index](https://pypi.org/project/nhs-number/) \| [Docs](https://nhs-number.uk-fci.tech/) | - We currently don't have any open source client libraries or sample code for this API and the source code for the PDS FHIR back end (the Core Spine source code) is not currently in the open. If you think this would be useful, [contact us](https://digital.nhs.uk/developer/help-and-support). + We currently don't have any open source client libraries or sample code for this API and the source code for the Validated Relationship Service FHIR application is not currently in the open. If you think this would be useful, [contact us](https://digital.nhs.uk/developer/help-and-support). ## Environments and testing | Environment | Base URL | @@ -147,7 +155,7 @@ info: Our [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing) * is for formal integration testing - * includes authorisation with NHS Login + * requires authorisation using a supported access mode [Run In Postman](https://app.getpostman.com/run-collection/50544839-b6783b4e-de59-42c6-a80e-72cf64fa5ec9?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D50544839-b6783b4e-de59-42c6-a80e-72cf64fa5ec9%26entityType%3Dcollection%26workspaceId%3D082e43b8-9a51-4a16-af66-0d2b233cd69c#?env%5BINT%5D=[{"key":"cis2_token","value":"","enabled":true,"type":"secret","sessionValue":"qMBvg5UHwI1sy7QlxYKPsUqzFhAr","completeSessionValue":"qMBvg5UHwI1sy7QlxYKPsUqzFhAr","sessionIndex":0},{"key":"login_token","value":"","enabled":true,"type":"secret","sessionValue":"j9w15LLkUcmks9MysAGljfMoK0gF","completeSessionValue":"j9w15LLkUcmks9MysAGljfMoK0gF","sessionIndex":1},{"key":"api_base_url","value":"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4","enabled":true,"type":"default","sessionValue":"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4","completeSessionValue":"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4","sessionIndex":2},{"key":"vrs_api_private_key","value":"","enabled":true,"type":"secret","sessionValue":"-----BEGIN PRIVATE...","completeSessionValue":"-----BEGIN PRIVATE KEY-----\\nMIIJQQIBADANBgkqhkiG9w0BAQEFAASCCSswggknAgEAAoICAQDU08aPbVrLQGDw\\nLa66SXySssXSgEVkuyqoWTbFmeeWFUilywLK0jui4ir29WUZujj6kt5h90WZ0DyJ\\niwIOe9bPuYgmtvjoQciVgRvQBxRVXc8IRyoyEgWJXeX1QuOTUUXFpOeseAr9rWyx\\nbU50zMMLZ7DKHwYePiMdmshLhPb6mgRpGPizlxRCQqzDbqW8tDC5ahZaCyPmqahJ\\naqiK82AcimnO/Qge1cwRJ0kLSgtdnmKxFTZonnV9bIsl05Hks37GOzKpzdKtpPYv\\naBhhYUFscn2Gx+Rlhpj6QgRKep5JCQsuS11mBJ3a6eVCEyYkuNtytYXxiPvarXVN\\nUdZHCKMozcqJMLzWfUJAoTXkp1RwEDdl5sLyO9lnfXNtvJbLv8hAjSIOO/cEB8bK\\nVerWb9npK19xqxRF3Du2b8WpynG0EigmM+IUnEXB6LUCqYjbV9tz33T0R3Pdhx4X\\nF8vKsXv6WCXUyUZKMJ/AU02svobYmWrp91DtGbw/XgJEf0aIU2K3ZLdT75yEdOXz\\n++aY5m7V23lJAB83Sz8OTuAmb2Gdcr/WlXEHz4nqvk4mPRSzsqaUzpW8JrKWAGBL\\nSRtmU8uaHgY0yahFzH5kM7/hkSSA6hyDih1qy90J2Q7K4CW+lOKndNa6ZA8teSAc\\nnwtpyh0VI/rwp7MDneVy/LuCWQSGNwIDAQABAoICAE77HIfjnDsrdA4N1fb6CInk\\nYDeDNL1yHB2HpiTkvaXb1i74zNt583m6Fxm47cEDc9vBn1eZzTGMrrqYZLX9TTWf\\nc6BybKK8rvSUij7EMc6QVqGKz2TvfTCCMTG4lf34vjzfur4tel6z+k9J8kC0MHnO\\nDDSmGL4mbx+wbj5gZMuRVquuAbWcDn+cgMKyED2cXSyh6xOVaMhUE8jTFSMjuHo+\\n/486JcZTrzx6aMgQvXELszJmXd+rVoyqOGVcQ5ss5ZIpK98KK/IW8uma5tlUn1Pg\\nlSbsjZ0Du0e8Mh11rcIK4iRXAZ03f2FbRaIkuxYLqBzEsqV1IYoArzR3d167HNj9\\nbBbaxIWOp4ARjsSPr3rC2eMItvo8x8ecTnigieKebIrUs/q1/A4abeYzbONoRYXd\\npYG8A0yESGXjCyGvmvC/Y+CHiJbU5pvJCCQO/TseGmDwCz6MINWN+sJZZGiNbu2z\\nz2F3FTVRxU9S8WQWsbflE282ZbyT3X75uMS3dnYN3mkp56k/FBdYvfS8S7Em/3NZ\\nNdmKn2/7BpydEZJOQb+HHuRmankOXTEfQOZPNRmxESSVPrDifLiXK8S2+YooAvDD\\n/jwo8mkqNeUcD99aYkaNNv4rKh6iF+RfhoJo9hqH9QBGk0PfzMnr7L4AaMptdKWn\\n+CK/2nGUWqfmeHYjavNhAoIBAQDsBAHSOhWCByEAOY4gnoxOgorx2B9GFORtNjQ+\\nxm1uxgpyjk5DaT+4ACWZES/uskbHSWCnU+e1yMZ1StQ9fZGpcrVjngFI9tLTmwVg\\nsrlpPjVCiGKT3Gs2CChv6pzybtcwSDBV5XlEdMrvfEADPDiDBgd5rNPUFaB3IT2c\\niRG2SzT1FEcf0MT4x72d/1QHmhhTZ0OkLDI2sHN89Wr4kCS+QxNXf6XzsQyCZpj+\\nOwdIg3uyiRDhx/GmwP0UtbsurRgwKqUZf+iktwZtGbjzC+YZjaMOsX7dY3aHU247\\nvCoFg9mdmggWt37twRY0lcJzszb0/W6n03MpjyruHNtl+HKRAoIBAQDm2SAHDslp\\nJvLHByhH/zKfpf50RRLQBYlo3cFpflwPhoIr+npn3hFghcly1My7mxSt4RXvb6ZU\\noH3c2Wl+ocFQll5+gphriMbl/QrRxm/0+if3pQ+Dc+S5emNH7Z7xfH09LglDQd2j\\nVSUyINz9P6wW0noo9fgkCns/mAZ5BtrZIGdOvB8Az7Y2mhYiR8FM11jdlKDyo1fU\\ndW4/CWv8KNlgSVEziL1PMptORZ2aArm6Y19wfupkG+GZ8TK0CAS0NP5AQ8l2eEZ0\\nfaPAo5NQ1FsIf1jgIVOpcM1wVPTMqHI8CAQFnnTHE/CueoJIaRkWksKBKFHNNc8N\\n0q8oJCVAMMBHAoIBAHRwgamDKItPExP2UU18i0JMm1o3wy4jLpNG872ozeKh6BOe\\na7RMX7hasjHzTc+YutylMf87oQyJcof5k/6GTe/ofN8Z3A5wX5EwYRXU9y6aF1Ks\\n0N2cGHS+z5xvhmEBGD9kzhwCq7J/YIOIrFgsRME3n0aDYrq2tMUxbCEnasqiDg1/\\npJtot1T5zm39wypA9xFm1/NOLrPWmBOlTNI24znPA+LeQjSZO8+16HM9EhnPbJ6n\\niuGpcGpRukqWYjPkCBPzZiLPfSqOdagr0ZhvXWVsAG9GWI3G/XpEShVEfwLbiuh7\\nTtROUVvhMCBfZmEIoOt7gTVhV+bAEHELYZ7MVVECggEAfH/jLwtBgs13p/FrPxEa\\nK1Hp3qkWEUy7I+xdEFkOq2zerXtEItp4QrdEwwKTfCaSS4iWPPDZItD/sGks5Re1\\n25GNWutx6qT0qDsFZ8d+v/9eKMhDiqCpXYLtInC8BP8fyCwY4MYYE6urCNMCfC6n\\n0BMpwQePEVj5yX1jGEijJPC95o+8pMJhQiduAoTyck+95JrxBosjpjjDAYpCS9d4\\nDN7dxU5c0ua3LcqLyfDoW+aWJWS9YspKrKyRrNiaONpPuTcV4yfQz6im9REDNVeh\\n1P5hX1d5+GsW0RtwfyPloAyupp0j2+4cIu19cDIGTs9NyTyGiYcYqRrUTnDYCjuA\\npwKCAQAWxQxWBzNvx/ZMdYP+J7y7wT9ScRXdty2TilRtulSLjFfluntBqAue5eY6\\n5cHMDjw7Oej8fhQWt3vb/qPpDywh9tSKHBGBqYtI+sBEv7nKj5G/NuVYHX8En8po\\nsZSRza/qqxwRL6mhzi49F8J9dgYXrKS9z9JCi1YEIBW05cLiTY9dVb8fEm0r2YM8\\nBNf454Le4mSZrRN4h0nDL7Lg7LLZyyo9KVcsYCHnkCaFU3MKCeNzydF8azrgadSo\\nqC32nLbH1Y0SyRhE3Q39YCUeFzNYo9wwynzefjFupsrrCqhAOe1gC+Q1124tFMZu\\nKEHw2ABBEOW+MN2vFWpFyZpeTx9N\\n-----END PRIVATE KEY-----","sessionIndex":3},{"key":"nhs_developer_account_api_key","value":"","enabled":true,"type":"secret","sessionValue":"4hwivpJAZIqvpJlAWOctRXCSgUMlwZuK","completeSessionValue":"4hwivpJAZIqvpJlAWOctRXCSgUMlwZuK","sessionIndex":4},{"key":"consent_app_auth_header_value","value":"","enabled":true,"type":"secret","sessionValue":"CSVcbotAQGbhLqGZn1VTFGcQntAE","completeSessionValue":"CSVcbotAQGbhLqGZn1VTFGcQntAE","sessionIndex":5},{"key":"tpp_9674998535_access_token","value":"","enabled":true,"type":"secret","sessionValue":"{\"AccountId\":\"552869834\",\"Passphrase\":\"vRJqu139d7dverZg+8eW7vWFSCaSnwAWFR6Y4tYXjP7/uFSgtv7k2IOwA478OWp7ZDq4MBYC6hcTITErnNwgbxVm7VZ8f3QUnL...","completeSessionValue":"{\"AccountId\":\"552869834\",\"Passphrase\":\"vRJqu139d7dverZg+8eW7vWFSCaSnwAWFR6Y4tYXjP7/uFSgtv7k2IOwA478OWp7ZDq4MBYC6hcTITErnNwgbxVm7VZ8f3QUnLPWh+4K7EP5i/4K0AdGZ0IK0Uw7+C7XZc7FHg8RScIjh+2MqF7vuZ44umePvg8eSM48WR8K4XE=\",\"ProviderId\":\"b891fc3b51d5e7c1\",\"Im1CacheKey\":\"z8ElCDI3e1slWLbZsIRUwihy8WZFscr2dPmTfUui+gAqQ7Zh0WPVIXo/M9DuEVzO3XaFOpbB3wc9yhAUhAZhUg==\"}","sessionIndex":6},{"key":"tpp_9674998454_access_token","value":"","enabled":true,"type":"secret","sessionValue":"{\"AccountId\":\"858803203\",\"Passphrase\":\"JW4HsrWMl4HHMjlx9BIUnsS5uBJfqAlZy4/eYmKwku9UFQ/LACmOGmmXbd8oyUFb0v74MxnEf+9zQWOA44AKOIt7lKEvRIo5Mc...","completeSessionValue":"{\"AccountId\":\"858803203\",\"Passphrase\":\"JW4HsrWMl4HHMjlx9BIUnsS5uBJfqAlZy4/eYmKwku9UFQ/LACmOGmmXbd8oyUFb0v74MxnEf+9zQWOA44AKOIt7lKEvRIo5McB5NjvZNBBihLLO67Oq6oJcLylzCG1ZeHjLIx12kRt0nVDsvjCb216nFnDbOf5i1AaXmpStUHc\\u003d\",\"ProviderId\":\"b891fc3b51d5e7c1\",\"Im1CacheKey\":\"k0YOYWsTtmxgkVZSYp5ay+hGzyF2YHSpA6bzqA6G87b9kqn+GO/WCq4DTbCdHHhdRfBEXae8TShGkii8KuBwwA\\u003d\\u003d\"}","sessionIndex":7},{"key":"emis_9692113698_access_token","value":"","enabled":true,"type":"secret","sessionValue":"{\"Im1CacheKey\":\"WujPlHL3F+JxIJQx7FPDwico+6VjeDazwf7vyoukS4og6FyeeqqIIUJEUu/3DvYFIcAEAzqDvNa1y6Pf7FX9Cw==\",\"AccessIdentityGuid\":\"79e83929-...","completeSessionValue":"{\"Im1CacheKey\":\"WujPlHL3F+JxIJQx7FPDwico+6VjeDazwf7vyoukS4og6FyeeqqIIUJEUu/3DvYFIcAEAzqDvNa1y6Pf7FX9Cw==\",\"AccessIdentityGuid\":\"79e83929-ab77-4266-b1b9-fc7b823c1525\"}","sessionIndex":8},{"key":"emis_9692113612_access_token","value":"","enabled":true,"type":"secret","sessionValue":"{\"Im1CacheKey\":\"C8AvaxJtb6Z2QezcRzQ3YJklTeIUmSczcAz2z5kkCk9O644vUjWm/yBsEazsHmflOOEu00esr/llCOh8G43mcA==\",\"AccessIdentityGuid\":\"217ef6f1-...","completeSessionValue":"{\"Im1CacheKey\":\"C8AvaxJtb6Z2QezcRzQ3YJklTeIUmSczcAz2z5kkCk9O644vUjWm/yBsEazsHmflOOEu00esr/llCOh8G43mcA==\",\"AccessIdentityGuid\":\"217ef6f1-1d70-4a8e-b728-664316c75654\"}","sessionIndex":9}]) ## Onboarding @@ -184,26 +192,29 @@ paths: For any new access request, the necessary details should be collected from a user facing service e.g. Proxy Access Service and submitted as a QuestionnaireResponse. - For the most part demographics information doesn't need to be provided in the access request since it can be pulled from PDS. - ## Access modes This endpoint supports the following access modes: + - Patient access - ## Sandbox test scenarios + ## Sandbox test scenarios: - | Scenario | Request | Response | - | ---------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | - | Successful request | Valid request with performer identifier value of `9000000009` or `9000000017` | HTTP Status 200 Success response | - | Duplicate relationship | Request for relationship that already exists, with performer identifier value of `9000000049` | HTTP Status 409 and DUPLICATE_RELATIONSHIP error response | + You can test the following scenarios in our sandbox environment: + + | Scenario | Request | Response | + | ---------------------- | ------------------------------------------------------------------------------------------- | -----------------------------------------------| + | Successful request | Valid request with performer identifier value of `9000000009` or `9000000017` | HTTP Status 200 Success response | + | Duplicate proxy role | Request for proxy role that already exists, with performer identifier value of `9000000049` | HTTP Status 409 and DUPLICATE error response | ### Sandbox constraints - - Questionnaire Response is not validated. - - Headers are not tested. `X-Request-ID` and `X-Correlation-ID` are disregarded. - Or perhaps you'd like to try out the sandbox using our 'Try it out' feature. + The sandbox environment has the following constraints for this endpoint: + + - QuestionnaireResponse is not validated. + - Request headers are not tested. `X-Request-ID` and `X-Correlation-ID` are disregarded. + - No access request is created. operationId: new-access-request parameters: @@ -211,7 +222,6 @@ paths: - $ref: "#/components/parameters/RequestID" - $ref: "#/components/parameters/CorrelationID" requestBody: - description: FHIR QuestionnaireResponse required: true content: application/fhir+json: @@ -249,7 +259,7 @@ paths: location: schema: type: string - example: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse?ID=156e1560-e532-4e2a-85ad-5aeff03dc43e + example: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/156e1560-e532-4e2a-85ad-5aeff03dc43e description: URL for the newly created access request content: application/fhir+json: @@ -310,8 +320,7 @@ paths: QuestionnaireResponse document that was previously submitted. ## Request Requirements - A valid access request ID must be provided as a path parameter. This access request ID is returned - when a QuestionnaireResponse is initially submitted via the POST endpoint. + A valid access request ID must be provided as a path parameter. ## Access modes @@ -322,6 +331,8 @@ paths: ## Sandbox test scenarios + You can test the following scenarios in our sandbox environment: + | Scenario | Request | Response | | -------------------------------- | ------------------------------------------------ | ------------------------------------------------------------- | | Valid access request ID | ID value: `156e1560-e532-4e2a-85ad-5aeff03dc43e` | HTTP Status 200 with QuestionnaireResponse | @@ -329,6 +340,12 @@ paths: | Missing access request ID | No ID path parameter | HTTP Status 405 with METHOD_NOT_ALLOWED message | | Non-existent access request ID | ID value: `60d09b82-f4bb-41f9-b41e-767999b4ac9b` | HTTP Status 404 with QUESTIONNAIRE_RESPONSE_NOT_FOUND message | + ### Sandbox constraints + + The sandbox environment has the following constraints for this endpoint: + + - Request headers are not tested. For example, `X-Request-ID` and `X-Correlation-ID` are disregarded. + operationId: get-questionnaire-response parameters: - $ref: "#/components/parameters/BearerAuthorization" @@ -390,19 +407,23 @@ paths: examples: internalServerError: $ref: "./examples/responses/errors/internal-server-error.yaml#/InternalServerError" - downstreamServiceError: - $ref: "./examples/responses/errors/downstream-service-error.yaml#/DownstreamServiceError" /RelatedPerson: get: summary: Get verified candidate relationships description: | ## Overview - Use this endpoint to get candidate proxy relationships for a user with a given NHS Number. This endpoint should NOT be used to retrieve proxy relationships; these should be queried from the `/Consent` endpoint. + Use this endpoint to get verified relationship information for a user with a given NHS Number. This endpoint should NOT be used to retrieve established proxy roles; these should be queried from the GET /Consent endpoints. - You can (optionally) include `patient:identifier={nhsNumber}` request parameter with the patient's NHS number to get a specific verified relationship for the proxy. + You can query for RelatedPerson's in the following ways: - You can (optionally) include the `_include=RelatedPerson:patient` request parameter to include the patient's details in the response. + | Outcome | Query string value | + | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | + | Search for patient relationships for a candidate proxy | `identifier={proxy identifier}` | + | Search for candidate proxy relationships for a patient | `patient:identifier={patient identifier}` | + | Search for a specific verified candidate relationship for a given proxy and patient | `identifier={proxy identifier}&patient:identifier={patient identifier}` | + + You must provide either the `identifier={identifier}` or `patient:identifier={identifier}` query string, or both, in your request. ## Access modes @@ -412,27 +433,26 @@ paths: ## Sandbox test scenarios - | Scenario | Request | Response | - | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | - | List Relationship | `identifier=9000000017` | HTTP Status 200 List of relationships for the proxy | - | List Relationship and include patient's details | `identifier=9000000017&_include=RelatedPerson:patient` | HTTP Status 200 List of relationships for the proxy and includes patient data | - | List Patient Relationship | `patient:identifier=9000000042` | HTTP Status 200 List of relationships for the patient | - | List Patient Relationship and include patient's details | `patient:identifier=9000000042&_include=RelatedPerson:patient` | HTTP Status 200 List of relationships for the patient and includes proxy data | - | List Relationship and no relationships returned | `identifier=9000000033` | HTTP Status 200 Empty bundle | - | Verify Relationship between proxy and patient | `identifier=9000000017&patient:identifier=9000000009` | HTTP Status 200 Verified relationship between patient and proxy | - | Verify Relationship between proxy and patient and include patient's details | `identifier=9000000017&patient:identifier=9000000009&_include=RelatedPerson:patient` | HTTP Status 200 Verified relationship between patient and proxy and includes patient's details | - | Verify Relationship between proxy and patient | `identifier=9000000017&patient:identifier=9000000025` | HTTP Status 200 Verified relationship between patient and proxy | - | Verify Relationship between proxy and patient and include patient's details | `identifier=9000000017&patient:identifier=9000000025&_include=RelatedPerson:patient` | HTTP Status 200 Verified relationship between patient and proxy and includes patient's details | - | Missing identifier | `patient:identifier=9000000009` | HTTP Status 400 and MISSING_IDENTIFIER_VALUE error response | + You can test the following scenarios in our sandbox environment: + + | Scenario | Request | Response | + | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | + | List Relationship | `identifier=9000000017` | HTTP Status 200 List of relationships for the proxy | + | List Relationship and include patient's details | `identifier=9000000017&_include=RelatedPerson:patient` | HTTP Status 200 List of relationships for the proxy and includes patient data | + | List Patient Relationship | `patient:identifier=9000000042` | HTTP Status 200 List of relationships for the patient | + | List Patient Relationship and include patient's details | `patient:identifier=9000000042&_include=RelatedPerson:patient` | HTTP Status 200 List of relationships for the patient and includes proxy data | + | List Relationship and no relationships returned | `identifier=9000000033` | HTTP Status 200 Empty bundle | + | Verify Relationship between proxy and patient | `identifier=9000000017&patient:identifier=9000000009` | HTTP Status 200 Verified relationship between patient and proxy | + | Verify Relationship between proxy and patient and include patient's details | `identifier=9000000017&patient:identifier=9000000009&_include=RelatedPerson:patient` | HTTP Status 200 Verified relationship between patient and proxy and includes patient's details | + | Missing identifier | `` | HTTP Status 400 and MISSING_IDENTIFIER_VALUE error response | | Invalid identifier | `identifier=900000000` Note: This identifier is 9 characters long, too short to be NHS Number | HTTP Status 400 and INVALID_IDENTIFIER_VALUE error response | - | Invalid identifier system | `identifier=https://fhir.nhs.uk/Id/nhs-number/9730675929` | HTTP Status 400 and INVALID_IDENTIFIER_SYSTEM error response | - | Identifier not supported in sandbox | `identifier=1000000001` | HTTP Status 404 and INVALIDATED_RESOURCE error response | + | Malformed identifier & system | `identifier=https://fhir.nhs.uk/Id/nhs-number/9730675929` | HTTP Status 400 and INVALID_IDENTIFIER_SYSTEM error response | ### Sandbox constraints - - Headers are not tested. `X-Request-ID` and `X-Correlation-ID` are disregarded. - - `patient:identifier` is not validated. - Or perhaps you'd like to try out the sandbox using our 'Try it out' feature. + The sandbox environment has the following constraints for this endpoint: + + - Request headers are not tested. For example, `X-Request-ID` and `X-Correlation-ID` are disregarded. operationId: get-validated-relationships parameters: @@ -531,7 +551,7 @@ paths: Either `performer:identifier` or `patient:identifier` request parameters must be provided. `performer:identifier` and `patient:identifier` can be used together. - You can (optionally) include `status={status}` request parameter to filter the limit the response to records with a given status bound to the http://hl7.org/fhir/consent-state-codes CodeSystem e.g. `status=active`. + You can (optionally) include a `status={status}` query string parameter to filter the response to records with a given status bound to the http://hl7.org/fhir/consent-state-codes CodeSystem e.g. `status=active` or `status=proposed,active`. You can (optionally) include the `_include=Consent:performer` request parameter to include the proxy's details in the response. @@ -546,6 +566,8 @@ paths: ## Sandbox test scenarios + You can test the following scenarios in our sandbox environment: + | Scenario | Request | Response | | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | | Multiple proxy relationships filtered by 'active' status including details | `performer:identifier=9000000017&_include=Consent:patient&_include=Consent:performer&status=active` | HTTP Status 200 Bundle containing a multiple active proxy relationships including performer and patient details | @@ -574,7 +596,10 @@ paths: | GP Practice not found | `identifier=9000000012` | HTTP Status 404 and GP_PRACTICE_NOT_FOUND error response | ### Sandbox constraints - - Headers are not tested. `X-IM1-Connection-Params`, `X-Request-ID` and `X-Correlation-ID` are disregarded. + + The sandbox environment has the following constraints for this endpoint: + + - Request headers are not tested. `X-IM1-Connection-Params`, `X-Request-ID` and `X-Correlation-ID` are disregarded. operationId: get-consent parameters: @@ -695,9 +720,8 @@ paths: ## Sandbox test scenarios - The sandbox supports a limited number of scenarios, and does not attempt to validate requests. The returned result is dependant on the `performer.identifier.value`. + You can test the following scenarios in our sandbox environment: - See the postman collection for an example request body. | Scenario | Request | Response | | --------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | | Successful parent-child proxy creation | Valid request with a legal basis of parental responsibility, with performer identifier value of `9000000009`| HTTP Status 201 and OperationOutcome response | @@ -712,6 +736,15 @@ paths: | Invalid grantor identifier system | Request with grantor extension but wrong/missing identifier system, performer identifier `9000000056` | HTTP Status 422 and INVALID_GRANTOR_SYSTEM error response | | Duplicate relationship | Request for relationship that already exists, with performer identifier value of `9000000049` | HTTP Status 409 and DUPLICATE_RELATIONSHIP error response | + ### Sandbox constraints + + The sandbox environment has the following constraints for this endpoint: + + - `patient.identifier.value` is disregarded. The returned response is based on the `performer.identifier.value` only. + - Request body is not validated. + - Request headers are not tested. `X-Request-ID` and `X-Correlation-ID` are disregarded. + - No proxy role is created. + operationId: create-proxy-role parameters: - $ref: "#/components/parameters/BearerAuthorization" @@ -853,9 +886,8 @@ paths: ## Sandbox test scenarios - The sandbox supports a limited number of scenarios, and does not attempt to validate requests. The returned result is dependant on the `ID` for the consent resource. + You can test the following scenarios in our sandbox environment: - See the postman collection for an example request body. | Scenario | Request | Response | | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | Retrieve single consenting adult relationship | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a` | HTTP Status 200 Bundle containing a single active proxy relationship | @@ -867,6 +899,12 @@ paths: | Retrieve single mother-child relationship with performer details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:performer` | HTTP Status 200 Bundle containing a single active proxy relationship with performer details | | Retrieve single mother-child relationship with performer and patient details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:performer&_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with performer details and patient details | + ### Sandbox constraints + + The sandbox environment has the following constraints for this endpoint: + + - Request headers are not tested. `X-Request-ID` and `X-Correlation-ID` are disregarded. + operationId: get-consent-by-id parameters: - $ref: "#/components/parameters/BearerAuthorization" @@ -938,7 +976,6 @@ paths: | ----------- | -------------------------- | ------------------------------------------------------------- | | 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. | | 502 | `BAD_GATEWAY` | Connection to the backend service failed. | - | 503 | `DOWNSTREAM_SERVICE_ERROR` | A downstream service has failed, request cannot be completed. | content: application/fhir+json: @@ -955,20 +992,22 @@ paths: ## Overview Use this endpoint to update an existing proxy role. - Common update scenarios include: - * Revocation of the role (status change from "active" to "inactive") - * Changing the legal basis of the role (TBC) - * Updating the end date for time-bound access + Supported update scenarios include: + + * Update the status and status reason, (optionally) providing an additional free text description + * Update the legal basis + * Update the end date, for time-bound access ## Request Requirements - * The proxy role must exist and be identified by a valid identifier + * The proxy role must exist and be identified by a valid ID * JSON Patch operations must be valid according to RFC 6902 * Status changes must use valid status codes from - **IMPORTANT: Business Rule Enforcement** - If you update the `/status` of a role, you **MUST** also provide a corresponding update to the `/extension` path in the same patch array to provide the `statusReason`. + ### IMPORTANT: Business Rule Enforcement for `/status` updates - Requests that change status without providing a status reason will return an error + If you update the `/status` of a role, you **MUST** also provide a corresponding update to the `/extension` path in the same patch array to provide the `statusReason`. An error will be returned if a request for a change of `/status` does not include a status reason. + + The values for `/status` and `statusReason` are validated against a proxy role lifecycle to ensure that the transition between the existing and requested status is valid. An error will be returned if the requested transition is not valid. ## Access modes @@ -978,11 +1017,8 @@ paths: - Application-restricted access ## Sandbox test scenarios - The sandbox supports a limited number of scenarios, and does not attempt to validate requests. The returned response is dependant on the `id` parameters. - - No changes are applied to any records. - See the postman collection for example requests. + You can test the following scenarios in our sandbox environment: | Scenario | Request | Response | | ------------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | @@ -1000,6 +1036,15 @@ paths: | Invalid state transition | Patch attempting invalid status change, request with id '7b7f47b8-96e5-43eb-b733-283bf1449f2c' | HTTP Status 422 and INVALID_STATE_TRANSITION error response | | Missing free text for OTHER reason code | Patch with reason code 'OTHER' but missing free text, id='d4e8a6f2-1c3b-4a7e-9d2f-8b5c7e9f1a3d' | HTTP Status 400 and MISSING_FREE_TEXT_FOR_OTHER error response | | Missing grantor when activating status | Patch attempting to set status to 'active' without grantor extension, id='90957744-b971-496e-b7c3-ab971868ce14' | HTTP Status 400 and MISSING_GRANTOR_FOR_ACTIVE error response | + + ### Sandbox constraints + + The sandbox environment has the following constraints for this endpoint: + + - Request body is not validated. + - Request headers are not tested. + - No proxy role is updated. + parameters: - $ref: "#/components/parameters/ConsentID" requestBody: @@ -1016,27 +1061,7 @@ paths: updateProvisionEndDate: $ref: "./examples/requests/PATCH_Consent/replace_provision_end_date.yaml#/UpdateProvisionEndDate" multipleUpdates: - summary: Set status to active with an end date - description: | - Example of a combined update to a record. - The status will be changed to active. - The relationship will be considered as ended following this date. - value: - - op: replace - path: /status - value: active - - op: add - path: /extension/- - value: - - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason - valueCodeableConcept: - coding: - - system: http://terminology.hl7.org/CodeSystem/consent-reason - code: "ROLE_ACTIVATED" - display: "Role activated" - - op: add - path: /provision/period/end - value: "2026-12-31T23:59:59Z" + $ref: "./examples/requests/PATCH_Consent/multiple_updates.yaml#/MultipleUpdates" regulatoryBasis: $ref: "./examples/requests/PATCH_Consent/replace_regulatory_basis.yaml#/ReplaceRegulatoryBasisRequest" responses: @@ -1103,7 +1128,6 @@ paths: | ----------- | -------------------------- | ------------------------------------------------------------- | | 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. | | 502 | `BAD_GATEWAY` | Connection to the backend service failed. | - | 503 | `DOWNSTREAM_SERVICE_ERROR` | A downstream service has failed, request cannot be completed. | content: application/fhir+json: @@ -2124,7 +2148,7 @@ components: type: string description: The canonical URL of the resource in the entry resource: - $ref: "#/components/schemas/Consent" + $ref: "#/components/schemas/ReadConsent" search: type: object properties: @@ -2233,7 +2257,14 @@ components: type: string description: Unique identifier of the Patient resource meta: - $ref: "#/components/schemas/Meta" + type: object + description: Metadata about a resource + properties: + security: + type: array + description: Security Labels applied to this resource + items: + $ref: "#/components/schemas/Coding" identifier: type: array description: The primary identifier of a patient. Possible identifiers include the NHS number or local GP patient identifier. If it is an NHS number, it will always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html). @@ -2283,7 +2314,7 @@ components: description: Unique identifier of the Consent resource status: type: string - description: "The status of the consent, following the ConsentStateCodes value set." + description: "The status of the consent, following the ConsentStateCodes value set. See more information about this codesystem in the [FHIR specification](http://hl7.org/fhir/R4/codesystem-consent-state-codes.html)." enum: - draft - proposed @@ -2329,6 +2360,20 @@ components: - $ref: "#/components/schemas/GrantorExtension" description: "Additional content. For active proxy roles, grantor is required." + ReadConsent: + allOf: # Extends the Consent model + - $ref: "#/components/schemas/Consent" + - type: object + properties: + meta: + type: object + description: "Metadata about a resource" + properties: + lastUpdated: + type: string + format: date-time + description: "When the resource version last changed" + Policy: type: object properties: @@ -2353,7 +2398,7 @@ components: - deny period: type: object - description: "Timeframe for this provision." + description: "The start date on which the proxy role was granted, and (optionally) an end date for time-bound access." properties: start: type: string @@ -2534,16 +2579,6 @@ components: type: string description: "The value that is unique." - Meta: - type: object - description: Metadata about a resource - properties: - security: - type: array - description: Security Labels applied a resource - items: - $ref: "#/components/schemas/Coding" - CodeableConcept: type: object properties: