From 55456edc5d49ca4783b52d23206e41989c70151c Mon Sep 17 00:00:00 2001 From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com> Date: Wed, 4 Feb 2026 13:17:19 +0000 Subject: [PATCH 1/6] NPA-6376: Add change to be able to create PR --- specification/validated-relationships-service-api.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml index f0f106b8..8fa6da01 100644 --- a/specification/validated-relationships-service-api.yaml +++ b/specification/validated-relationships-service-api.yaml @@ -2,7 +2,7 @@ # for validated-relationships owned by NHS Digital (https://digital.nhs.uk/) openapi: "3.0.0" info: - title: "Validated Relationships Service API" + title: "Validated Relationships Service API (Review)" version: "1.16.0" description: | ## Overview From f504137711f280c765a9f96fa318799dd7bd12de Mon Sep 17 00:00:00 2001 From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com> Date: Wed, 4 Feb 2026 15:26:04 +0000 Subject: [PATCH 2/6] NPA-6376: Update yaml files --- .../examples/requests/PATCH_Consent/replace_legal_basis.yaml | 0 .../requests/PATCH_Consent/replace_provision_end_date.yaml | 2 +- .../examples/requests/PATCH_Consent/replace_status.yaml | 3 +-- .../POST_QuestionnaireResponse/adult-nominates-adult.yaml | 2 +- .../adult-to-adult-with-capacity.yaml | 2 +- .../adult-to-adult-without-capacity.yaml | 2 +- .../POST_QuestionnaireResponse/duplicate_relationship.yaml | 2 +- .../requests/POST_QuestionnaireResponse/mother-child.yaml | 2 +- .../examples/responses/GET_Consent/ID/errors/invalid-id.yaml | 2 +- .../responses/GET_Consent/errors/gp-practice-not-found.yaml | 2 +- .../GET_Consent/errors/invalid-identifier-system.yaml | 2 +- .../responses/GET_Consent/errors/invalid-identifier.yaml | 3 +-- .../responses/GET_Consent/errors/invalid-status-parameter.yaml | 2 +- .../responses/GET_Consent/errors/missing-identifier.yaml | 2 +- .../filtered-relationships-status-active-include-details.yaml | 2 +- .../GET_Consent/filtered-relationships-status-inactive.yaml | 2 +- .../filtered-relationships-status-proposed-active.yaml | 2 +- .../GET_Consent/multiple-relationships-include-patient.yaml | 2 +- .../multiple-relationships-include-performer-patient.yaml | 2 +- .../GET_Consent/multiple-relationships-include-performer.yaml | 3 +-- .../multiple-relationships-single-patient-include-patient.yaml | 2 +- ...relationships-single-patient-include-performer-patient.yaml | 2 +- ...ultiple-relationships-single-patient-include-performer.yaml | 2 +- .../GET_Consent/multiple-relationships-single-patient.yaml | 2 +- .../examples/responses/GET_Consent/multiple-relationships.yaml | 2 +- .../examples/responses/GET_Consent/no-relationships.yaml | 2 +- .../single-consenting-adult-relationship-include-patient.yaml | 2 +- ...onsenting-adult-relationship-include-performer-patient.yaml | 2 +- ...single-consenting-adult-relationship-include-performer.yaml | 2 +- .../GET_Consent/single-consenting-adult-relationship.yaml | 2 +- .../single-mother-child-relationship-include-patient.yaml | 2 +- ...le-mother-child-relationship-include-performer-patient.yaml | 2 +- .../single-mother-child-relationship-include-performer.yaml | 2 +- .../single-mother-child-relationship-unknown-legal-basis.yaml | 2 +- .../GET_Consent/single-mother-child-relationship.yaml | 2 +- .../errors/invalid_access_request_id.yaml | 2 +- .../errors/missing_access_request_id.yaml | 2 +- .../errors/questionnaire_response_not_found.yaml | 2 +- .../examples/responses/GET_QuestionnaireResponse/success.yaml | 2 +- .../responses/GET_RelatedPerson/empty_response_9000000033.yaml | 2 +- .../GET_RelatedPerson/errors/invalid-identifier-missing.yaml | 2 +- .../GET_RelatedPerson/errors/invalid-identifier-patient.yaml | 2 +- .../GET_RelatedPerson/errors/invalid-identifier-system.yaml | 2 +- .../responses/GET_RelatedPerson/errors/invalid-identifier.yaml | 2 +- .../GET_RelatedPerson/list_relationship_9000000017.yaml | 2 +- .../list_relationship_9000000017_include.yaml | 2 +- .../GET_RelatedPerson/list_relationship_9000000042.yaml | 2 +- .../list_relationship_9000000042_include.yaml | 2 +- .../GET_RelatedPerson/verify_relationship_9000000009.yaml | 2 +- .../verify_relationship_9000000009_include.yaml | 3 +-- .../GET_RelatedPerson/verify_relationship_9000000025.yaml | 2 +- .../verify_relationship_9000000025_include.yaml | 2 +- .../responses/PATCH_Consent/errors/invalid_patch_format.yaml | 3 ++- .../examples/responses/PATCH_Consent/errors/invalid_path.yaml | 3 ++- .../PATCH_Consent/errors/invalid_state_transition.yaml | 3 ++- .../responses/PATCH_Consent/errors/invalid_status_code.yaml | 3 ++- .../responses/PATCH_Consent/errors/invalid_status_reason.yaml | 1 + .../PATCH_Consent/errors/missing_free_text_for_other.yaml | 1 + .../responses/PATCH_Consent/errors/resource_not_found.yaml | 1 + specification/examples/responses/PATCH_Consent/success.yaml | 1 + .../POST_Consent/errors/duplicate_relationship_error.yaml | 3 ++- .../POST_Consent/errors/invalid_identifier_value.yaml | 1 + .../responses/POST_Consent/errors/invalid_request.yaml | 1 + .../examples/responses/POST_Consent/errors/invalid_status.yaml | 1 + .../POST_Consent/errors/missing_free_text_for_other.yaml | 1 + .../POST_Consent/errors/missing_identifier_system.yaml | 1 + .../examples/responses/POST_Consent/errors/missing_scope.yaml | 1 + specification/examples/responses/POST_Consent/success.yaml | 1 + .../errors/duplicate_relationship_error.yaml | 1 + .../examples/responses/POST_QuestionnaireResponse/success.yaml | 3 ++- specification/examples/responses/errors/access-denied.yaml | 2 +- .../examples/responses/errors/downstream-service-error.yaml | 2 +- .../examples/responses/errors/internal-server-error.yaml | 2 +- .../examples/responses/errors/invalid-include-parameter.yaml | 2 +- .../examples/responses/errors/invalidated-resource.yaml | 2 +- .../examples/responses/errors/method-not-allowed.yaml | 2 +- 76 files changed, 81 insertions(+), 67 deletions(-) create mode 100644 specification/examples/requests/PATCH_Consent/replace_legal_basis.yaml 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/requests/PATCH_Consent/replace_provision_end_date.yaml b/specification/examples/requests/PATCH_Consent/replace_provision_end_date.yaml index 958c5590..1661c897 100644 --- a/specification/examples/requests/PATCH_Consent/replace_provision_end_date.yaml +++ b/specification/examples/requests/PATCH_Consent/replace_provision_end_date.yaml @@ -6,4 +6,4 @@ UpdateProvisionEndDate: value: - op: add path: /provision/period/end - value: "2026-12-31T23:59:59Z" + value: "2026-12-31T23:59:59Z" \ No newline at end of file diff --git a/specification/examples/requests/PATCH_Consent/replace_status.yaml b/specification/examples/requests/PATCH_Consent/replace_status.yaml index ccf29ffb..4ced5f7c 100644 --- a/specification/examples/requests/PATCH_Consent/replace_status.yaml +++ b/specification/examples/requests/PATCH_Consent/replace_status.yaml @@ -13,5 +13,4 @@ StatusUpdate: coding: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED - display: Role created - + display: Role created \ No newline at end of file diff --git a/specification/examples/requests/POST_QuestionnaireResponse/adult-nominates-adult.yaml b/specification/examples/requests/POST_QuestionnaireResponse/adult-nominates-adult.yaml index 0fc66fc0..bc548795 100644 --- a/specification/examples/requests/POST_QuestionnaireResponse/adult-nominates-adult.yaml +++ b/specification/examples/requests/POST_QuestionnaireResponse/adult-nominates-adult.yaml @@ -89,4 +89,4 @@ QuestionnaireResponseAdultNominatesAdultRequest: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "PRAC" - display: "Practical Reasons" + display: "Practical Reasons" \ No newline at end of file diff --git a/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-with-capacity.yaml b/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-with-capacity.yaml index 528d9323..74fa0cc5 100644 --- a/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-with-capacity.yaml +++ b/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-with-capacity.yaml @@ -89,4 +89,4 @@ QuestionnaireResponseAdultToAdultWithCapacityRequest: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "PRAC" - display: "Practical Reasons" + display: "Practical Reasons" \ No newline at end of file diff --git a/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-without-capacity.yaml b/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-without-capacity.yaml index 45d16f75..42f15802 100644 --- a/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-without-capacity.yaml +++ b/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-without-capacity.yaml @@ -89,4 +89,4 @@ QuestionnaireResponseAdultToAdultWithoutCapacityRequest: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "TECH" - display: "Technical Barriers" + display: "Technical Barriers" \ No newline at end of file diff --git a/specification/examples/requests/POST_QuestionnaireResponse/duplicate_relationship.yaml b/specification/examples/requests/POST_QuestionnaireResponse/duplicate_relationship.yaml index 901c9f52..6cff3169 100644 --- a/specification/examples/requests/POST_QuestionnaireResponse/duplicate_relationship.yaml +++ b/specification/examples/requests/POST_QuestionnaireResponse/duplicate_relationship.yaml @@ -89,4 +89,4 @@ QuestionnaireResponseDuplicateRelationship: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "PRAC" - display: "Practical Reasons" + display: "Practical Reasons" \ No newline at end of file diff --git a/specification/examples/requests/POST_QuestionnaireResponse/mother-child.yaml b/specification/examples/requests/POST_QuestionnaireResponse/mother-child.yaml index ba4ed227..b3120e06 100644 --- a/specification/examples/requests/POST_QuestionnaireResponse/mother-child.yaml +++ b/specification/examples/requests/POST_QuestionnaireResponse/mother-child.yaml @@ -135,4 +135,4 @@ QuestionnaireResponseMotherChildRequest: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "PRAC" - display: "Practical Reasons" + display: "Practical Reasons" \ No newline at end of file diff --git a/specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml b/specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml index 9f2e8594..e160ba7c 100644 --- a/specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml +++ b/specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml @@ -12,4 +12,4 @@ ConsentInvalidIDError: version: "1" diagnostics: "Invalid request with error - ID must be a valid UUID." severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml b/specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml index e54ac061..07986ff7 100644 --- a/specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml +++ b/specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml @@ -12,4 +12,4 @@ GPPracticeNotFoundError: display: "GP Practice could not be found - invalid resources cannot be retrieved" diagnostics: "GP Practice could not be found" severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml b/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml index aaa46e9c..f5293b1a 100644 --- a/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml +++ b/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml @@ -12,4 +12,4 @@ ConsentInvalidIdentifierSystemError: version: '1' diagnostics: "Invalid request with error - performer:identifier or patient:identifier system parameter is invalid." severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml b/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml index e5896648..c1e4bad0 100644 --- a/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml +++ b/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml @@ -12,5 +12,4 @@ ConsentInvalidIdentifierError: version: '1' diagnostics: 'Invalid request with error - performer:identifier or patient:identifier parameter is invalid.' severity: error - resourceType: "OperationOutcome" - + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml b/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml index 5bfe2491..114ea553 100644 --- a/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml +++ b/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml @@ -12,4 +12,4 @@ ConsentInvalidStatusParameterError: version: "1" diagnostics: "Invalid request with error - status parameter is invalid." severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/GET_Consent/errors/missing-identifier.yaml b/specification/examples/responses/GET_Consent/errors/missing-identifier.yaml index f54235f2..f5341530 100644 --- a/specification/examples/responses/GET_Consent/errors/missing-identifier.yaml +++ b/specification/examples/responses/GET_Consent/errors/missing-identifier.yaml @@ -12,4 +12,4 @@ ConsentIdentifierMissingError: version: "1" diagnostics: "Invalid request with error - performer:identifier or patient:identifier parameter not found." severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file 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..2f74c515 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 @@ -228,4 +228,4 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..fb7f9f71 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml @@ -116,4 +116,4 @@ ConsentMultipleRelationshipsStatusInactiveBundle: system: https://fhir.nhs.uk/Id/nhs-number value: '9000000017' search: - mode: match + mode: match \ No newline at end of file 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..cceb76ad 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 @@ -244,4 +244,4 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..5e373781 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml @@ -273,4 +273,4 @@ ConsentMultipleRelationshipsIncludePatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..5006d1e5 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 @@ -335,4 +335,4 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..71f660a8 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml @@ -250,5 +250,4 @@ ConsentMultipleRelationshipsIncludePerformerBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match - + mode: match \ No newline at end of file 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..10ca38b3 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 @@ -212,4 +212,4 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..3dd013f7 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 @@ -270,4 +270,4 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..b77d5fb3 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 @@ -241,4 +241,4 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..97de0177 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml @@ -183,4 +183,4 @@ ConsentMultipleRelationshipsSinglePatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file diff --git a/specification/examples/responses/GET_Consent/multiple-relationships.yaml b/specification/examples/responses/GET_Consent/multiple-relationships.yaml index 768617a5..67d9a962 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships.yaml @@ -183,4 +183,4 @@ ConsentMultipleRelationshipsBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file diff --git a/specification/examples/responses/GET_Consent/no-relationships.yaml b/specification/examples/responses/GET_Consent/no-relationships.yaml index 0eaf7df2..83852119 100644 --- a/specification/examples/responses/GET_Consent/no-relationships.yaml +++ b/specification/examples/responses/GET_Consent/no-relationships.yaml @@ -9,4 +9,4 @@ ConsentNoRelationshipsEmptyBundle: link: - relation: self url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:performer&_include=Consent:patient - entry: [] + entry: [] \ No newline at end of file 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..ed1f74b8 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 @@ -96,4 +96,4 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..110b75bc 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 @@ -117,4 +117,4 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..22d0c490 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 @@ -87,4 +87,4 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..108c5704 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml @@ -67,4 +67,4 @@ ConsentSingleConsentingAdultRelationshipBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..35928e6f 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 @@ -93,4 +93,4 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..94e3da94 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 @@ -121,4 +121,4 @@ ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..c34f2132 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 @@ -90,4 +90,4 @@ ConsentSingleAdultChildRelationshipIncludePerformerBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..747b2c12 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 @@ -70,4 +70,4 @@ ConsentSingleAdultChildRelationshipUnknownLegalBasisBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file 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..20b09aed 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml @@ -67,4 +67,4 @@ ConsentSingleAdultChildRelationshipBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match + mode: match \ No newline at end of file diff --git a/specification/examples/responses/GET_QuestionnaireResponse/errors/invalid_access_request_id.yaml b/specification/examples/responses/GET_QuestionnaireResponse/errors/invalid_access_request_id.yaml index 81d65d5d..93f9548b 100644 --- a/specification/examples/responses/GET_QuestionnaireResponse/errors/invalid_access_request_id.yaml +++ b/specification/examples/responses/GET_QuestionnaireResponse/errors/invalid_access_request_id.yaml @@ -11,4 +11,4 @@ InvalidAccessRequestID: - system: "https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1" code: "INVALID_IDENTIFIER_VALUE" display: "Invalid identifier value" - diagnostics: "The specified access request ID is invalid. Access request IDs must be a valid UUID." + diagnostics: "The specified access request ID is invalid. Access request IDs must be a valid UUID." \ No newline at end of file diff --git a/specification/examples/responses/GET_QuestionnaireResponse/errors/missing_access_request_id.yaml b/specification/examples/responses/GET_QuestionnaireResponse/errors/missing_access_request_id.yaml index 92e53386..092314be 100644 --- a/specification/examples/responses/GET_QuestionnaireResponse/errors/missing_access_request_id.yaml +++ b/specification/examples/responses/GET_QuestionnaireResponse/errors/missing_access_request_id.yaml @@ -11,4 +11,4 @@ MissingAccessRequestID: - system: "https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1" code: "BAD_REQUEST" display: "Bad request" - diagnostics: "The access request ID parameter is required but was not provided." + diagnostics: "The access request ID parameter is required but was not provided." \ No newline at end of file diff --git a/specification/examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml b/specification/examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml index 04627dfe..27f2b93c 100644 --- a/specification/examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml +++ b/specification/examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml @@ -11,4 +11,4 @@ QuestionnaireResponseNotFound: - system: "https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1" code: "QUESTIONNAIRE_RESPONSE_NOT_FOUND" display: "Questionnaire response not found" - diagnostics: "The Questionnaire response could not be found using the provided access request ID." + diagnostics: "The Questionnaire response could not be found using the provided access request ID." \ No newline at end of file diff --git a/specification/examples/responses/GET_QuestionnaireResponse/success.yaml b/specification/examples/responses/GET_QuestionnaireResponse/success.yaml index c3538a83..41773828 100644 --- a/specification/examples/responses/GET_QuestionnaireResponse/success.yaml +++ b/specification/examples/responses/GET_QuestionnaireResponse/success.yaml @@ -105,4 +105,4 @@ GetQuestionnaireResponseSuccess: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "PRAC" - display: "Practical Reasons" + display: "Practical Reasons" \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/empty_response_9000000033.yaml b/specification/examples/responses/GET_RelatedPerson/empty_response_9000000033.yaml index ca01e0a0..7a7fb1f5 100644 --- a/specification/examples/responses/GET_RelatedPerson/empty_response_9000000033.yaml +++ b/specification/examples/responses/GET_RelatedPerson/empty_response_9000000033.yaml @@ -10,4 +10,4 @@ RelatedEmptyResponse: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships-service-api/FHIR/R4/RelatedPerson?identifier=9000000033 + url: https://sandbox.api.service.nhs.uk/validated-relationships-service-api/FHIR/R4/RelatedPerson?identifier=9000000033 \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-missing.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-missing.yaml index bf461cf3..d25fe81a 100644 --- a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-missing.yaml +++ b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-missing.yaml @@ -12,4 +12,4 @@ RelatedPersonInvalidIdentifierMissing: version: '1' diagnostics: The 'identifier' parameter is required severity: error - resourceType: OperationOutcome + resourceType: OperationOutcome \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml index 8c7cb6ae..e3d98805 100644 --- a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml +++ b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml @@ -12,4 +12,4 @@ InvalidIdentifierPatientError: display: "Provided value is invalid" diagnostics: "Not a valid NHS Number provided for the 'patient:identifier' parameter" severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml index aba7b8f0..11f4d120 100644 --- a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml +++ b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml @@ -12,4 +12,4 @@ RelatedPersonInvalidIdentifierSystem: version: '1' diagnostics: The identifier system is not valid. severity: error - resourceType: OperationOutcome + resourceType: OperationOutcome \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml index a92de12c..133893e6 100644 --- a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml +++ b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml @@ -14,4 +14,4 @@ RelatedPersonInvalidIdentifierError: expression: - "RelatedPerson.identifier" severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017.yaml b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017.yaml index 4f7ca54a..230b1e53 100644 --- a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017.yaml +++ b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017.yaml @@ -69,4 +69,4 @@ ListRelationship9000000017: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 2 - type: searchset + type: searchset \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017_include.yaml b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017_include.yaml index 16e5e150..60d7e90e 100644 --- a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017_include.yaml +++ b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017_include.yaml @@ -108,4 +108,4 @@ ListRelationship9000000017Include: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 2 - type: searchset + type: searchset \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042.yaml b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042.yaml index 82f59d44..65e88d2a 100644 --- a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042.yaml +++ b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042.yaml @@ -41,4 +41,4 @@ ListRelationship9000000042: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 1 - type: searchset + type: searchset \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042_include.yaml b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042_include.yaml index 909dc04d..d032bb09 100644 --- a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042_include.yaml +++ b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042_include.yaml @@ -62,4 +62,4 @@ ListRelationship9000000042Include: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 1 - type: searchset + type: searchset \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009.yaml b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009.yaml index 1b182b4c..72aa22cd 100644 --- a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009.yaml +++ b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009.yaml @@ -40,4 +40,4 @@ VerifyRelationship9000000009: mode: match link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000009&identifier=9000000017 + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000009&identifier=9000000017 \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009_include.yaml b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009_include.yaml index 2c8f8b61..a5db34ad 100644 --- a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009_include.yaml +++ b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009_include.yaml @@ -61,5 +61,4 @@ VerifyRelationship9000000009Include: system: http://terminology.hl7.org/CodeSystem/v3-RoleCode resourceType: RelatedPerson search: - mode: match - + mode: match \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025.yaml b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025.yaml index 4bfd2baa..62d9091e 100644 --- a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025.yaml +++ b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025.yaml @@ -41,4 +41,4 @@ VerifyRelationship9000000025: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 1 - type: searchset + type: searchset \ No newline at end of file diff --git a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025_include.yaml b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025_include.yaml index a6a71fe7..f300b228 100644 --- a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025_include.yaml +++ b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025_include.yaml @@ -61,4 +61,4 @@ VerifyRelationship9000000025Include: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 1 - type: searchset + type: searchset \ No newline at end of file diff --git a/specification/examples/responses/PATCH_Consent/errors/invalid_patch_format.yaml b/specification/examples/responses/PATCH_Consent/errors/invalid_patch_format.yaml index 0fca91c8..7e77d386 100644 --- a/specification/examples/responses/PATCH_Consent/errors/invalid_patch_format.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/invalid_patch_format.yaml @@ -12,4 +12,5 @@ PatchConsentInvalidPatchFormatError: system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode" version: '1' severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" + \ No newline at end of file diff --git a/specification/examples/responses/PATCH_Consent/errors/invalid_path.yaml b/specification/examples/responses/PATCH_Consent/errors/invalid_path.yaml index 71fa991c..40d9f184 100644 --- a/specification/examples/responses/PATCH_Consent/errors/invalid_path.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/invalid_path.yaml @@ -12,4 +12,5 @@ PatchConsentInvalidPathError: system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode" version: '1' severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" + \ No newline at end of file diff --git a/specification/examples/responses/PATCH_Consent/errors/invalid_state_transition.yaml b/specification/examples/responses/PATCH_Consent/errors/invalid_state_transition.yaml index 11aaafc8..cd74153f 100644 --- a/specification/examples/responses/PATCH_Consent/errors/invalid_state_transition.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/invalid_state_transition.yaml @@ -12,4 +12,5 @@ PatchConsentInvalidStateTransitionError: system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode" version: '1' severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" + \ No newline at end of file diff --git a/specification/examples/responses/PATCH_Consent/errors/invalid_status_code.yaml b/specification/examples/responses/PATCH_Consent/errors/invalid_status_code.yaml index 12136948..acca6406 100644 --- a/specification/examples/responses/PATCH_Consent/errors/invalid_status_code.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/invalid_status_code.yaml @@ -12,4 +12,5 @@ PatchConsentInvalidStatusCodeError: system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode" version: '1' severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" + \ No newline at end of file diff --git a/specification/examples/responses/PATCH_Consent/errors/invalid_status_reason.yaml b/specification/examples/responses/PATCH_Consent/errors/invalid_status_reason.yaml index 0303346a..843f0969 100644 --- a/specification/examples/responses/PATCH_Consent/errors/invalid_status_reason.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/invalid_status_reason.yaml @@ -13,3 +13,4 @@ PatchConsentInvalidStatusReasonError: version: '1' severity: error resourceType: "OperationOutcome" + diff --git a/specification/examples/responses/PATCH_Consent/errors/missing_free_text_for_other.yaml b/specification/examples/responses/PATCH_Consent/errors/missing_free_text_for_other.yaml index f1f1f840..61c597e3 100644 --- a/specification/examples/responses/PATCH_Consent/errors/missing_free_text_for_other.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/missing_free_text_for_other.yaml @@ -13,3 +13,4 @@ PatchConsentMissingFreeTextForOtherError: version: '1' severity: error resourceType: "OperationOutcome" + diff --git a/specification/examples/responses/PATCH_Consent/errors/resource_not_found.yaml b/specification/examples/responses/PATCH_Consent/errors/resource_not_found.yaml index b8a92895..9c40dcd6 100644 --- a/specification/examples/responses/PATCH_Consent/errors/resource_not_found.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/resource_not_found.yaml @@ -13,4 +13,5 @@ PatchConsentRelationshipNotFoundError: version: '1' severity: error resourceType: "OperationOutcome" + diff --git a/specification/examples/responses/PATCH_Consent/success.yaml b/specification/examples/responses/PATCH_Consent/success.yaml index 639b61ba..1141e3bf 100644 --- a/specification/examples/responses/PATCH_Consent/success.yaml +++ b/specification/examples/responses/PATCH_Consent/success.yaml @@ -6,3 +6,4 @@ PatchConsentSuccess: issue: - severity: information code: informational + diff --git a/specification/examples/responses/POST_Consent/errors/duplicate_relationship_error.yaml b/specification/examples/responses/POST_Consent/errors/duplicate_relationship_error.yaml index d0d01889..e6b7d7aa 100644 --- a/specification/examples/responses/POST_Consent/errors/duplicate_relationship_error.yaml +++ b/specification/examples/responses/POST_Consent/errors/duplicate_relationship_error.yaml @@ -12,4 +12,5 @@ PostConsentDuplicateRelationshipError: system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode" version: '1' severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" + \ No newline at end of file diff --git a/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml b/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml index 2c8aa423..46663455 100644 --- a/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml +++ b/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml @@ -15,3 +15,4 @@ PostConsentInvalidIdentifierValueError: - "extension.grantee.valueReference.identifier.value" severity: error resourceType: OperationOutcome + diff --git a/specification/examples/responses/POST_Consent/errors/invalid_request.yaml b/specification/examples/responses/POST_Consent/errors/invalid_request.yaml index 08ff5d9e..4803a7f0 100644 --- a/specification/examples/responses/POST_Consent/errors/invalid_request.yaml +++ b/specification/examples/responses/POST_Consent/errors/invalid_request.yaml @@ -28,4 +28,5 @@ PostConsentInvalidFHIRRequestError: diagnostics: 'The supplied input is not a valid FHIR Consent.' severity: error resourceType: "OperationOutcome" + diff --git a/specification/examples/responses/POST_Consent/errors/invalid_status.yaml b/specification/examples/responses/POST_Consent/errors/invalid_status.yaml index 4c8d606d..89364627 100644 --- a/specification/examples/responses/POST_Consent/errors/invalid_status.yaml +++ b/specification/examples/responses/POST_Consent/errors/invalid_status.yaml @@ -15,3 +15,4 @@ PostConsentInvalidStatusError: - "status" severity: error resourceType: OperationOutcome + diff --git a/specification/examples/responses/POST_Consent/errors/missing_free_text_for_other.yaml b/specification/examples/responses/POST_Consent/errors/missing_free_text_for_other.yaml index 88cfc745..cb49c21a 100644 --- a/specification/examples/responses/POST_Consent/errors/missing_free_text_for_other.yaml +++ b/specification/examples/responses/POST_Consent/errors/missing_free_text_for_other.yaml @@ -13,3 +13,4 @@ PostConsentMissingFreeTextForOtherError: version: '1' severity: error resourceType: "OperationOutcome" + diff --git a/specification/examples/responses/POST_Consent/errors/missing_identifier_system.yaml b/specification/examples/responses/POST_Consent/errors/missing_identifier_system.yaml index bcb65dc5..08908246 100644 --- a/specification/examples/responses/POST_Consent/errors/missing_identifier_system.yaml +++ b/specification/examples/responses/POST_Consent/errors/missing_identifier_system.yaml @@ -15,3 +15,4 @@ PostConsentMissingIdentifierSystemError: - "patient.identifier.system" severity: error resourceType: OperationOutcome + diff --git a/specification/examples/responses/POST_Consent/errors/missing_scope.yaml b/specification/examples/responses/POST_Consent/errors/missing_scope.yaml index 8d4c6408..0f7375c3 100644 --- a/specification/examples/responses/POST_Consent/errors/missing_scope.yaml +++ b/specification/examples/responses/POST_Consent/errors/missing_scope.yaml @@ -15,3 +15,4 @@ PostConsentMissingScopeError: - "scope" severity: error resourceType: OperationOutcome + diff --git a/specification/examples/responses/POST_Consent/success.yaml b/specification/examples/responses/POST_Consent/success.yaml index 204d946a..1ac2e7c8 100644 --- a/specification/examples/responses/POST_Consent/success.yaml +++ b/specification/examples/responses/POST_Consent/success.yaml @@ -6,3 +6,4 @@ PostConsentSuccess: issue: - severity: information code: informational + diff --git a/specification/examples/responses/POST_QuestionnaireResponse/errors/duplicate_relationship_error.yaml b/specification/examples/responses/POST_QuestionnaireResponse/errors/duplicate_relationship_error.yaml index d97dc7cd..a7f9b730 100644 --- a/specification/examples/responses/POST_QuestionnaireResponse/errors/duplicate_relationship_error.yaml +++ b/specification/examples/responses/POST_QuestionnaireResponse/errors/duplicate_relationship_error.yaml @@ -13,3 +13,4 @@ PostQuestionnaireResponseDuplicateRelationshipError: version: '1' severity: error resourceType: "OperationOutcome" + diff --git a/specification/examples/responses/POST_QuestionnaireResponse/success.yaml b/specification/examples/responses/POST_QuestionnaireResponse/success.yaml index 2cf2d6db..163652cb 100644 --- a/specification/examples/responses/POST_QuestionnaireResponse/success.yaml +++ b/specification/examples/responses/POST_QuestionnaireResponse/success.yaml @@ -9,4 +9,5 @@ PostQuestionnaireResponseSuccess: details: coding: - code: "19318ZGLAB" - display: "19318ZGLAB" \ No newline at end of file + display: "19318ZGLAB" + \ No newline at end of file diff --git a/specification/examples/responses/errors/access-denied.yaml b/specification/examples/responses/errors/access-denied.yaml index ba32883a..e95088d1 100644 --- a/specification/examples/responses/errors/access-denied.yaml +++ b/specification/examples/responses/errors/access-denied.yaml @@ -12,4 +12,4 @@ AccessDeniedError: version: "1" diagnostics: "Missing or invalid OAuth 2.0 bearer token in request" severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/errors/downstream-service-error.yaml b/specification/examples/responses/errors/downstream-service-error.yaml index 55b12995..45993aca 100644 --- a/specification/examples/responses/errors/downstream-service-error.yaml +++ b/specification/examples/responses/errors/downstream-service-error.yaml @@ -12,4 +12,4 @@ DownstreamServiceError: version: "1" diagnostics: "Downstream Service Error - Failed to generate response is present in the response" severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/errors/internal-server-error.yaml b/specification/examples/responses/errors/internal-server-error.yaml index 63db6319..4c34dc64 100644 --- a/specification/examples/responses/errors/internal-server-error.yaml +++ b/specification/examples/responses/errors/internal-server-error.yaml @@ -12,4 +12,4 @@ InternalServerError: version: "1" diagnostics: "Internal Server Error - Failed to generate response is present in the response" severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/errors/invalid-include-parameter.yaml b/specification/examples/responses/errors/invalid-include-parameter.yaml index b043e37e..c05c1b74 100644 --- a/specification/examples/responses/errors/invalid-include-parameter.yaml +++ b/specification/examples/responses/errors/invalid-include-parameter.yaml @@ -12,4 +12,4 @@ InvalidIncludeParameterError: display: "Required parameter(s) are invalid." diagnostics: "Invalid request with error - _include parameter is invalid." severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/errors/invalidated-resource.yaml b/specification/examples/responses/errors/invalidated-resource.yaml index 81f54989..fdd8ddae 100644 --- a/specification/examples/responses/errors/invalidated-resource.yaml +++ b/specification/examples/responses/errors/invalidated-resource.yaml @@ -12,4 +12,4 @@ InvalidatedResourceError: display: "Resource that has been marked as invalid was requested - invalid resources cannot be retrieved" diagnostics: "Resource that has been marked as invalid was requested - invalid resources cannot be retrieved" severity: error - resourceType: "OperationOutcome" + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/errors/method-not-allowed.yaml b/specification/examples/responses/errors/method-not-allowed.yaml index 37c27618..0270ce46 100644 --- a/specification/examples/responses/errors/method-not-allowed.yaml +++ b/specification/examples/responses/errors/method-not-allowed.yaml @@ -12,4 +12,4 @@ MethodNotAllowedError: code: "METHOD_NOT_ALLOWED" display: "The method is not allowed." diagnostics: "The method is not allowed for the requested resource." - severity: "error" + severity: "error" \ No newline at end of file From a5755f9e6efbb41863116969915dde70e412fa34 Mon Sep 17 00:00:00 2001 From: adamclarkson Date: Fri, 13 Feb 2026 16:20:19 +0000 Subject: [PATCH 3/6] Revert "NPA-6376: Update yaml files" This reverts commit 5803b12429a0e3813672a8d105d01cab99ae591a. --- .../requests/PATCH_Consent/replace_provision_end_date.yaml | 2 +- .../examples/requests/PATCH_Consent/replace_status.yaml | 3 ++- .../POST_QuestionnaireResponse/adult-nominates-adult.yaml | 2 +- .../adult-to-adult-with-capacity.yaml | 2 +- .../adult-to-adult-without-capacity.yaml | 2 +- .../POST_QuestionnaireResponse/duplicate_relationship.yaml | 2 +- .../requests/POST_QuestionnaireResponse/mother-child.yaml | 2 +- .../examples/responses/GET_Consent/ID/errors/invalid-id.yaml | 2 +- .../responses/GET_Consent/errors/gp-practice-not-found.yaml | 2 +- .../GET_Consent/errors/invalid-identifier-system.yaml | 2 +- .../responses/GET_Consent/errors/invalid-identifier.yaml | 3 ++- .../responses/GET_Consent/errors/invalid-status-parameter.yaml | 2 +- .../responses/GET_Consent/errors/missing-identifier.yaml | 2 +- .../filtered-relationships-status-active-include-details.yaml | 2 +- .../GET_Consent/filtered-relationships-status-inactive.yaml | 2 +- .../filtered-relationships-status-proposed-active.yaml | 2 +- .../GET_Consent/multiple-relationships-include-patient.yaml | 2 +- .../multiple-relationships-include-performer-patient.yaml | 2 +- .../GET_Consent/multiple-relationships-include-performer.yaml | 3 ++- .../multiple-relationships-single-patient-include-patient.yaml | 2 +- ...relationships-single-patient-include-performer-patient.yaml | 2 +- ...ultiple-relationships-single-patient-include-performer.yaml | 2 +- .../GET_Consent/multiple-relationships-single-patient.yaml | 2 +- .../examples/responses/GET_Consent/multiple-relationships.yaml | 2 +- .../examples/responses/GET_Consent/no-relationships.yaml | 2 +- .../single-consenting-adult-relationship-include-patient.yaml | 2 +- ...onsenting-adult-relationship-include-performer-patient.yaml | 2 +- ...single-consenting-adult-relationship-include-performer.yaml | 2 +- .../GET_Consent/single-consenting-adult-relationship.yaml | 2 +- .../single-mother-child-relationship-include-patient.yaml | 2 +- ...le-mother-child-relationship-include-performer-patient.yaml | 2 +- .../single-mother-child-relationship-include-performer.yaml | 2 +- .../single-mother-child-relationship-unknown-legal-basis.yaml | 2 +- .../GET_Consent/single-mother-child-relationship.yaml | 2 +- .../errors/invalid_access_request_id.yaml | 2 +- .../errors/missing_access_request_id.yaml | 2 +- .../errors/questionnaire_response_not_found.yaml | 2 +- .../examples/responses/GET_QuestionnaireResponse/success.yaml | 2 +- .../responses/GET_RelatedPerson/empty_response_9000000033.yaml | 2 +- .../GET_RelatedPerson/errors/invalid-identifier-missing.yaml | 2 +- .../GET_RelatedPerson/errors/invalid-identifier-patient.yaml | 2 +- .../GET_RelatedPerson/errors/invalid-identifier-system.yaml | 2 +- .../responses/GET_RelatedPerson/errors/invalid-identifier.yaml | 2 +- .../GET_RelatedPerson/list_relationship_9000000017.yaml | 2 +- .../list_relationship_9000000017_include.yaml | 2 +- .../GET_RelatedPerson/list_relationship_9000000042.yaml | 2 +- .../list_relationship_9000000042_include.yaml | 2 +- .../GET_RelatedPerson/verify_relationship_9000000009.yaml | 2 +- .../verify_relationship_9000000009_include.yaml | 3 ++- .../GET_RelatedPerson/verify_relationship_9000000025.yaml | 2 +- .../verify_relationship_9000000025_include.yaml | 2 +- .../responses/PATCH_Consent/errors/invalid_patch_format.yaml | 3 +-- .../examples/responses/PATCH_Consent/errors/invalid_path.yaml | 3 +-- .../PATCH_Consent/errors/invalid_state_transition.yaml | 3 +-- .../responses/PATCH_Consent/errors/invalid_status_code.yaml | 3 +-- .../responses/PATCH_Consent/errors/invalid_status_reason.yaml | 1 - .../PATCH_Consent/errors/missing_free_text_for_other.yaml | 1 - .../responses/PATCH_Consent/errors/resource_not_found.yaml | 1 - specification/examples/responses/PATCH_Consent/success.yaml | 1 - .../POST_Consent/errors/duplicate_relationship_error.yaml | 3 +-- .../POST_Consent/errors/invalid_identifier_value.yaml | 1 - .../responses/POST_Consent/errors/invalid_request.yaml | 1 - .../examples/responses/POST_Consent/errors/invalid_status.yaml | 1 - .../POST_Consent/errors/missing_free_text_for_other.yaml | 1 - .../POST_Consent/errors/missing_identifier_system.yaml | 1 - .../examples/responses/POST_Consent/errors/missing_scope.yaml | 1 - specification/examples/responses/POST_Consent/success.yaml | 1 - .../errors/duplicate_relationship_error.yaml | 1 - .../examples/responses/POST_QuestionnaireResponse/success.yaml | 3 +-- specification/examples/responses/errors/access-denied.yaml | 2 +- .../examples/responses/errors/downstream-service-error.yaml | 2 +- .../examples/responses/errors/internal-server-error.yaml | 2 +- .../examples/responses/errors/invalid-include-parameter.yaml | 2 +- .../examples/responses/errors/invalidated-resource.yaml | 2 +- .../examples/responses/errors/method-not-allowed.yaml | 2 +- 75 files changed, 67 insertions(+), 81 deletions(-) diff --git a/specification/examples/requests/PATCH_Consent/replace_provision_end_date.yaml b/specification/examples/requests/PATCH_Consent/replace_provision_end_date.yaml index 1661c897..958c5590 100644 --- a/specification/examples/requests/PATCH_Consent/replace_provision_end_date.yaml +++ b/specification/examples/requests/PATCH_Consent/replace_provision_end_date.yaml @@ -6,4 +6,4 @@ UpdateProvisionEndDate: value: - op: add path: /provision/period/end - value: "2026-12-31T23:59:59Z" \ No newline at end of file + value: "2026-12-31T23:59:59Z" diff --git a/specification/examples/requests/PATCH_Consent/replace_status.yaml b/specification/examples/requests/PATCH_Consent/replace_status.yaml index 4ced5f7c..ccf29ffb 100644 --- a/specification/examples/requests/PATCH_Consent/replace_status.yaml +++ b/specification/examples/requests/PATCH_Consent/replace_status.yaml @@ -13,4 +13,5 @@ StatusUpdate: coding: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED - display: Role created \ No newline at end of file + display: Role created + diff --git a/specification/examples/requests/POST_QuestionnaireResponse/adult-nominates-adult.yaml b/specification/examples/requests/POST_QuestionnaireResponse/adult-nominates-adult.yaml index bc548795..0fc66fc0 100644 --- a/specification/examples/requests/POST_QuestionnaireResponse/adult-nominates-adult.yaml +++ b/specification/examples/requests/POST_QuestionnaireResponse/adult-nominates-adult.yaml @@ -89,4 +89,4 @@ QuestionnaireResponseAdultNominatesAdultRequest: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "PRAC" - display: "Practical Reasons" \ No newline at end of file + display: "Practical Reasons" diff --git a/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-with-capacity.yaml b/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-with-capacity.yaml index 74fa0cc5..528d9323 100644 --- a/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-with-capacity.yaml +++ b/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-with-capacity.yaml @@ -89,4 +89,4 @@ QuestionnaireResponseAdultToAdultWithCapacityRequest: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "PRAC" - display: "Practical Reasons" \ No newline at end of file + display: "Practical Reasons" diff --git a/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-without-capacity.yaml b/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-without-capacity.yaml index 42f15802..45d16f75 100644 --- a/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-without-capacity.yaml +++ b/specification/examples/requests/POST_QuestionnaireResponse/adult-to-adult-without-capacity.yaml @@ -89,4 +89,4 @@ QuestionnaireResponseAdultToAdultWithoutCapacityRequest: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "TECH" - display: "Technical Barriers" \ No newline at end of file + display: "Technical Barriers" diff --git a/specification/examples/requests/POST_QuestionnaireResponse/duplicate_relationship.yaml b/specification/examples/requests/POST_QuestionnaireResponse/duplicate_relationship.yaml index 6cff3169..901c9f52 100644 --- a/specification/examples/requests/POST_QuestionnaireResponse/duplicate_relationship.yaml +++ b/specification/examples/requests/POST_QuestionnaireResponse/duplicate_relationship.yaml @@ -89,4 +89,4 @@ QuestionnaireResponseDuplicateRelationship: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "PRAC" - display: "Practical Reasons" \ No newline at end of file + display: "Practical Reasons" diff --git a/specification/examples/requests/POST_QuestionnaireResponse/mother-child.yaml b/specification/examples/requests/POST_QuestionnaireResponse/mother-child.yaml index b3120e06..ba4ed227 100644 --- a/specification/examples/requests/POST_QuestionnaireResponse/mother-child.yaml +++ b/specification/examples/requests/POST_QuestionnaireResponse/mother-child.yaml @@ -135,4 +135,4 @@ QuestionnaireResponseMotherChildRequest: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "PRAC" - display: "Practical Reasons" \ No newline at end of file + display: "Practical Reasons" diff --git a/specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml b/specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml index e160ba7c..9f2e8594 100644 --- a/specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml +++ b/specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml @@ -12,4 +12,4 @@ ConsentInvalidIDError: version: "1" diagnostics: "Invalid request with error - ID must be a valid UUID." severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml b/specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml index 07986ff7..e54ac061 100644 --- a/specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml +++ b/specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml @@ -12,4 +12,4 @@ GPPracticeNotFoundError: display: "GP Practice could not be found - invalid resources cannot be retrieved" diagnostics: "GP Practice could not be found" severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml b/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml index f5293b1a..aaa46e9c 100644 --- a/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml +++ b/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml @@ -12,4 +12,4 @@ ConsentInvalidIdentifierSystemError: version: '1' diagnostics: "Invalid request with error - performer:identifier or patient:identifier system parameter is invalid." severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml b/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml index c1e4bad0..e5896648 100644 --- a/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml +++ b/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml @@ -12,4 +12,5 @@ ConsentInvalidIdentifierError: version: '1' diagnostics: 'Invalid request with error - performer:identifier or patient:identifier parameter is invalid.' severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" + diff --git a/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml b/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml index 114ea553..5bfe2491 100644 --- a/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml +++ b/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml @@ -12,4 +12,4 @@ ConsentInvalidStatusParameterError: version: "1" diagnostics: "Invalid request with error - status parameter is invalid." severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/GET_Consent/errors/missing-identifier.yaml b/specification/examples/responses/GET_Consent/errors/missing-identifier.yaml index f5341530..f54235f2 100644 --- a/specification/examples/responses/GET_Consent/errors/missing-identifier.yaml +++ b/specification/examples/responses/GET_Consent/errors/missing-identifier.yaml @@ -12,4 +12,4 @@ ConsentIdentifierMissingError: version: "1" diagnostics: "Invalid request with error - performer:identifier or patient:identifier parameter not found." severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" 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 2f74c515..c4686c3f 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 @@ -228,4 +228,4 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 fb7f9f71..aa4b1ea6 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml @@ -116,4 +116,4 @@ ConsentMultipleRelationshipsStatusInactiveBundle: system: https://fhir.nhs.uk/Id/nhs-number value: '9000000017' search: - mode: match \ No newline at end of file + mode: match 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 cceb76ad..c925499c 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 @@ -244,4 +244,4 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 5e373781..6118be44 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml @@ -273,4 +273,4 @@ ConsentMultipleRelationshipsIncludePatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 5006d1e5..55990492 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 @@ -335,4 +335,4 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 71f660a8..48e91fba 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml @@ -250,4 +250,5 @@ ConsentMultipleRelationshipsIncludePerformerBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match + 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 10ca38b3..4940c89a 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 @@ -212,4 +212,4 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 3dd013f7..efc18a0a 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 @@ -270,4 +270,4 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 b77d5fb3..593ebf55 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 @@ -241,4 +241,4 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 97de0177..30c14904 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml @@ -183,4 +183,4 @@ ConsentMultipleRelationshipsSinglePatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match diff --git a/specification/examples/responses/GET_Consent/multiple-relationships.yaml b/specification/examples/responses/GET_Consent/multiple-relationships.yaml index 67d9a962..768617a5 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships.yaml @@ -183,4 +183,4 @@ ConsentMultipleRelationshipsBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match diff --git a/specification/examples/responses/GET_Consent/no-relationships.yaml b/specification/examples/responses/GET_Consent/no-relationships.yaml index 83852119..0eaf7df2 100644 --- a/specification/examples/responses/GET_Consent/no-relationships.yaml +++ b/specification/examples/responses/GET_Consent/no-relationships.yaml @@ -9,4 +9,4 @@ ConsentNoRelationshipsEmptyBundle: link: - relation: self url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:performer&_include=Consent:patient - entry: [] \ No newline at end of file + entry: [] 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 ed1f74b8..1f2011fa 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 @@ -96,4 +96,4 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 110b75bc..72d243a2 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 @@ -117,4 +117,4 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 22d0c490..7957a585 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 @@ -87,4 +87,4 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 108c5704..423399b1 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml @@ -67,4 +67,4 @@ ConsentSingleConsentingAdultRelationshipBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 35928e6f..51011e78 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 @@ -93,4 +93,4 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 94e3da94..6572d0fe 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 @@ -121,4 +121,4 @@ ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 c34f2132..e54189fb 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 @@ -90,4 +90,4 @@ ConsentSingleAdultChildRelationshipIncludePerformerBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 747b2c12..d28196b6 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 @@ -70,4 +70,4 @@ ConsentSingleAdultChildRelationshipUnknownLegalBasisBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match 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 20b09aed..ed0c1f04 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml @@ -67,4 +67,4 @@ ConsentSingleAdultChildRelationshipBundle: system: https://fhir.nhs.uk/Id/ods-organization-code value: "G8101234" search: - mode: match \ No newline at end of file + mode: match diff --git a/specification/examples/responses/GET_QuestionnaireResponse/errors/invalid_access_request_id.yaml b/specification/examples/responses/GET_QuestionnaireResponse/errors/invalid_access_request_id.yaml index 93f9548b..81d65d5d 100644 --- a/specification/examples/responses/GET_QuestionnaireResponse/errors/invalid_access_request_id.yaml +++ b/specification/examples/responses/GET_QuestionnaireResponse/errors/invalid_access_request_id.yaml @@ -11,4 +11,4 @@ InvalidAccessRequestID: - system: "https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1" code: "INVALID_IDENTIFIER_VALUE" display: "Invalid identifier value" - diagnostics: "The specified access request ID is invalid. Access request IDs must be a valid UUID." \ No newline at end of file + diagnostics: "The specified access request ID is invalid. Access request IDs must be a valid UUID." diff --git a/specification/examples/responses/GET_QuestionnaireResponse/errors/missing_access_request_id.yaml b/specification/examples/responses/GET_QuestionnaireResponse/errors/missing_access_request_id.yaml index 092314be..92e53386 100644 --- a/specification/examples/responses/GET_QuestionnaireResponse/errors/missing_access_request_id.yaml +++ b/specification/examples/responses/GET_QuestionnaireResponse/errors/missing_access_request_id.yaml @@ -11,4 +11,4 @@ MissingAccessRequestID: - system: "https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1" code: "BAD_REQUEST" display: "Bad request" - diagnostics: "The access request ID parameter is required but was not provided." \ No newline at end of file + diagnostics: "The access request ID parameter is required but was not provided." diff --git a/specification/examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml b/specification/examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml index 27f2b93c..04627dfe 100644 --- a/specification/examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml +++ b/specification/examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml @@ -11,4 +11,4 @@ QuestionnaireResponseNotFound: - system: "https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1" code: "QUESTIONNAIRE_RESPONSE_NOT_FOUND" display: "Questionnaire response not found" - diagnostics: "The Questionnaire response could not be found using the provided access request ID." \ No newline at end of file + diagnostics: "The Questionnaire response could not be found using the provided access request ID." diff --git a/specification/examples/responses/GET_QuestionnaireResponse/success.yaml b/specification/examples/responses/GET_QuestionnaireResponse/success.yaml index 41773828..c3538a83 100644 --- a/specification/examples/responses/GET_QuestionnaireResponse/success.yaml +++ b/specification/examples/responses/GET_QuestionnaireResponse/success.yaml @@ -105,4 +105,4 @@ GetQuestionnaireResponseSuccess: - valueCoding: system: "https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess" code: "PRAC" - display: "Practical Reasons" \ No newline at end of file + display: "Practical Reasons" diff --git a/specification/examples/responses/GET_RelatedPerson/empty_response_9000000033.yaml b/specification/examples/responses/GET_RelatedPerson/empty_response_9000000033.yaml index 7a7fb1f5..ca01e0a0 100644 --- a/specification/examples/responses/GET_RelatedPerson/empty_response_9000000033.yaml +++ b/specification/examples/responses/GET_RelatedPerson/empty_response_9000000033.yaml @@ -10,4 +10,4 @@ RelatedEmptyResponse: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships-service-api/FHIR/R4/RelatedPerson?identifier=9000000033 \ No newline at end of file + url: https://sandbox.api.service.nhs.uk/validated-relationships-service-api/FHIR/R4/RelatedPerson?identifier=9000000033 diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-missing.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-missing.yaml index d25fe81a..bf461cf3 100644 --- a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-missing.yaml +++ b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-missing.yaml @@ -12,4 +12,4 @@ RelatedPersonInvalidIdentifierMissing: version: '1' diagnostics: The 'identifier' parameter is required severity: error - resourceType: OperationOutcome \ No newline at end of file + resourceType: OperationOutcome diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml index e3d98805..8c7cb6ae 100644 --- a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml +++ b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml @@ -12,4 +12,4 @@ InvalidIdentifierPatientError: display: "Provided value is invalid" diagnostics: "Not a valid NHS Number provided for the 'patient:identifier' parameter" severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml index 11f4d120..aba7b8f0 100644 --- a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml +++ b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml @@ -12,4 +12,4 @@ RelatedPersonInvalidIdentifierSystem: version: '1' diagnostics: The identifier system is not valid. severity: error - resourceType: OperationOutcome \ No newline at end of file + resourceType: OperationOutcome diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml index 133893e6..a92de12c 100644 --- a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml +++ b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml @@ -14,4 +14,4 @@ RelatedPersonInvalidIdentifierError: expression: - "RelatedPerson.identifier" severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017.yaml b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017.yaml index 230b1e53..4f7ca54a 100644 --- a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017.yaml +++ b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017.yaml @@ -69,4 +69,4 @@ ListRelationship9000000017: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 2 - type: searchset \ No newline at end of file + type: searchset diff --git a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017_include.yaml b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017_include.yaml index 60d7e90e..16e5e150 100644 --- a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017_include.yaml +++ b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017_include.yaml @@ -108,4 +108,4 @@ ListRelationship9000000017Include: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 2 - type: searchset \ No newline at end of file + type: searchset diff --git a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042.yaml b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042.yaml index 65e88d2a..82f59d44 100644 --- a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042.yaml +++ b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042.yaml @@ -41,4 +41,4 @@ ListRelationship9000000042: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 1 - type: searchset \ No newline at end of file + type: searchset diff --git a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042_include.yaml b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042_include.yaml index d032bb09..909dc04d 100644 --- a/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042_include.yaml +++ b/specification/examples/responses/GET_RelatedPerson/list_relationship_9000000042_include.yaml @@ -62,4 +62,4 @@ ListRelationship9000000042Include: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 1 - type: searchset \ No newline at end of file + type: searchset diff --git a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009.yaml b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009.yaml index 72aa22cd..1b182b4c 100644 --- a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009.yaml +++ b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009.yaml @@ -40,4 +40,4 @@ VerifyRelationship9000000009: mode: match link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000009&identifier=9000000017 \ No newline at end of file + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000009&identifier=9000000017 diff --git a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009_include.yaml b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009_include.yaml index a5db34ad..2c8f8b61 100644 --- a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009_include.yaml +++ b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009_include.yaml @@ -61,4 +61,5 @@ VerifyRelationship9000000009Include: system: http://terminology.hl7.org/CodeSystem/v3-RoleCode resourceType: RelatedPerson search: - mode: match \ No newline at end of file + mode: match + diff --git a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025.yaml b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025.yaml index 62d9091e..4bfd2baa 100644 --- a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025.yaml +++ b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025.yaml @@ -41,4 +41,4 @@ VerifyRelationship9000000025: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 1 - type: searchset \ No newline at end of file + type: searchset diff --git a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025_include.yaml b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025_include.yaml index f300b228..a6a71fe7 100644 --- a/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025_include.yaml +++ b/specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000025_include.yaml @@ -61,4 +61,4 @@ VerifyRelationship9000000025Include: resourceType: Bundle timestamp: '2024-01-01T00:00:00+00:00' total: 1 - type: searchset \ No newline at end of file + type: searchset diff --git a/specification/examples/responses/PATCH_Consent/errors/invalid_patch_format.yaml b/specification/examples/responses/PATCH_Consent/errors/invalid_patch_format.yaml index 7e77d386..0fca91c8 100644 --- a/specification/examples/responses/PATCH_Consent/errors/invalid_patch_format.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/invalid_patch_format.yaml @@ -12,5 +12,4 @@ PatchConsentInvalidPatchFormatError: system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode" version: '1' severity: error - resourceType: "OperationOutcome" - \ No newline at end of file + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/PATCH_Consent/errors/invalid_path.yaml b/specification/examples/responses/PATCH_Consent/errors/invalid_path.yaml index 40d9f184..71fa991c 100644 --- a/specification/examples/responses/PATCH_Consent/errors/invalid_path.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/invalid_path.yaml @@ -12,5 +12,4 @@ PatchConsentInvalidPathError: system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode" version: '1' severity: error - resourceType: "OperationOutcome" - \ No newline at end of file + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/PATCH_Consent/errors/invalid_state_transition.yaml b/specification/examples/responses/PATCH_Consent/errors/invalid_state_transition.yaml index cd74153f..11aaafc8 100644 --- a/specification/examples/responses/PATCH_Consent/errors/invalid_state_transition.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/invalid_state_transition.yaml @@ -12,5 +12,4 @@ PatchConsentInvalidStateTransitionError: system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode" version: '1' severity: error - resourceType: "OperationOutcome" - \ No newline at end of file + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/PATCH_Consent/errors/invalid_status_code.yaml b/specification/examples/responses/PATCH_Consent/errors/invalid_status_code.yaml index acca6406..12136948 100644 --- a/specification/examples/responses/PATCH_Consent/errors/invalid_status_code.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/invalid_status_code.yaml @@ -12,5 +12,4 @@ PatchConsentInvalidStatusCodeError: system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode" version: '1' severity: error - resourceType: "OperationOutcome" - \ No newline at end of file + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/PATCH_Consent/errors/invalid_status_reason.yaml b/specification/examples/responses/PATCH_Consent/errors/invalid_status_reason.yaml index 843f0969..0303346a 100644 --- a/specification/examples/responses/PATCH_Consent/errors/invalid_status_reason.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/invalid_status_reason.yaml @@ -13,4 +13,3 @@ PatchConsentInvalidStatusReasonError: version: '1' severity: error resourceType: "OperationOutcome" - diff --git a/specification/examples/responses/PATCH_Consent/errors/missing_free_text_for_other.yaml b/specification/examples/responses/PATCH_Consent/errors/missing_free_text_for_other.yaml index 61c597e3..f1f1f840 100644 --- a/specification/examples/responses/PATCH_Consent/errors/missing_free_text_for_other.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/missing_free_text_for_other.yaml @@ -13,4 +13,3 @@ PatchConsentMissingFreeTextForOtherError: version: '1' severity: error resourceType: "OperationOutcome" - diff --git a/specification/examples/responses/PATCH_Consent/errors/resource_not_found.yaml b/specification/examples/responses/PATCH_Consent/errors/resource_not_found.yaml index 9c40dcd6..b8a92895 100644 --- a/specification/examples/responses/PATCH_Consent/errors/resource_not_found.yaml +++ b/specification/examples/responses/PATCH_Consent/errors/resource_not_found.yaml @@ -13,5 +13,4 @@ PatchConsentRelationshipNotFoundError: version: '1' severity: error resourceType: "OperationOutcome" - diff --git a/specification/examples/responses/PATCH_Consent/success.yaml b/specification/examples/responses/PATCH_Consent/success.yaml index 1141e3bf..639b61ba 100644 --- a/specification/examples/responses/PATCH_Consent/success.yaml +++ b/specification/examples/responses/PATCH_Consent/success.yaml @@ -6,4 +6,3 @@ PatchConsentSuccess: issue: - severity: information code: informational - diff --git a/specification/examples/responses/POST_Consent/errors/duplicate_relationship_error.yaml b/specification/examples/responses/POST_Consent/errors/duplicate_relationship_error.yaml index e6b7d7aa..d0d01889 100644 --- a/specification/examples/responses/POST_Consent/errors/duplicate_relationship_error.yaml +++ b/specification/examples/responses/POST_Consent/errors/duplicate_relationship_error.yaml @@ -12,5 +12,4 @@ PostConsentDuplicateRelationshipError: system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode" version: '1' severity: error - resourceType: "OperationOutcome" - \ No newline at end of file + resourceType: "OperationOutcome" \ No newline at end of file diff --git a/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml b/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml index 46663455..2c8aa423 100644 --- a/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml +++ b/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml @@ -15,4 +15,3 @@ PostConsentInvalidIdentifierValueError: - "extension.grantee.valueReference.identifier.value" severity: error resourceType: OperationOutcome - diff --git a/specification/examples/responses/POST_Consent/errors/invalid_request.yaml b/specification/examples/responses/POST_Consent/errors/invalid_request.yaml index 4803a7f0..08ff5d9e 100644 --- a/specification/examples/responses/POST_Consent/errors/invalid_request.yaml +++ b/specification/examples/responses/POST_Consent/errors/invalid_request.yaml @@ -28,5 +28,4 @@ PostConsentInvalidFHIRRequestError: diagnostics: 'The supplied input is not a valid FHIR Consent.' severity: error resourceType: "OperationOutcome" - diff --git a/specification/examples/responses/POST_Consent/errors/invalid_status.yaml b/specification/examples/responses/POST_Consent/errors/invalid_status.yaml index 89364627..4c8d606d 100644 --- a/specification/examples/responses/POST_Consent/errors/invalid_status.yaml +++ b/specification/examples/responses/POST_Consent/errors/invalid_status.yaml @@ -15,4 +15,3 @@ PostConsentInvalidStatusError: - "status" severity: error resourceType: OperationOutcome - diff --git a/specification/examples/responses/POST_Consent/errors/missing_free_text_for_other.yaml b/specification/examples/responses/POST_Consent/errors/missing_free_text_for_other.yaml index cb49c21a..88cfc745 100644 --- a/specification/examples/responses/POST_Consent/errors/missing_free_text_for_other.yaml +++ b/specification/examples/responses/POST_Consent/errors/missing_free_text_for_other.yaml @@ -13,4 +13,3 @@ PostConsentMissingFreeTextForOtherError: version: '1' severity: error resourceType: "OperationOutcome" - diff --git a/specification/examples/responses/POST_Consent/errors/missing_identifier_system.yaml b/specification/examples/responses/POST_Consent/errors/missing_identifier_system.yaml index 08908246..bcb65dc5 100644 --- a/specification/examples/responses/POST_Consent/errors/missing_identifier_system.yaml +++ b/specification/examples/responses/POST_Consent/errors/missing_identifier_system.yaml @@ -15,4 +15,3 @@ PostConsentMissingIdentifierSystemError: - "patient.identifier.system" severity: error resourceType: OperationOutcome - diff --git a/specification/examples/responses/POST_Consent/errors/missing_scope.yaml b/specification/examples/responses/POST_Consent/errors/missing_scope.yaml index 0f7375c3..8d4c6408 100644 --- a/specification/examples/responses/POST_Consent/errors/missing_scope.yaml +++ b/specification/examples/responses/POST_Consent/errors/missing_scope.yaml @@ -15,4 +15,3 @@ PostConsentMissingScopeError: - "scope" severity: error resourceType: OperationOutcome - diff --git a/specification/examples/responses/POST_Consent/success.yaml b/specification/examples/responses/POST_Consent/success.yaml index 1ac2e7c8..204d946a 100644 --- a/specification/examples/responses/POST_Consent/success.yaml +++ b/specification/examples/responses/POST_Consent/success.yaml @@ -6,4 +6,3 @@ PostConsentSuccess: issue: - severity: information code: informational - diff --git a/specification/examples/responses/POST_QuestionnaireResponse/errors/duplicate_relationship_error.yaml b/specification/examples/responses/POST_QuestionnaireResponse/errors/duplicate_relationship_error.yaml index a7f9b730..d97dc7cd 100644 --- a/specification/examples/responses/POST_QuestionnaireResponse/errors/duplicate_relationship_error.yaml +++ b/specification/examples/responses/POST_QuestionnaireResponse/errors/duplicate_relationship_error.yaml @@ -13,4 +13,3 @@ PostQuestionnaireResponseDuplicateRelationshipError: version: '1' severity: error resourceType: "OperationOutcome" - diff --git a/specification/examples/responses/POST_QuestionnaireResponse/success.yaml b/specification/examples/responses/POST_QuestionnaireResponse/success.yaml index 163652cb..2cf2d6db 100644 --- a/specification/examples/responses/POST_QuestionnaireResponse/success.yaml +++ b/specification/examples/responses/POST_QuestionnaireResponse/success.yaml @@ -9,5 +9,4 @@ PostQuestionnaireResponseSuccess: details: coding: - code: "19318ZGLAB" - display: "19318ZGLAB" - \ No newline at end of file + display: "19318ZGLAB" \ No newline at end of file diff --git a/specification/examples/responses/errors/access-denied.yaml b/specification/examples/responses/errors/access-denied.yaml index e95088d1..ba32883a 100644 --- a/specification/examples/responses/errors/access-denied.yaml +++ b/specification/examples/responses/errors/access-denied.yaml @@ -12,4 +12,4 @@ AccessDeniedError: version: "1" diagnostics: "Missing or invalid OAuth 2.0 bearer token in request" severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/errors/downstream-service-error.yaml b/specification/examples/responses/errors/downstream-service-error.yaml index 45993aca..55b12995 100644 --- a/specification/examples/responses/errors/downstream-service-error.yaml +++ b/specification/examples/responses/errors/downstream-service-error.yaml @@ -12,4 +12,4 @@ DownstreamServiceError: version: "1" diagnostics: "Downstream Service Error - Failed to generate response is present in the response" severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/errors/internal-server-error.yaml b/specification/examples/responses/errors/internal-server-error.yaml index 4c34dc64..63db6319 100644 --- a/specification/examples/responses/errors/internal-server-error.yaml +++ b/specification/examples/responses/errors/internal-server-error.yaml @@ -12,4 +12,4 @@ InternalServerError: version: "1" diagnostics: "Internal Server Error - Failed to generate response is present in the response" severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/errors/invalid-include-parameter.yaml b/specification/examples/responses/errors/invalid-include-parameter.yaml index c05c1b74..b043e37e 100644 --- a/specification/examples/responses/errors/invalid-include-parameter.yaml +++ b/specification/examples/responses/errors/invalid-include-parameter.yaml @@ -12,4 +12,4 @@ InvalidIncludeParameterError: display: "Required parameter(s) are invalid." diagnostics: "Invalid request with error - _include parameter is invalid." severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/errors/invalidated-resource.yaml b/specification/examples/responses/errors/invalidated-resource.yaml index fdd8ddae..81f54989 100644 --- a/specification/examples/responses/errors/invalidated-resource.yaml +++ b/specification/examples/responses/errors/invalidated-resource.yaml @@ -12,4 +12,4 @@ InvalidatedResourceError: display: "Resource that has been marked as invalid was requested - invalid resources cannot be retrieved" diagnostics: "Resource that has been marked as invalid was requested - invalid resources cannot be retrieved" severity: error - resourceType: "OperationOutcome" \ No newline at end of file + resourceType: "OperationOutcome" diff --git a/specification/examples/responses/errors/method-not-allowed.yaml b/specification/examples/responses/errors/method-not-allowed.yaml index 0270ce46..37c27618 100644 --- a/specification/examples/responses/errors/method-not-allowed.yaml +++ b/specification/examples/responses/errors/method-not-allowed.yaml @@ -12,4 +12,4 @@ MethodNotAllowedError: code: "METHOD_NOT_ALLOWED" display: "The method is not allowed." diagnostics: "The method is not allowed for the requested resource." - severity: "error" \ No newline at end of file + severity: "error" From 3a94ce806effadd448d40c81ae43fa57fad2f06c Mon Sep 17 00:00:00 2001 From: adamclarkson Date: Fri, 13 Feb 2026 17:13:59 +0000 Subject: [PATCH 4/6] NPA-6376: Content updates to overview, POST QR and GET QR ID --- .../validated-relationships-service-api.yaml | 90 ++++++++++--------- 1 file changed, 48 insertions(+), 42 deletions(-) diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml index 8fa6da01..fb9aa354 100644 --- a/specification/validated-relationships-service-api.yaml +++ b/specification/validated-relationships-service-api.yaml @@ -2,29 +2,26 @@ # for validated-relationships owned by NHS Digital (https://digital.nhs.uk/) openapi: "3.0.0" info: - title: "Validated Relationships Service API (Review)" + title: "Validated Relationships Service API" 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 @@ -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,28 @@ 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: + + 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 relationship | Request for relationship that already exists, with performer identifier value of `9000000049` | HTTP Status 409 and DUPLICATE_RELATIONSHIP error response | + | 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. + - Headers are not tested. `X-Request-ID` and `X-Correlation-ID` are disregarded. operationId: new-access-request parameters: @@ -211,7 +221,6 @@ paths: - $ref: "#/components/parameters/RequestID" - $ref: "#/components/parameters/CorrelationID" requestBody: - description: FHIR QuestionnaireResponse required: true content: application/fhir+json: @@ -249,7 +258,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 +319,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 @@ -390,8 +398,6 @@ paths: examples: internalServerError: $ref: "./examples/responses/errors/internal-server-error.yaml#/InternalServerError" - downstreamServiceError: - $ref: "./examples/responses/errors/downstream-service-error.yaml#/DownstreamServiceError" /RelatedPerson: get: From 5a3eb8bfacb6b473ee1de41acd87f3f0dfc6a0ce Mon Sep 17 00:00:00 2001 From: adamclarkson Date: Tue, 17 Feb 2026 17:14:15 +0000 Subject: [PATCH 5/6] NPA-6376: Further OAS content updates --- .../PATCH_Consent/multiple_updates.yaml | 22 +++ ...onships-status-active-include-details.yaml | 4 + ...iltered-relationships-status-inactive.yaml | 4 + ...-relationships-status-proposed-active.yaml | 8 + ...ultiple-relationships-include-patient.yaml | 6 + ...lationships-include-performer-patient.yaml | 6 + ...tiple-relationships-include-performer.yaml | 6 + ...nships-single-patient-include-patient.yaml | 6 + ...gle-patient-include-performer-patient.yaml | 6 + ...hips-single-patient-include-performer.yaml | 6 + ...multiple-relationships-single-patient.yaml | 6 + .../GET_Consent/multiple-relationships.yaml | 6 + ...ng-adult-relationship-include-patient.yaml | 2 + ...elationship-include-performer-patient.yaml | 2 + ...-adult-relationship-include-performer.yaml | 2 + .../single-consenting-adult-relationship.yaml | 2 + ...er-child-relationship-include-patient.yaml | 2 + ...elationship-include-performer-patient.yaml | 2 + ...-child-relationship-include-performer.yaml | 2 + ...hild-relationship-unknown-legal-basis.yaml | 2 + .../single-mother-child-relationship.yaml | 2 + .../validated-relationships-service-api.yaml | 144 ++++++++++-------- 22 files changed, 183 insertions(+), 65 deletions(-) create mode 100644 specification/examples/requests/PATCH_Consent/multiple_updates.yaml 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/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..01bfac9d 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 @@ -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: @@ -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..2a7f74c5 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml @@ -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: @@ -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..86ff8406 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 @@ -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: @@ -102,6 +104,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: @@ -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: @@ -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..06b0309f 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml @@ -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: @@ -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: @@ -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..35dc00ec 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 @@ -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: @@ -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: @@ -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..69174032 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml @@ -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: @@ -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: @@ -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..2f5af66f 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 @@ -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: @@ -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: @@ -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..c9dcbf5f 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 @@ -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: @@ -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: @@ -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..20ecf814 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 @@ -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: @@ -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: @@ -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..80af6aeb 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml @@ -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: @@ -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: @@ -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..70a267d5 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships.yaml @@ -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: @@ -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: @@ -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..1db6eea9 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 @@ -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..991b6fbb 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 @@ -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..bccb83ee 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 @@ -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..1c20b583 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml @@ -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..9459f50a 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 @@ -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..621fd2e4 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 @@ -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..29eb83ec 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 @@ -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..3306fd6b 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 @@ -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..2ede4c72 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml @@ -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 fb9aa354..f24d80dc 100644 --- a/specification/validated-relationships-service-api.yaml +++ b/specification/validated-relationships-service-api.yaml @@ -404,11 +404,17 @@ paths: 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 parameter, or both, in your request. ## Access modes @@ -418,27 +424,25 @@ 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 | + | 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: + + - Headers are not tested. For example, `X-Request-ID` and `X-Correlation-ID` are disregarded. + - `patient:identifier` is not validated. operationId: get-validated-relationships parameters: @@ -537,7 +541,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. @@ -944,7 +948,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: @@ -961,20 +964,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 @@ -1022,27 +1027,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: @@ -1109,7 +1094,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: @@ -2130,7 +2114,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: @@ -2239,7 +2223,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). @@ -2289,7 +2280,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 code system in the [FHIR specification](http://hl7.org/fhir/R4/codesystem-consent-state-codes.html)." enum: - draft - proposed @@ -2335,6 +2326,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: @@ -2359,7 +2364,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 @@ -2540,15 +2545,24 @@ 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" +# PatientMeta: +# type: object +# description: Metadata about a resource +# properties: +# security: +# type: array +# description: Security Labels applied a resource +# items: +# $ref: "#/components/schemas/Coding" +# +# ConsentMeta: +# type: object +# description: Metadata about a resource +# properties: +# lastUpdated: +# type: string +# format: date-time +# description: When the resource last changed CodeableConcept: type: object From 9a47c1bd7893ed320b75761ff8ee88c777272007 Mon Sep 17 00:00:00 2001 From: adamclarkson Date: Tue, 17 Feb 2026 17:46:07 +0000 Subject: [PATCH 6/6] NPA-6376: Updated placeholder to real published ISN url --- ...ionships-status-active-include-details.yaml | 4 ++-- ...filtered-relationships-status-inactive.yaml | 8 ++++---- ...d-relationships-status-proposed-active.yaml | 18 +++++++++--------- ...multiple-relationships-include-patient.yaml | 12 ++++++------ ...elationships-include-performer-patient.yaml | 12 ++++++------ ...ltiple-relationships-include-performer.yaml | 12 ++++++------ ...onships-single-patient-include-patient.yaml | 12 ++++++------ ...ngle-patient-include-performer-patient.yaml | 12 ++++++------ ...ships-single-patient-include-performer.yaml | 12 ++++++------ .../multiple-relationships-single-patient.yaml | 12 ++++++------ .../GET_Consent/multiple-relationships.yaml | 12 ++++++------ ...ing-adult-relationship-include-patient.yaml | 4 ++-- ...relationship-include-performer-patient.yaml | 4 ++-- ...g-adult-relationship-include-performer.yaml | 4 ++-- .../single-consenting-adult-relationship.yaml | 4 ++-- ...her-child-relationship-include-patient.yaml | 4 ++-- ...relationship-include-performer-patient.yaml | 4 ++-- ...r-child-relationship-include-performer.yaml | 4 ++-- ...child-relationship-unknown-legal-basis.yaml | 4 ++-- .../single-mother-child-relationship.yaml | 4 ++-- 20 files changed, 81 insertions(+), 81 deletions(-) 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 01bfac9d..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: @@ -195,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: 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 2a7f74c5..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: @@ -86,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: 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 86ff8406..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: @@ -92,14 +92,14 @@ 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' @@ -153,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: @@ -214,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: 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 06b0309f..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: @@ -152,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: @@ -241,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: 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 35dc00ec..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: @@ -195,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: @@ -303,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: 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 69174032..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: @@ -137,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: @@ -218,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: 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 2f5af66f..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: @@ -120,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: @@ -180,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: 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 c9dcbf5f..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: @@ -160,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: @@ -238,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: 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 20ecf814..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: @@ -131,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: @@ -209,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: 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 80af6aeb..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: @@ -91,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: @@ -151,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: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships.yaml b/specification/examples/responses/GET_Consent/multiple-relationships.yaml index 70a267d5..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: @@ -91,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: @@ -151,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: 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 1db6eea9..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: 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 991b6fbb..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: 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 bccb83ee..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: 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 1c20b583..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: 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 9459f50a..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: 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 621fd2e4..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: 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 29eb83ec..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: 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 3306fd6b..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: 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 2ede4c72..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: