Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion specification/documentation/APIDescription.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
28 changes: 25 additions & 3 deletions specification/schemas/components/Recipient.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
contactDetails:
type: object
description: "Overriding contact details is a sensitive action and requires explicit approval from the onboarding team."
Expand Down Expand Up @@ -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.