Skip to content

Commit dba7c44

Browse files
authored
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.
1 parent 4a1ba6f commit dba7c44

File tree

1 file changed

+7
-17
lines changed

1 file changed

+7
-17
lines changed

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

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,20 @@ To personalise a message, use double brackets to add a placeholder to your conte
2020

2121
### Personal Demographics Service (PDS) personalisation fields
2222

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.
2424

25-
The personalisation fields available in PDS are:
25+
You can use the following PDS personalisation fields in your templates:
2626

2727
- fullName
2828
- firstName
2929
- middleNames
3030
- lastName
3131
- namePrefix
3232
- 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
4033
- nhsNumber
4134
- date
42-
- clientRef
43-
- recipientContactValue
44-
- template
4535

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.
4737

4838
## Providing your own personalisation data
4939

@@ -58,7 +48,7 @@ Include a personalisation block in your API request.
5848
For example, if you wanted to include 'practice' as a personalisation field, the personalisation block would be:
5949

6050
{% include components/inset-text.html
61-
text='{
51+
text='{
6252

6353
"practice": "PRACTICE_NAME",
6454

@@ -71,13 +61,13 @@ Read the [API documentation](https://digital.nhs.uk/developer/api-catalogue/nhs-
7161

7262
Include the personalisation fields as columns in your CSV file.
7363

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.
7565

7666
For example, if you wanted to include 'practice' as a personalisation field, the column name would be:
7767

7868
{% include components/inset-text.html
7969
text='nhsNumber,requestItemRefId,dateOfBirth,personalisation_practice'
8070
%}
8171

82-
*[PDS]: Personal Demographics Service
83-
*[MESH]: Message Exchange for Social Care and Health
72+
_[PDS]: Personal Demographics Service
73+
_[MESH]: Message Exchange for Social Care and Health

0 commit comments

Comments
 (0)