You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/pages/using-nhs-notify/personalisation.md
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ section: Writing a message
12
12
13
13
You can send personalised messages by adding personalisation fields to a single template.
14
14
15
-
Use double brackets to add a placeholder to your content. Do not include spaces in your placeholder text. For example:
15
+
Use double brackets to add a personalisation field to your content. Do not include spaces in your personalisation fields. For example:
16
16
17
17
{% include components/inset-text.html
18
18
text='Hello ((fullName)), your NHS Number is ((nhsNumber))'
@@ -27,15 +27,17 @@ You can use:
27
27
28
28
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.
29
29
30
-
You can use the following PDS personalisation fields in your templates:
30
+
To use PDS personalisation fields in your templates, choose from the following list:
31
31
32
32
- fullName
33
33
- firstName
34
34
- lastName
35
35
- nhsNumber
36
36
- date
37
37
38
-
Any placeholders in your content need to match the PDS personalisation fields.
38
+
{% include components/inset-text.html
39
+
text='Make sure your personalisation fields exactly match the PDS personalisation fields. This includes using the correct order of upper and lower case letters.'
40
+
%}
39
41
40
42
## Custom personalisation fields
41
43
@@ -57,7 +59,7 @@ Read the [API documentation](https://digital.nhs.uk/developer/api-catalogue/nhs-
57
59
58
60
Include the personalisation fields as columns in your CSV file.
59
61
60
-
The column names should start with 'personalisation\_', followed by the same wording as the placeholders in your template.
62
+
The column names should start with 'personalisation\_', followed by the same wording as the personalisation fields in your template.
61
63
62
64
For example, if you wanted to include 'practice' as a personalisation field, the column name would be:
63
65
@@ -73,7 +75,7 @@ You'll need to provide example data if you're using custom personalisation field
73
75
74
76
Download and complete our [example personalisation data spreadsheet]({% link assets/personalisationexampledata/personalisation-example-data-nhs-notify.xlsx %}).
75
77
76
-
The placeholders in your content must match the fields in the 'personalisation field' column.
78
+
The personalisation fields in your content must match the fields in the 'personalisation field' column.
77
79
78
80
You'll need to provide short, medium and long lengths of example data for each of your personalisation fields.
79
81
@@ -95,7 +97,7 @@ Your example data does not need to be real data.
95
97
96
98
### Fields to avoid for custom personalisation
97
99
98
-
If you want to use custom personalisation, do not use the following placeholders:
100
+
If you want to use custom personalisation, do not use the following personalisation fields:
99
101
100
102
- emailAddress
101
103
- phoneNumber
@@ -108,11 +110,11 @@ If you want to use custom personalisation, do not use the following placeholders
Custom personalisation will not work if you try to add it using these placeholders. This includes variations such as spaces and upper or lower cases.
113
+
Custom personalisation will not work if you try to add it using these personalisation fields. This includes variations such as spaces and upper or lower cases.
112
114
113
-
You can include extra words in your custom personalisation placeholders to make them different from the fields to avoid.
115
+
You can include extra words in your custom personalisation fields to make them different from the fields to avoid.
114
116
115
-
For example, if you wanted to include GP practice phone number as a custom personalisation field, your placeholder could be:
117
+
For example, if you wanted to include GP practice phone number as a custom personalisation field, your personalisation field could be:
0 commit comments