Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
alexcolbeck1 committed Dec 18, 2024
2 parents bd1c4aa + 32da5fa commit e3b58e1
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
14 changes: 6 additions & 8 deletions docs/_layouts/no-nav-page.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,12 @@
<div class="nhsuk-width-container">
<main class="nhsuk-main-wrapper" id="maincontent" role="main">
<div class="nhsuk-grid-row">
<div class="nhsuk-grid-column-full">
<div class="nhsnotify-pane__main-content nhsuk-grid-column-three-quarters">
{% if page.section != undefined %}
<heading class="nhsuk-heading-s" style="margin-bottom: 0; color: #4c6272">{{ page.section }}</heading>
{% endif %}
<h1>{{ page.title }}</h1>
{{ content }}
</div>
<div class="nhsnotify-pane__main-content nhsuk-grid-column-three-quarters">
{% if page.section != undefined %}
<heading class="nhsuk-heading-s" style="margin-bottom: 0; color: #4c6272">{{ page.section }}</heading>
{% endif %}
<h1>{{ page.title }}</h1>
{{ content }}
</div>
</div>
</main>
Expand Down
16 changes: 10 additions & 6 deletions docs/pages/using-nhs-notify/personalisation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,16 @@ You can send personalised messages using a single template.
To personalise a message, use double brackets to add a placeholder to your content. For example:

{% include components/inset-text.html
text='<code>Hello ((firstName)), your NHS Number is ((nhsNumber))'
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 @@ -33,6 +36,7 @@ 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 @@ -41,30 +45,30 @@ 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.

For example, if you wanted to include 'practice' as a personalisation field, the personalisation block would be:

{% include components/inset-text.html
text='{

"practice": "PRACTICE_NAME",

}'
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 e3b58e1

Please sign in to comment.