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
Removed address_line_x, clientRef, recipientContactValue and template from the bulleted list of personalisation fields from PDS as these are for internal use only.
Restructured the first paragraph under ### Personal Demographics Service (PDS) personalisation fields. This was based off a conversation with Jake and it aims to clarify the link between PDS, NHS numbers and personalisation fields.
Copy file name to clipboardExpand all lines: docs/pages/using-nhs-notify/personalisation.md
+7-17Lines changed: 7 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,30 +20,20 @@ To personalise a message, use double brackets to add a placeholder to your conte
20
20
21
21
### Personal Demographics Service (PDS) personalisation fields
22
22
23
-
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 %}).
23
+
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.
24
24
25
-
The personalisation fields available in PDS are:
25
+
You can use the following PDS personalisation fields in your templates:
26
26
27
27
- fullName
28
28
- firstName
29
29
- middleNames
30
30
- lastName
31
31
- namePrefix
32
32
- nameSuffix
33
-
- address_line_1
34
-
- address_line_2
35
-
- address_line_3
36
-
- address_line_4
37
-
- address_line_5
38
-
- address_line_6
39
-
- address_line_7
40
33
- nhsNumber
41
34
- date
42
-
- clientRef
43
-
- recipientContactValue
44
-
- template
45
35
46
-
The placeholders in your content need to match the PDS personalisation fields.
36
+
Any placeholders in your content need to match the PDS personalisation fields.
47
37
48
38
## Providing your own personalisation data
49
39
@@ -58,7 +48,7 @@ Include a personalisation block in your API request.
58
48
For example, if you wanted to include 'practice' as a personalisation field, the personalisation block would be:
59
49
60
50
{% include components/inset-text.html
61
-
text='{
51
+
text='{
62
52
63
53
"practice": "PRACTICE_NAME",
64
54
@@ -71,13 +61,13 @@ Read the [API documentation](https://digital.nhs.uk/developer/api-catalogue/nhs-
71
61
72
62
Include the personalisation fields as columns in your CSV file.
73
63
74
-
The column names should start with 'personalisation_', followed by the same wording as the placeholders in your template.
64
+
The column names should start with 'personalisation\_', followed by the same wording as the placeholders in your template.
75
65
76
66
For example, if you wanted to include 'practice' as a personalisation field, the column name would be:
0 commit comments