07700 900362
+karen.francis@example.com
+| Integration method | +Included | +
|---|---|
| NHS Notify API (recommended) | ++ + + + | +
| NHS Notify MESH | ++ + + + | +
| Message channel | +Included | +
|---|---|
| NHS App messages
+
+ Includes push notifications that are sent between 6am and 10pm to support sociable hours
+
+ |
+ + + + + | +
| Emails | ++ + + + | +
| Text messages (SMS) | ++ + + + | +
| Letters | ++ + + + | +
| Additional letter format | +Included | +
|---|---|
| Braille | ++ + + + | +
| Large print | ++ + + + | +
| Audio CD | ++ + + + | +
| Letters in other languages | ++ + + + | +
Learn more about accessible formats and letters in other + languages.
+ + +| Feature | +Included | +
|---|---|
| Templates
+
+ Send the same thing to lots of people without writing a new message each time
+
+ |
+ + + + + | +
| Free-text input
+
+ Use free-text inputs in your own software to write messages
+
+ |
+ + + + + | +
| Personalisation
+
+ Add details like your recipients name, appointment times or reference numbers to your messages
+
+ |
+ + + + + | +
| Sender name
+
+ Tell recipients who your messages are from
+
+ Find out how to tell recipients who your messages are from
+ |
+ + + + + | +
| Feature | +Included | +
|---|---|
| Rate limiting
+
+ Set how many messages are sent per second to control how often recipients access your service
+
+ |
+ Up to 5TPS | +
| Routing plans
+
+ Use routing plans to decide how and what order messages will be sent to your recipients
+
+ You can send campaign messages in the following ways: +
|
+ + + + + | +
| Fallback rules
+
+ The following fallback rules will apply to message channels used in your routing plans:
+
+ + All digital message channels will immediately fallback to the next channel if its rejected or an 'unnotified' + status is received. + +NHS App messages will fallback to the next channel when: +
Emails and text messages will fallback to the next channel if they are XYZ after 72 hours +Letters do not have any fallback rules as they’re always sent last in routing plans for transactional + messages. + |
+ + + + + | +
| Parallel send
+
+ Send two or more messages at the same time to a recipient
+
+ |
+ + + + + | +
| Recipients you cannot message
+
+ NHS Notify prevents you from sending messages to specific recipients to make your messaging more effective
+
+ You cannot send transactional messages to recipients with: +
|
+ + + + + | +
| Feature | +Included | +
|---|---|
| Power BI reporting
+
+ See how your messages are performing over time with our Power BI dashboards
+
+ |
+ + + + + | +
| Real time message status callbacks
+
+ Receive real time updates every time the status of a message changes
+
+ |
+ API only | +
| Quarterly billing
+
+ Pay for the messages you send every quarter with cross charging
+
+ Find out how to pay
+ |
+ + + + + | +
| Integration method | +Included | +
|---|---|
| NHS Notify API (recommended) | ++ + + + | +
| NHS Notify MESH | ++ + + + | +
| Message channel | +Included | +
|---|---|
| NHS App messages
+
+ Includes push notifications that are sent between 6am and 10pm to support sociable hours
+
+ |
+ + + + + | +
| Emails | ++ + + + | +
| Text messages (SMS) | ++ + + + | +
| Letters | ++ + + + | +
| Additional letter format | +Included | +
|---|---|
| Braille | ++ + + + | +
| Large print | ++ + + + | +
| Audio CD | ++ + + + | +
| Letters in other languages | ++ + + + | +
Learn more about accessible formats and letters in other + languages.
+ + +| Feature | +Included | +
|---|---|
| Templates
+
+ Send the same thing to lots of people without writing a new message each time
+
+ |
+ + + + + | +
| Free-text input
+
+ Use free-text inputs in your own software to write messages
+
+ |
+ + + + + | +
| Personalisation
+
+ Add details like your recipients name, appointment times or reference numbers to your messages
+
+ |
+ + + + + | +
| Sender name
+
+ Tell recipients who your messages are from
+
+ Find out how to tell recipients who your messages are from
+ |
+ + + + + | +
| Feature | +Included | +
|---|---|
| Rate limiting
+
+ Set how many messages are sent per second to control how often recipients access your service
+
+ |
+ Up to 5TPS | +
| Routing plans
+
+ Use routing plans to decide how and what order messages will be sent to your recipients.
+
+ |
+ + + + + | +
| Fallback rules
+
+ These are rules that trigger when a fallback is used for each message channel in a routing plan
+
+ + If you send direct messages with the NHS App you must create your own fallback functionality and adhere to the + following: + +1. Time sensitive NHS App messages should fallback when:+
2. Bulk NHS App messages should fallback when:+
3. Acute secondary care appointment NHS App messages should fallback when:+
|
+ + + + + | +
| Parallel send
+
+ Send two or more messages at the same time to a recipient
+
+ |
+ + + + + | +
| Recipients you cannot message
+
+ NHS Notify prevents you from sending messages to specific recipients to make your messaging more effective
+
+ You cannot send transactional messages to recipients with: +
|
+ + + + + | +
| Feature | +Included | +
|---|---|
| Power BI reporting
+
+ See how your messages are performing over time with our Power BI dashboards
+
+ |
+ + + + + | +
| Real time message status callbacks
+
+ Receive real time updates every time the status of a message changes
+
+ |
+ API only | +
| Quarterly billing
+
+ Pay for the messages you send every quarter with cross charging
+
+ Find out how to pay
+ |
+ + + + + | +
| Integration method | +Included | +
|---|---|
| NHS Notify API (recommended) | ++ + + + | +
| NHS Notify MESH | ++ + + + | +
| Message channel | +Included | +
|---|---|
| NHS App messages
+
+ Includes push notifications that are sent between 6am and 10pm to support sociable hours
+
+ |
+ + + + + | +
| Emails | ++ + + + | +
| Text messages (SMS) | ++ + + + | +
| Letters
+
+ Uses NHS Notify's standard letter specification
+
+ |
+ + + + + | +
| Additional letter format | +Included | +
|---|---|
| Braille | ++ + + + | +
| Large print | ++ + + + | +
| Audio CD | ++ + + + | +
| Letters in other languages | ++ + + + | +
Learn more about accessible formats and letters in other + languages.
+ + +| Feature | +Included | +
|---|---|
| Templates
+
+ Send the same thing to lots of people without writing a new message each time
+
+ |
+ + + + + | +
| Free-text input
+
+ Use free-text inputs in your own software to write messages
+
+ |
+ + + + + | +
| Personalisation
+
+ Add details like your recipients name, appointment times or reference numbers to your messages
+
+ |
+ + + + + | +
| Sender name
+
+ Tell recipients who your messages are from
+
+ Find out how to tell recipients who your messages are from
+ |
+ + + + + | +
| Feature | +Included for transactional messages | +
|---|---|
| Personalisation
+
+ Add details like your recipients name, appointment times or reference numbers to your messages
+
+ |
+ + + + + | +
| Rate limiting
+
+ Set how many messages are sent per second to control how often recipients access your service
+
+ |
+ Up to 5TPS | +
| Routing plans
+
+ Use routing plans to decide how messages will be sent to your recipients and in what orders.
+
+ You can send transactional messages in the following ways: +
|
+ + + + + | +
| Fallback rules
+
+ The following fallback rules will apply to message channels used in your routing plans:
+
+ + All digital message channels will immediately fallback to the next channel if its rejected or an 'unnotified' + status is received. + +The following fallback rules will apply to message channels used in your routing plans: +NHS App messages will fallback to the next channel when: +
Emails and text messages will fallback to the next channel if they are XYZ after 72 hours +Letters do not have any fallback rules as they’re always sent last in routing plans for transactional + messages. + |
+ + + + + | +
| Parallel send
+
+ Send two or more messages at the same time to a recipient
+
+ |
+ + + + + | +
| Recipients you cannot message
+
+ NHS Notify prevents you from sending messages to specific recipients to make your messaging more effective
+
+ You cannot send transactional messages to recipients with: +
|
+ + + + + | +
| Feature | +Included | +
|---|---|
| Power BI reporting
+
+ See how your messages are performing over time with our Power BI dashboards
+
+ |
+ + + + + | +
| Real time message status callbacks
+
+ Receive real time updates every time the status of a message changes
+
+ |
+ API only | +
| Quarterly billing
+
+ Pay for the messages you send every quarter with cross charging
+
+ Find out how to pay
+ |
+ + + + + | +
{:/} |
+
+'
+%}
+
+{% include components/expander.html
+heading='What message channels and other formats you can use'
+text='
+
+| Message channel | Included |
+| ------------------- | --------------------------------------------------------- |
+| NHS App messages | {::nomarkdown}{:/} |
+| Emails | {::nomarkdown}{:/} |
+| Text messages (SMS) | {::nomarkdown}{:/} |
+| Letters | {::nomarkdown}{:/} |
+
+'
+%}
+
+{% include components/expander.html
+heading='Other message formats you can use'
+text='
+
+| Feature | Is it included? |
+| -------------------------- | --------------------------------------------------------- |
+| Braille | {::nomarkdown}{:/} |
+| Large print | {::nomarkdown}{:/} |
+| Audio CD | {::nomarkdown}{:/} |
+| Letters in other languages | {::nomarkdown}{:/} |
+
+'
+%}
+
+{% include components/expander.html
+heading='What you can do when writing your messages'
+text='
+
+| Feature | Is it included? |
+| ---------------- | ---------------------------------------------------------- |
+| Templates | {::nomarkdown}{:/} |
+| Free-text inputs | {::nomarkdown}
{:/} |
+| Personalisation | {::nomarkdown}{:/} |
+
+'
+%}
+
+{% include components/expander.html
+heading='How you can send your messages'
+text='
+
+| Feature | Is it included? |
+| -------------- | ---------------------------------------------------------- |
+| Rate limiting | Up to 5 TPS |
+| Routing plans | {::nomarkdown}{:/} |
+| Fallback rules | {::nomarkdown}{:/} |
+| Parallel send | {::nomarkdown}{:/} |
+
+'
+%}
+
+{% include components/expander.html
+heading="Recipients you cannot message with NHS Notify"
+text="NHS Notify prevents you from sending messages to specific recipients to make your messaging more effective.
+
+You cannot send transactional messages to recipients with:
+
+- flagged records
+- exit codes (also known as reason for removal codes)
+- invalid postcodes
+- invalid email addresses
+- an informal or formal death status
+
+[Find out more about recipients you cannot message](https://notify.nhs.uk/using-nhs-notify/recipients-you-cannot-message)."
+%}
diff --git a/docs/pages/using-nhs-notify/(test)transactional-messaging.md b/docs/pages/using-nhs-notify/(test)transactional-messaging.md
new file mode 100644
index 0000000..9f76b90
--- /dev/null
+++ b/docs/pages/using-nhs-notify/(test)transactional-messaging.md
@@ -0,0 +1,46 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: page
+title: Transactional messaging
+parent: Using NHS Notify
+nav_order: 2
+permalink: /using-nhs-notify/transactional-messaging
+section: By use case
+published: false
+---
+
+Use NHS Notify to send messages to your recipients that facilitate transactions between your organisation or service and your patients.
+
+## Examples of transactional messages
+
+Use NHS Notify for transactional messaging to send:
+
+- appointment reminders
+- booking confirmations
+- test results
+
+## What you can use
+
+Find out what features you can and cannot use when you send transactional messages with NHS Notify.
+
+{% include custom-components/transactional-feature-list.html %}
+
+### Recipients you cannot message
+
+NHS Notify prevents you from sending messages to specific recipients to make your messaging more effective.
+
+You cannot send transactional messages to recipients with:
+
+- flagged records
+- exit codes (also known as reason for removal codes)
+- invalid postcodes
+- invalid email addresses
+- an informal or formal death status
+
+[Find out more about recipients you cannot message]({% link pages/using-nhs-notify/recipients-you-cannot-message.md %}).
+
+## See what's next for NHS Notify
+
+If you're thinking of using NHS Notify for transactional messages but cannot find the features you need, [read our roadmap to find out what we're working on next]({% link pages/features/roadmap.md %}).
diff --git a/docs/pages/using-nhs-notify/campaigns.md b/docs/pages/using-nhs-notify/campaigns.md
new file mode 100644
index 0000000..acadbca
--- /dev/null
+++ b/docs/pages/using-nhs-notify/campaigns.md
@@ -0,0 +1,39 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: page
+title: Campaigns
+parent: Using NHS Notify
+nav_order: 1
+permalink: /using-nhs-notify/campaigns
+section: By use case
+---
+
+Use NHS Notify to set up national or local campaigns to send messages in bulk to patients and the public.
+
+## Examples of campaign messaging
+
+Create messaging campaigns with NHS Notify to send:
+
+- vaccination invitations
+- screening appointment invitations
+- health or adult social care research invitations
+
+## What features you can use
+
+Find out what features you can and cannot use when you send messages as part of a campaign with NHS Notify.
+
+{% include custom-components/campaign-feature-list.html %}
+
+## Using the NHS App for patient journeys
+
+When you send NHS App messages as part of a campaign with NHS Notify, you must adhere to the following in any onward user journeys:
+
+- any links should only open a patients web browser
+- links should only take patients to web content such as your website, NHS.UK or other relevant web pages
+- do not include links that open other mobile applications
+
+## See what's next for NHS Notify
+
+If you're thinking of using NHS Notify for campaign messaging but cannot find the features you need, [read our roadmap to find out what we're working on next]({% link pages/features/roadmap.md %}).
diff --git a/docs/pages/using-nhs-notify/direct-messaging.md b/docs/pages/using-nhs-notify/direct-messaging.md
new file mode 100644
index 0000000..3537fb7
--- /dev/null
+++ b/docs/pages/using-nhs-notify/direct-messaging.md
@@ -0,0 +1,73 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: page
+title: Direct messaging
+parent: Using NHS Notify
+nav_order: 3
+permalink: /using-nhs-notify/direct-messaging
+section: By use case
+---
+
+Use NHS Notify to support your organisation or service to send individual messages directly to each of your patients.
+
+## Who can use direct messaging
+
+Direct messaging with NHS Notify is recommended for organisations, services or GPIT suppliers in secondary care.
+
+You might send direct messages for:
+
+- online consultations
+- general primary care
+- acute secondary care appointments
+
+## What features you can use
+
+Find out what features you can and cannot use when you send direct messages with NHS Notify.
+
+{% include custom-components/direct-message-feature-list.html %}
+
+## Using the NHS App for patient journeys
+
+When you send direct messages with NHS Notify, how patients can interact with them and continue their journey depends on your message type.
+
+{% include components/details.html
+heading='General primary care messages'
+text='
+You must adhere to the following in your user journeys:
+
+- the message must only provide information, or its call to action must not involve a digital step (for example, "call your GP")
+- message content must be in the message body or if you’re linking to other message content
+- any links should only open a patients web browser
+- links should only take patients to to web-based content such as your website, NHS.UK, a GP’s website, or other relevant web pages
+- do not include links that open other mobile applications
+ '
+ %}
+
+{% include components/details.html
+heading='Online consultation (OLC) messages'
+text='You must adhere to the following in your user journeys:
+
+- include the clinical response directly in the message body
+- use links to your website for additional content or full responses
+- links should only open a patients web browser
+- do not include links that open other mobile applications
+- only include deeplink’s that takes patients into your OLC journey within the NHS App to view a clinicians response
+- only allow patients to reply to OLC messages through an external website or as part of the broader OLC journey within the NHS App
+ '
+ %}
+
+{% include components/details.html
+heading='Acute secondary care appointment messages (PEPs)'
+text='You must adhere to the following in your user journeys:
+
+- only use content that is standard and created by the Wayfinder programme
+- your NHS Trust owns any of the content linked to digital letters or questionnaires
+- your NHS App message must link directly to the letter or questionnaire, following the standard Wayfinder patient flow
+- all patient replies are handled via questionnaires controlled within the PEP platform, not through the NHS App
+ '%}
+
+## See what's next for NHS Notify
+
+If you're thinking of using NHS Notify for direct messaging but cannot find the features you need, [read our roadmap to find out what we're working on next]({% link pages/features/roadmap.md %}).
diff --git a/docs/pages/using-nhs-notify/event-based-messaging.md b/docs/pages/using-nhs-notify/event-based-messaging.md
new file mode 100644
index 0000000..e79f502
--- /dev/null
+++ b/docs/pages/using-nhs-notify/event-based-messaging.md
@@ -0,0 +1,39 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: page
+title: Event based messaging
+parent: Using NHS Notify
+nav_order: 2
+permalink: /using-nhs-notify/event-based-messaging
+section: By use case
+---
+
+Use NHS Notify to send messages to your recipients when a specific event is triggered in your organisation or service.
+
+## Examples of event based messaging
+
+When an event is triggered you could use NHS Notify to automatically send:
+
+- appointment reminders
+- booking confirmations
+- test results
+
+## What features you can use
+
+Find out what features you can and cannot use when you send event based messages with NHS Notify.
+
+{% include custom-components/transactional-feature-list.html %}
+
+## Using the NHS App for patient journeys
+
+When you send event based messages with the NHS App, you must adhere to the following in your user journeys:
+
+- any links should only open a patients web browser
+- links should only take patients to web content such as your website, NHS.UK or other relevant web pages
+- do not include links that open other mobile applications
+
+## See what's next for NHS Notify
+
+If you're thinking of using NHS Notify for event based messaging but cannot find the features you need, [read our roadmap to find out what we're working on next]({% link pages/features/roadmap.md %}).
diff --git a/docs/pages/using-nhs-notify/using-nhs-notify.md b/docs/pages/using-nhs-notify/using-nhs-notify.md
index cfb1d6b..5993f49 100644
--- a/docs/pages/using-nhs-notify/using-nhs-notify.md
+++ b/docs/pages/using-nhs-notify/using-nhs-notify.md
@@ -11,6 +11,12 @@ permalink: /using-nhs-notify/
This guidance is to help teams understand how to use NHS Notify.
+## By use case
+
+- [Campaigns]({% link pages/using-nhs-notify/campaigns.md %})
+- [Event based messaging]({% link pages/using-nhs-notify/event-based-messaging.md %})
+- [Direct messaging]({% link pages/using-nhs-notify/direct-messaging.md %})
+
## Accessing NHS Notify
- [API]({% link pages/using-nhs-notify/api.md %})
@@ -33,3 +39,5 @@ This guidance is to help teams understand how to use NHS Notify.
- [Tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %})
- [Routing plans]({% link pages/using-nhs-notify/routing-plans.md %})
- [Recipients you cannot message]({% link pages/using-nhs-notify/recipients-you-cannot-message.md %})
+- [Approve your messages before you send them]({% link pages/using-nhs-notify/approve-your-messages.md %})
+- [Message, channel and supplier status]({% link pages/using-nhs-notify/message-status.md %})
From f2b317ef07af59c76575aea5ea3d9ef40c183c09 Mon Sep 17 00:00:00 2001
From: Jake Cosgrove <101206358+jakecosgrove@users.noreply.github.com>
Date: Thu, 22 May 2025 21:56:28 +0000
Subject: [PATCH 2/6] Vale and english usage fixes
---
docs/pages/using-nhs-notify/direct-messaging.md | 2 +-
scripts/config/vale/styles/Vocab/words/accept.txt | 2 ++
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/docs/pages/using-nhs-notify/direct-messaging.md b/docs/pages/using-nhs-notify/direct-messaging.md
index 3537fb7..1a42a1f 100644
--- a/docs/pages/using-nhs-notify/direct-messaging.md
+++ b/docs/pages/using-nhs-notify/direct-messaging.md
@@ -40,7 +40,7 @@ You must adhere to the following in your user journeys:
- the message must only provide information, or its call to action must not involve a digital step (for example, "call your GP")
- message content must be in the message body or if you’re linking to other message content
- any links should only open a patients web browser
-- links should only take patients to to web-based content such as your website, NHS.UK, a GP’s website, or other relevant web pages
+- links should only take patients to web-based content such as your website, NHS.UK, a GP’s website, or other relevant web pages
- do not include links that open other mobile applications
'
%}
diff --git a/scripts/config/vale/styles/Vocab/words/accept.txt b/scripts/config/vale/styles/Vocab/words/accept.txt
index dd57c11..bf1cdde 100644
--- a/scripts/config/vale/styles/Vocab/words/accept.txt
+++ b/scripts/config/vale/styles/Vocab/words/accept.txt
@@ -44,3 +44,5 @@ Marino
Rica
Futuna
Tokelau
+Wayfinder
+phoneNumber
From 2b2ed70371b19d1b0e73b725ce0f57e8931633db Mon Sep 17 00:00:00 2001
From: Jake Cosgrove <101206358+jakecosgrove@users.noreply.github.com>
Date: Thu, 22 May 2025 22:01:28 +0000
Subject: [PATCH 3/6] vale fix
---
scripts/config/vale/styles/Vocab/words/accept.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/config/vale/styles/Vocab/words/accept.txt b/scripts/config/vale/styles/Vocab/words/accept.txt
index 293c609..bf1cdde 100644
--- a/scripts/config/vale/styles/Vocab/words/accept.txt
+++ b/scripts/config/vale/styles/Vocab/words/accept.txt
@@ -44,5 +44,5 @@ Marino
Rica
Futuna
Tokelau
-phoneNumber
Wayfinder
+phoneNumber
From 85f1eb91fd730124fea93928fbf48a418aff6551 Mon Sep 17 00:00:00 2001
From: Jake Cosgrove <101206358+jakecosgrove@users.noreply.github.com>
Date: Thu, 22 May 2025 22:16:50 +0000
Subject: [PATCH 4/6] OOB links added to /get-started to try get users to
contend with OOB
---
docs/pages/get-started/get-started.md | 14 ++---
.../using-nhs-notify/(draft)accordion-test.md | 54 +++++++++----------
2 files changed, 32 insertions(+), 36 deletions(-)
diff --git a/docs/pages/get-started/get-started.md b/docs/pages/get-started/get-started.md
index b130410..81d31cd 100644
--- a/docs/pages/get-started/get-started.md
+++ b/docs/pages/get-started/get-started.md
@@ -11,17 +11,13 @@ permalink: /get-started/
## 1. Check if NHS Notify is right for you
-You can send messages with NHS Notify if your organisation or service is part of NHS England and supports direct care.
+Use NHS Notify if your organisation or service sends:
-You might want to learn more about:
+- [messages that are part of a campaign]({% link pages/using-nhs-notify/campaigns.md %})
+- [event based messages]({% link pages/using-nhs-notify/event-based-messaging.md %})
+- [direct messages]({% link pages/using-nhs-notify/direct-messaging.md %})
-- [our features]({% link pages/features/features.md %})
-- [how to use NHS Notify]({% link pages/using-nhs-notify/using-nhs-notify.md %})
-- [how much it costs to send messages]({% link pages/pricing/pricing.md %})
-- [NHS Notify API (opens in a new tab)](https://digital.nhs.uk/developer/api-catalogue/nhs-notify){:target="\_blank"}
-- [NHS Notify MESH (opens in a new tab)](https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh){:target="\_blank"}
-
-You also may need to read our:
+You may need to read our:
- [terms and conditions (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/terms-and-conditions){:target="\_blank"}
- [acceptable use policy (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/acceptable-use-policy){:target="\_blank"}
diff --git a/docs/pages/using-nhs-notify/(draft)accordion-test.md b/docs/pages/using-nhs-notify/(draft)accordion-test.md
index 335118d..5410e7d 100644
--- a/docs/pages/using-nhs-notify/(draft)accordion-test.md
+++ b/docs/pages/using-nhs-notify/(draft)accordion-test.md
@@ -31,10 +31,10 @@ Find out what features you can use when you send transactional messages with NHS
heading='How you can integrate'
text='
-| Integration method | Availability |
-| ------------------ | --------------------------------------------------------- |
-| NHS Notify API | Recommended |
-| NHS Notify MESH | {::nomarkdown}{:/} |
+| Integration method | Availability |
+| ------------------ | ------------ |
+| NHS Notify API | Recommended |
+| NHS Notify MESH | Yes |
'
%}
@@ -43,12 +43,12 @@ text='
heading='What message channels and other formats you can use'
text='
-| Message channel | Included |
-| ------------------- | --------------------------------------------------------- |
-| NHS App messages | {::nomarkdown}{:/} |
-| Emails | {::nomarkdown}{:/} |
-| Text messages (SMS) | {::nomarkdown}{:/} |
-| Letters | {::nomarkdown}{:/} |
+| Message channel | Included |
+| ------------------- | -------- |
+| NHS App messages | Yes |
+| Emails | Yes |
+| Text messages (SMS) | Yes |
+| Letters | Yes |
'
%}
@@ -57,12 +57,12 @@ text='
heading='Other message formats you can use'
text='
-| Feature | Is it included? |
-| -------------------------- | --------------------------------------------------------- |
-| Braille | {::nomarkdown}{:/} |
-| Large print | {::nomarkdown}{:/} |
-| Audio CD | {::nomarkdown}{:/} |
-| Letters in other languages | {::nomarkdown}{:/} |
+| Feature | Is it included? |
+| -------------------------- | --------------- |
+| Braille | Yes |
+| Large print | Yes |
+| Audio CD | Yes |
+| Letters in other languages | Yes |
'
%}
@@ -71,11 +71,11 @@ text='
heading='What you can do when writing your messages'
text='
-| Feature | Is it included? |
-| ---------------- | ---------------------------------------------------------- |
-| Templates | {::nomarkdown}{:/} |
-| Free-text inputs | {::nomarkdown}{:/} |
-| Personalisation | {::nomarkdown}{:/} |
+| Feature | Is it included? |
+| ---------------- | --------------- |
+| Templates | Yes |
+| Free-text inputs | Yes |
+| Personalisation | Yes |
'
%}
@@ -84,12 +84,12 @@ text='
heading='How you can send your messages'
text='
-| Feature | Is it included? |
-| -------------- | ---------------------------------------------------------- |
-| Rate limiting | Up to 5 TPS |
-| Routing plans | {::nomarkdown}{:/} |
-| Fallback rules | {::nomarkdown}{:/} |
-| Parallel send | {::nomarkdown}{:/} |
+| Feature | Is it included? |
+| -------------- | --------------- |
+| Rate limiting | Up to 5 TPS |
+| Routing plans | Yes |
+| Fallback rules | Yes |
+| Parallel send | Yes |
'
%}
From de7f7bde31724d60f849e813d520de5e4917eade Mon Sep 17 00:00:00 2001
From: Jake Cosgrove <101206358+jakecosgrove@users.noreply.github.com>
Date: Fri, 23 May 2025 08:16:15 +0000
Subject: [PATCH 5/6] Typo correction
---
docs/pages/using-nhs-notify/using-nhs-notify.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/pages/using-nhs-notify/using-nhs-notify.md b/docs/pages/using-nhs-notify/using-nhs-notify.md
index 5993f49..37f6299 100644
--- a/docs/pages/using-nhs-notify/using-nhs-notify.md
+++ b/docs/pages/using-nhs-notify/using-nhs-notify.md
@@ -39,5 +39,5 @@ This guidance is to help teams understand how to use NHS Notify.
- [Tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %})
- [Routing plans]({% link pages/using-nhs-notify/routing-plans.md %})
- [Recipients you cannot message]({% link pages/using-nhs-notify/recipients-you-cannot-message.md %})
-- [Approve your messages before you send them]({% link pages/using-nhs-notify/approve-your-messages.md %})
+- [Approve your messages before we send them]({% link pages/using-nhs-notify/approve-your-messages.md %})
- [Message, channel and supplier status]({% link pages/using-nhs-notify/message-status.md %})
From fd81bb07bf59cd59dc7f7c44b2759b89620093e2 Mon Sep 17 00:00:00 2001
From: Jake Cosgrove <101206358+jakecosgrove@users.noreply.github.com>
Date: Fri, 23 May 2025 11:00:51 +0000
Subject: [PATCH 6/6] Stakeholder feedback changes
---
.../campaign-feature-list.html | 38 ++++++++++++++-----
.../direct-message-feature-list.html | 28 +++++++++++---
.../transactional-feature-list.html | 25 ++++++------
docs/pages/using-nhs-notify/campaigns.md | 2 +-
.../using-nhs-notify/event-based-messaging.md | 2 +-
5 files changed, 65 insertions(+), 30 deletions(-)
diff --git a/docs/_includes/custom-components/campaign-feature-list.html b/docs/_includes/custom-components/campaign-feature-list.html
index 59bfec4..c552a95 100644
--- a/docs/_includes/custom-components/campaign-feature-list.html
+++ b/docs/_includes/custom-components/campaign-feature-list.html
@@ -94,8 +94,8 @@ | Automatic contact look up (mandatory)
+
+ NHS Notify automatically finds and uses your recipients contact details from their NHS number
+
+ |
+ + + + + | +
| Rate limiting
- Set how many messages are sent per second to control how often recipients access your service
+ Set how many messages are sent per second to control how often recipients access your service, also known as
+ transactions per second (TPS)
|
Up to 5TPS | @@ -283,19 +299,21 @@
| Fallback rules
- The following fallback rules will apply to message channels used in your routing plans:
+ The rules that trigger when a fallback is used for each message channel in a routing plan
- + All digital message channels will immediately fallback to the next channel if its rejected or an 'unnotified' status is received. -NHS App messages will fallback to the next channel when: +NHS App messages will fallback to the next channel when:
Emails and text messages will fallback to the next channel if they are XYZ after 72 hours -Letters do not have any fallback rules as they’re always sent last in routing plans for transactional + Emails and text messages will fallback to the next channel if they are not delivered after + 72 hours +Letters do not have any fallback rules as they’re always sent last in routing plans for + transactional messages. |
@@ -332,10 +350,10 @@ Sending messages
NHS Notify prevents you from sending messages to specific recipients to make your messaging more effective
- You cannot send transactional messages to recipients with: +You cannot send campaign messages to recipients with:
Message channels |
| Automatic contact look up (mandatory)
+
+ NHS Notify automatically finds and uses your recipients contact details from their NHS number
+
+ |
+ + + + + | +
| Rate limiting
- Set how many messages are sent per second to control how often recipients access your service
+ Set how many messages are sent per second to control how often recipients access your service, also known as
+ transactions per second (TPS)
|
Up to 5TPS | @@ -307,7 +323,7 @@
| Fallback rules
- These are rules that trigger when a fallback is used for each message channel in a routing plan
+ The rules that trigger when a fallback is used for each message channel in a routing plan
If you send direct messages with the NHS App you must create your own fallback functionality and adhere to the @@ -366,10 +382,10 @@ 3. Acute secondary care appointment NHS App message
|
| Feature | -Included for transactional messages | +Included |
|---|---|---|
| Personalisation + | Automatic contact look up (mandatory)
- Add details like your recipients name, appointment times or reference numbers to your messages
+ NHS Notify automatically finds and uses your recipients contact details from their NHS number
|
@@ -268,7 +268,8 @@ Sending messages |
| Rate limiting
- Set how many messages are sent per second to control how often recipients access your service
+ Set how many messages are sent per second to control how often recipients access your service, also known as
+ transactions per second (TPS)
|
Up to 5TPS | @@ -278,7 +279,7 @@|
| Fallback rules
- The following fallback rules will apply to message channels used in your routing plans:
+ The rules that trigger when a fallback is used for each message channel in a routing plan
- + All digital message channels will immediately fallback to the next channel if its rejected or an 'unnotified' status is received. @@ -313,7 +314,7 @@Sending messagesEmails and text messages will fallback to the next channel if they are XYZ after 72 hours +Emails and text messages will fallback to the next channel if they are not delivered after 72 hours Letters do not have any fallback rules as they’re always sent last in routing plans for transactional messages. |
@@ -351,10 +352,10 @@