Skip to content

Commit ed8e8a5

Browse files
authored
Updated /personalisation based on CCM-7937, CCM-7780 and CCM-8133. I also:
- added sentence about no spaces in placeholder text following Mike Houston's comment saying that we need to be more restrictive as we're generalising across multiple suppliers and template systems - added anchor links at top of page to help with navigation between the 2 types of personalisation and avoid the custom fields section being missed
1 parent ac36dc2 commit ed8e8a5

File tree

2 files changed

+63
-10
lines changed

2 files changed

+63
-10
lines changed
Binary file not shown.

docs/pages/using-nhs-notify/personalisation.md

Lines changed: 63 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,19 @@ permalink: /using-nhs-notify/personalisation
1010
section: Writing a message
1111
---
1212

13-
You can send personalised messages using a single template.
13+
You can send personalised messages by adding personalisation fields to a single template.
1414

15-
To personalise a message, use double brackets to add a placeholder to your content. For example:
15+
Use double brackets to add a placeholder to your content. Do not include spaces in your placeholder text. For example:
1616

1717
{% include components/inset-text.html
18-
text='Hello ((firstName)), your NHS Number is ((nhsNumber))'
18+
text='Hello ((fullName)), your NHS Number is ((nhsNumber))'
1919
%}
2020

21+
You can use:
22+
23+
- [Personal Demographics Service (PDS) personalisation fields](#personal-demographics-service-pds-personalisation-fields)<!-- markdownlint-disable-line -->
24+
- [custom personalisation fields](#custom-personalisation-fields)
25+
2126
## Personal Demographics Service (PDS) personalisation fields
2227

2328
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.
@@ -26,20 +31,15 @@ You can use the following PDS personalisation fields in your templates:
2631

2732
- fullName
2833
- firstName
29-
- middleNames
3034
- lastName
31-
- namePrefix
32-
- nameSuffix
3335
- nhsNumber
3436
- date
3537

3638
Any placeholders in your content need to match the PDS personalisation fields.
3739

38-
## Providing your own personalisation data
40+
## Custom personalisation fields
3941

40-
You can provide your own personalisation data.
41-
42-
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.
42+
You can add custom personalisation fields that use your own personalisation data.
4343

4444
### If you're using NHS Notify API
4545

@@ -64,3 +64,56 @@ For example, if you wanted to include 'practice' as a personalisation field, the
6464
{% include components/inset-text.html
6565
text='nhsNumber,requestItemRefId,personalisation_practice'
6666
%}
67+
68+
### Providing example data
69+
70+
The data used in your personalisation fields can affect the formatting and length of your messages. This could make some messages cost more than expected.
71+
72+
You'll need to provide example data if you're using custom personalisation fields. This is so that we can show you what your templates will look like with different lengths of data in your personalisation fields.
73+
74+
Download and complete our [example personalisation data spreadsheet]({% link assets/personalisationexampledata/personalisation-example-data-nhs-notify.xlsx %}).
75+
76+
The placeholders in your content must match the fields in the 'personalisation field' column.
77+
78+
You'll need to provide short, medium and long lengths of example data for each of your personalisation fields.
79+
80+
For example, if you had ((hospital_address_line)) as a personalisation field, you might choose the following example data:
81+
82+
{% include components/inset-text.html
83+
text='
84+
85+
- Hospital A - short length
86+
- Hospital ABCDE - medium length
87+
- Hospital ABCDEFGHIJKLMN - long length'
88+
%}
89+
90+
It's up to you to decide how many characters to use for the different lengths.
91+
92+
If your data will be a fixed length for a particular personalisation field, use 3 different examples of the same length.
93+
94+
Your example data does not need to be real data.
95+
96+
### Fields to avoid for custom personalisation
97+
98+
If you want to use custom personalisation, do not use the following personalisation fields:
99+
100+
- emailAddress
101+
- phoneNumber
102+
- addressLine1
103+
- addressLine2
104+
- addressLine3
105+
- addressLine4
106+
- addressLine5
107+
- addressLine6
108+
- addressLine7
109+
- [PDS personalisation fields](#personal-demographics-service-pds-personalisation-fields)
110+
111+
Custom personalisation will not work if you try to add it using these fields. This includes variations such as spaces and upper or lower cases.
112+
113+
You can include extra words in your custom personalisation placeholders to make them different from the fields to avoid.
114+
115+
For example, if you wanted to include GP practice phone number as a custom personalisation field, your placeholder could be:
116+
117+
{% include components/inset-text.html
118+
text='((GP_phoneNumber))'
119+
%}

0 commit comments

Comments
 (0)