Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/pages/features/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ section: Accessing NHS Notify

NHS England organisations and services can integrate the NHS Notify API with their web applications or back office systems.

[Read our API documentation (opens in a new tab)](https://digital.nhs.uk/developer/api-catalogue/nhs-notify){:target="\_blank"}.
<a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify" target="_blank">Read our API documentation (opens in a new tab)</a>.

If youre a developer you can also try our [sandbox test environment (opens in a new tab)](https://digital.nhs.uk/developer/api-catalogue/nhs-notify#overview--environments-and-testing){:target="\_blank"}.
If you're a developer you can also try our <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify#overview--environments-and-testing" target="_blank">sandbox test environment (opens in a new tab)</a>.
10 changes: 5 additions & 5 deletions docs/pages/features/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ You can send messages in bulk or individually.

## Send messages to groups of recipients without their contact details

You only need a persons NHS number to send them messages. Learn how to [tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}).
You only need a person's NHS number to send them messages. Learn how to [tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}).

Create specific cohorts of recipients by using [Cohorting as a Service (opens in a new tab)](https://digital.nhs.uk/services/cohorting-as-a-service-caas){:target="\_blank"}.
Create specific cohorts of recipients by using <a href="https://digital.nhs.uk/services/cohorting-as-a-service-caas" target="_blank">Cohorting as a Service (opens in a new tab)</a>.

## Write your messages

Expand Down Expand Up @@ -62,7 +62,7 @@ You can set up routing plans to:

## Prevent sending people unnecessary messages

NHS Notify uses the [Personal Demographics Service](https://digital.nhs.uk/services/personal-demographics-service) to automatically prevent you from messaging [recipients you cannot message]({% link pages/using-nhs-notify/recipients-you-cannot-message.md %}).
NHS Notify uses the <a href="https://digital.nhs.uk/services/personal-demographics-service" target="_blank">Personal Demographics Service (opens in a new tab)</a> to automatically prevent you from messaging [recipients you cannot message]({% link pages/using-nhs-notify/recipients-you-cannot-message.md %}).

## Reach people with additional needs

Expand All @@ -77,9 +77,9 @@ Track how many messages you’ve sent and find out which ones are not being deli

## Automatic sending

To send messages automatically, youll need a developer to integrate with the NHS Notify API.
To send messages automatically, you'll need a developer to integrate with the NHS Notify API.

[Read our API documentation (opens in a new tab)](https://digital.nhs.uk/developer/api-catalogue/nhs-notify){:target="\_blank"}.
<a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify" target="_blank">Read our API documentation (opens in a new tab)</a>.

## Keep your data secure

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/features/letters.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ NHS Notify uses C5 size envelopes with an address window. This means the A4 lett

### NHS barcode

Letters about test results, appointments and urgent messages can get [Royal Mail's NHS barcode (opens in a new tab)](https://www.royalmailwholesale.com/news/nhs-mail-new-barcode-solution){:target="\_blank"} on the envelope.
Letters about test results, appointments and urgent messages can get <a href="https://www.royalmailwholesale.com/news/nhs-mail-new-barcode-solution" target="_blank">Royal Mail's NHS barcode (opens in a new tab)</a> on the envelope.

You'll need to send by 1st or 2nd class to be able to get the NHS barcode. If you choose NHS Notify's standard postage, you will not get the barcode but your postage rate will be much cheaper. Find out more about [pricing]({% link pages/pricing/letters.md %}).

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/features/mesh.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ permalink: /features/mesh
section: Accessing NHS Notify
---

NHS England organisations and services can use the [Message Exchange for Social Care and Health (MESH)](https://digital.nhs.uk/services/message-exchange-for-social-care-and-health-mesh){:target="\_blank"} to send messages with NHS Notify.
NHS England organisations and services can use the <a href="https://digital.nhs.uk/services/message-exchange-for-social-care-and-health-mesh" target="_blank">Message Exchange for Social Care and Health (MESH) (opens in a new tab)</a> to send messages with NHS Notify.

You should only use MESH to send messages if your organisation or service:

- has limited developer or technical capacity
- only needs to send batches of messages to specific groups of recipients
- does not need advanced features offered by NHS Notify API

[Read our MESH documentation (opens in a new tab)](https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh){:target="\_blank"}.
<a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh" target="_blank">Read our MESH documentation (opens in a new tab)</a>.

Check if MESH is right for you by contacting our engagement team at <england.nhsnotify@nhs.net>.
45 changes: 23 additions & 22 deletions docs/pages/get-started/onboard-with-notify.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,31 +44,31 @@ You'll need to:

{% include components/details.html
heading='Set up your APIM application ID'
text='To set up an APIM application ID, you need to:
text="To set up an APIM application ID, you need to:

1. [Sign in to your NHS Digital developer account](https://digital.nhs.uk/developer).
1. <a href='https://digital.nhs.uk/developer' target='_blank'>Sign in to your NHS Digital developer account (opens in a new tab)</a>.
2. Create an APIM application.
3. Select integration test as the environment.
4. Select Communications Manager (integration environment) as the connected API.
'
3. Select 'integration test' as the environment.
4. Select 'Communications Manager (integration environment)' as the connected API.
"
%}

{% include components/details.html
heading='Choose how you want to see your message performance'
text='To see how your messages perform, you can [get the status of a message](https://digital.nhs.uk/developer/api-catalogue/nhs-notify#get-/v1/messages/-messageId-) or choose to receive [realtime message callbacks](https://digital.nhs.uk/developer/api-catalogue/nhs-notify#post-/%3Cclient-provided-message-status-URI%3E).
text="To see how your messages perform, you can <a href='https://digital.nhs.uk/developer/api-catalogue/nhs-notify#get-/v1/messages/-messageId-' target='_blank'>get the status of a message (opens in a new tab)</a> or choose to receive <a href='https://digital.nhs.uk/developer/api-catalogue/nhs-notify#post-/%3Cclient-provided-message-status-URI%3E' target='_blank'>realtime message callbacks (opens in a new tab)</a>.

If you want to receive realtime message status callbacks, youll need to:
If you want to receive realtime message status callbacks, you'll need to:

- decide which [message, channel or supplier statuses](https://notify.nhs.uk/using-nhs-notify/message-channel-supplier-status) you want to receive
- decide which [message, channel or supplier statuses](/using-nhs-notify/message-channel-supplier-status) you want to receive
- prepare an endpoint URL for your integration
'
"
%}

### If you're using NHS Notify MESH

You'll need to:

1. [Set up your MESH mailboxes (opens in a new tab)](https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh/set-up-nhs-notify-mesh#set-up-your-mesh-mailboxes) and make a note of their IDs.
1. <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh/set-up-nhs-notify-mesh#set-up-your-mesh-mailboxes" target="_blank">Set up your MESH mailboxes (opens in a new tab)</a> and make a note of their IDs.
2. Decide which reports you want when you get reports on how your messages perform.

## 3. Confirm your setup to get access to our integration environment
Expand All @@ -77,7 +77,8 @@ You must confirm how you'll be set up with NHS Notify using our online form so w

{% include components/inset-text.html
text='Only complete the online form and confirm your setup if you’ve been invited to onboard.'
%}
classes='nhsuk-u-margin-top-2'
%}

{% include components/action-link.html
url='https://forms.office.com/Pages/ResponsePage.aspx?id=slTDN7CF9UeyIge0jXdO4-wXWyN79ZdLkmec1Fsc491UNFRYSDFTOUs5TzZQUjlOVUlGWTQxQTlMQy4u'
Expand All @@ -92,9 +93,9 @@ In the form you'll be asked to:
heading='Confirm your use case'
text='You can only use NHS Notify if your organisation or service sends messages that are:

- [part of a campaign](https://notify.nhs.uk/using-nhs-notify/campaigns)
- [triggered when something happens in your service](https://notify.nhs.uk/using-nhs-notify/event-based-messaging)
- [sent directly on a one-to-one basis](https://notify.nhs.uk/using-nhs-notify/direct-messaging)
- [part of a campaign](/using-nhs-notify/campaigns)
- [triggered when something happens in your service](/using-nhs-notify/event-based-messaging)
- [sent directly on a one-to-one basis](/using-nhs-notify/direct-messaging)
'
%}

Expand All @@ -104,10 +105,10 @@ text='When you send messages you’ll need to tell your recipients who your mess

Before you provide your message sender names, you should understand more about:

- [NHS App sender names](https://notify.nhs.uk/using-nhs-notify/tell-recipients-who-your-messages-are-from#nhs-app-sender-name)
- [email sender names and from addresses](https://notify.nhs.uk/using-nhs-notify/tell-recipients-who-your-messages-are-from#email-sender-name-and-from-email-address)
- [email reply-to email addresses](https://notify.nhs.uk/using-nhs-notify/tell-recipients-who-your-messages-are-from#reply-to-email-address)
- [text message sender names](https://notify.nhs.uk/using-nhs-notify/tell-recipients-who-your-messages-are-from#text-message-sender-name)
- [NHS App sender names](/using-nhs-notify/tell-recipients-who-your-messages-are-from#nhs-app-sender-name)
- [email sender names and from addresses](/using-nhs-notify/tell-recipients-who-your-messages-are-from#email-sender-name-and-from-email-address)
- [email reply-to email addresses](/using-nhs-notify/tell-recipients-who-your-messages-are-from#reply-to-email-address)
- [text message sender names](/using-nhs-notify/tell-recipients-who-your-messages-are-from#text-message-sender-name)
'
%}

Expand All @@ -132,7 +133,7 @@ The form will also ask for the routing plans that you want to use for your messa
heading='Tell us who will create and submit templates'
text='You do not need to do this if you send direct messages and use free-text inputs.

When you get access to NHS Notify’s integration environment, you’ll need to [create and submit your templates](https://notify.nhs.uk/using-nhs-notify/create-and-submit-a-template). These templates will be used as the messages you send when you go live.
When you get access to NHS Notify’s integration environment, you’ll need to [create and submit your templates](/using-nhs-notify/create-and-submit-a-template). These templates will be used as the messages you send when you go live.

To access this feature, you must nominate someone in your organisation or service to sign in with NHS Notify. This is because creating and submitting templates is only available to one person in an organisation or service at this time.

Expand Down Expand Up @@ -160,7 +161,7 @@ They'll contact you to either:

## 4. Build your integration

Once you get access to our integration environment, you can start building your integration with [NHS Notify API](https://digital.nhs.uk/developer/api-catalogue/nhs-notify) or [NHS Notify MESH](https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh).
Once you get access to our integration environment, you can start building your integration with <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify" target="_blank">NHS Notify API (opens in a new tab)</a> or <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh" target="_blank">NHS Notify MESH (opens in a new tab)</a>.

How you build your integration to meet your needs is your responsibility.

Expand All @@ -181,7 +182,7 @@ When you’re ready to go live, contact your onboarding manager.
They'll ask you to:

- send them your SCAL
- sign our [connection agreement](https://digital.nhs.uk/developer/guides-and-documentation/online-connection-agreement) if youre a non-NHSE organisation
- sign our <a href="https://digital.nhs.uk/developer/guides-and-documentation/online-connection-agreement" target="_blank">connection agreement (opens in a new tab)</a> if you're a non-NHSE organisation

### If you're using NHS Notify API

Expand Down Expand Up @@ -213,7 +214,7 @@ We will:

## 7. Go live

On your go live date, you can start making requests via [NHS Notify API](https://digital.nhs.uk/developer/api-catalogue/nhs-notify) or [NHS Notify MESH](https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh) to send messages with NHS Notify.
On your go live date, you can start making requests via <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify" target="_blank">NHS Notify API (opens in a new tab)</a> or <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh" target="_blank">NHS Notify MESH (opens in a new tab)</a> to send messages with NHS Notify.

### After you go live

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/support/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ has_children: true
permalink: /support/
---

NHS Notify is a [silver service](https://digital.nhs.uk/services/reference-guide#service-levels){:target="\_blank"} and is available 24 hours a day, 365 days a year.
NHS Notify is a <a href="https://digital.nhs.uk/services/reference-guide#service-levels" target="_blank">silver service (opens in a new tab)</a> and is available 24 hours a day, 365 days a year.

If you're live with NHS Notify and need help, [submit a case with Service Now](https://nhsdigitallive.service-now.com/csm){:target="\_blank"}.
If you're live with NHS Notify and need help, <a href="https://nhsdigitallive.service-now.com/csm" target="_blank">submit a case with Service Now (opens in a new tab)</a>.

If you have any general questions about NHS Notify, send an email to <england.nhsnotify@nhs.net>.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/using-nhs-notify/(draft)accordion-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,5 @@ You cannot send transactional messages to recipients with:
- 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)."
[Find out more about recipients you cannot message](/using-nhs-notify/recipients-you-cannot-message)."
%}
6 changes: 3 additions & 3 deletions docs/pages/using-nhs-notify/accessible-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ section: Writing a message

Before you start to send messages, consider the access needs of your recipients.

All organisations that provide NHS care or publicly-funded adult social care are legally required to follow the [NHS England's Accessible Information Standard](https://www.england.nhs.uk/about/equality/equality-hub/patient-equalities-programme/equality-frameworks-and-information-standards/accessibleinfo/).
All organisations that provide NHS care or publicly-funded adult social care are legally required to follow the <a href="https://www.england.nhs.uk/about/equality/equality-hub/patient-equalities-programme/equality-frameworks-and-information-standards/accessibleinfo/" target="_blank">NHS England's Accessible Information Standard (opens in a new tab)</a>.

## Accessible letter formats

Expand Down Expand Up @@ -47,7 +47,7 @@ This is available for all message channels.
Do this by:

- speaking to our engagement team when you first [get started]({% link pages/get-started/get-started.md %}) with NHS Notify
- raising a [Service Now request](https://nhsdigitallive.service-now.com/csm) if you're already using NHS Notify and have existing templates
- raising a <a href="https://nhsdigitallive.service-now.com/csm" target="_blank">Service Now request (opens in a new tab)</a> if you're already using NHS Notify and have existing templates

### 2. Create your templates and routing plans

Expand All @@ -61,7 +61,7 @@ Provide recipients' NHS numbers as separate data files for each type of accessib

### 4. We'll check for recipients with access needs

NHS Notify checks for recipients who need letters in accessible formats using the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service).
NHS Notify checks for recipients who need letters in accessible formats using the <a href="https://digital.nhs.uk/services/personal-demographics-service" target="_blank">Personal Demographics Service (PDS) (opens in a new tab)</a>.

It’s your responsibility to message recipients based on their access needs.

Expand Down
Loading
Loading