Skip to content

Commit

Permalink
Update personalisation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexcolbeck1 authored Dec 18, 2024
1 parent e3b58e1 commit ed6e500
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions docs/pages/using-nhs-notify/personalisation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,10 @@ To personalise a message, use double brackets to add a placeholder to your conte
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 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.
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.

You can use the following PDS personalisation fields in your templates:
You can use the following PDS personalisation fields in your templates:

- fullName
Expand All @@ -36,7 +33,6 @@ You can use the following PDS personalisation fields in your templates:
- nhsNumber
- date

Any 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
Expand All @@ -45,7 +41,6 @@ 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 NHS Notify API
### If you're using NHS Notify API

Include a personalisation block in your API request.
Expand All @@ -58,17 +53,14 @@ 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 NHS Notify 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,personalisation_practice'
text='nhsNumber,requestItemRefId,personalisation_practice'
%}

0 comments on commit ed6e500

Please sign in to comment.