From fcdaba3fa816389fe0b16ea020ce53d8ebe1b56d Mon Sep 17 00:00:00 2001 From: "tom.droza2" Date: Mon, 14 Apr 2025 17:06:21 +0100 Subject: [PATCH 1/3] CCM-8392: [API Docs] Add name override fields to send single and batch endpoints --- .../schemas/components/Recipient.yaml | 28 +++++++++++++++++-- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/specification/schemas/components/Recipient.yaml b/specification/schemas/components/Recipient.yaml index e7f6da8ae..203c9be12 100644 --- a/specification/schemas/components/Recipient.yaml +++ b/specification/schemas/components/Recipient.yaml @@ -8,7 +8,7 @@ properties: minLength: 10 maxLength: 10 example: "9990548609" - description: The [NHS number](https://digital.nhs.uk/services/nhs-number) of the recipient. Only [valid NHS Numbers](https://www.datadictionary.nhs.uk/attributes/nhs_number.html) will be accepted. This will be used to lookup the recipients details with the [Personal Demographics Service](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir). + description: The [NHS number](https://digital.nhs.uk/services/nhs-number) of the recipient. Only [valid NHS Numbers](https://www.datadictionary.nhs.uk/attributes/nhs_number.html) will be accepted. This will be used to lookup the recipients details with the [Personal Demographics Service](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir). Normally a required field, unless prior agreement with the Onboarding team is in place to enable the Anonymous Patients feature. contactDetails: type: object description: "Overriding contact details is a sensitive action and requires explicit approval from the onboarding team." @@ -47,5 +47,27 @@ properties: type: string description: Postcode of overriding address. A required field when address is specified. Must be a valid UK postcode format. example: "LS1 4AP" -required: - - nhsNumber + name: + type: object + description: Overriding name fields for the recipient. + properties: + prefix: + type: string + description: Prefix of overriding name. + example: Dr. + firstName: + type: string + description: First name of overriding name. + example: John + middleNames: + type: string + description: Middle names of overriding name. + example: Andrew Robert + lastName: + type: string + description: Last name of overriding name. A required field when name is specified. + example: Smith + suffix: + type: string + description: Suffix of overriding name. + example: Jr. From dd15de8d9fba81302829fda106e8948f61c47ebf Mon Sep 17 00:00:00 2001 From: "tom.droza2" Date: Tue, 15 Apr 2025 11:14:37 +0100 Subject: [PATCH 2/3] CCM-8392: Fix broken link --- specification/documentation/APIDescription.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/documentation/APIDescription.md b/specification/documentation/APIDescription.md index 52b99dd0a..3283e868a 100644 --- a/specification/documentation/APIDescription.md +++ b/specification/documentation/APIDescription.md @@ -9,7 +9,7 @@ Use this API to send messages to citizens via NHS App, email, text message or le * enrichment of recipient details * support for accessible formats and multiple languages -Learn more about [NHS Notify's features](https://digital.nhs.uk/services/nhs-notify/features). +Learn more about [NHS Notify's features](https://notify.nhs.uk/features/). ## Who can use this API From cf8ad29281ab540ba35eaed1874943666ed19e5c Mon Sep 17 00:00:00 2001 From: "tom.droza2" Date: Wed, 16 Apr 2025 09:25:20 +0100 Subject: [PATCH 3/3] Address review comments --- specification/schemas/components/Recipient.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/schemas/components/Recipient.yaml b/specification/schemas/components/Recipient.yaml index 203c9be12..3e1c29b55 100644 --- a/specification/schemas/components/Recipient.yaml +++ b/specification/schemas/components/Recipient.yaml @@ -8,7 +8,7 @@ properties: minLength: 10 maxLength: 10 example: "9990548609" - description: The [NHS number](https://digital.nhs.uk/services/nhs-number) of the recipient. Only [valid NHS Numbers](https://www.datadictionary.nhs.uk/attributes/nhs_number.html) will be accepted. This will be used to lookup the recipients details with the [Personal Demographics Service](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir). Normally a required field, unless prior agreement with the Onboarding team is in place to enable the Anonymous Patients feature. + description: The [NHS number](https://digital.nhs.uk/services/nhs-number) of the recipient. Only [valid NHS Numbers](https://www.datadictionary.nhs.uk/attributes/nhs_number.html) will be accepted. This will be used to lookup the recipients details with the [Personal Demographics Service](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir). Normally a required field, unless prior agreement with the Onboarding team is in place. contactDetails: type: object description: "Overriding contact details is a sensitive action and requires explicit approval from the onboarding team."