+ {{ include.text | markdownify }} +
+ {{include.phase_tag}} + {{include.phase_text}} +
{{ section.name }}
Hello ((firstName)), your NHS Number is ((nhsNumber))' + text='Hello ((firstName)), your NHS Number is ((nhsNumber))' %} -### Personal Demographics Service (PDS) personalisation fields +## Personal Demographics Service (PDS) personalisation fields -NHS Notify uses the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service) to find and populate certain personalisation fields. You only need to [provide us with recipients' NHS numbers]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}). +NHS Notify uses the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service) to find and populate certain personalisation fields for each recipient. This happens automatically when you [tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}) using recipients' NHS numbers. -The personalisation fields available in PDS are: +You can use the following PDS personalisation fields in your templates: - fullName - firstName @@ -30,20 +30,10 @@ The personalisation fields available in PDS are: - lastName - namePrefix - nameSuffix -- address_line_1 -- address_line_2 -- address_line_3 -- address_line_4 -- address_line_5 -- address_line_6 -- address_line_7 - nhsNumber - date -- clientRef -- recipientContactValue -- template -The placeholders in your content need to match the PDS personalisation fields. +Any placeholders in your content need to match the PDS personalisation fields. ## Providing your own personalisation data @@ -51,33 +41,26 @@ You can provide your own personalisation data. Do not send us personalisation data that's already available in PDS. We'll use the PDS data over your own data in this case. -### If you're using the API +### If you're using NHS Notify API Include a personalisation block in your API request. For example, if you wanted to include 'practice' as a personalisation field, the personalisation block would be: -{% include components/inset-text.html - text='{ - - "practice": "PRACTICE_NAME", - -}' +{% include components/code-snippet.html +text='"practice": "PRACTICE_NAME"' %} Read the [API documentation](https://digital.nhs.uk/developer/api-catalogue/nhs-notify#post-/v1/message-batches) to find out where to put this in your request. -### If you're using the Message Exchange for Social Care and Health (MESH) +### If you're using NHS Notify MESH Include the personalisation fields as columns in your CSV file. -The column names should start with 'personalisation_', followed by the same wording as the placeholders in your template. +The column names should start with 'personalisation\_', followed by the same wording as the placeholders in your template. For example, if you wanted to include 'practice' as a personalisation field, the column name would be: {% include components/inset-text.html - text='nhsNumber,requestItemRefId,dateOfBirth,personalisation_practice' + text='nhsNumber,requestItemRefId,personalisation_practice' %} - -*[PDS]: Personal Demographics Service -*[MESH]: Message Exchange for Social Care and Health diff --git a/docs/pages/using-nhs-notify/tell-us-who-you-want-to-message.md b/docs/pages/using-nhs-notify/tell-us-who-you-want-to-message.md index 5021ca0..a6fee24 100644 --- a/docs/pages/using-nhs-notify/tell-us-who-you-want-to-message.md +++ b/docs/pages/using-nhs-notify/tell-us-who-you-want-to-message.md @@ -31,3 +31,8 @@ The onboarding team will give you an example CSV file on request. Use the format shown in the API documentation (opens in a new tab). + +## Providing your own recipient contact details + +If you need to use contact details that are not from PDS, you must make a formal request to NHS Notify. +Overriding contact details is only granted to specific use cases that provide compelling data to our onboarding team. NHS Notify will consult with relevant NHS England legal and clinical teams for approval.