From 40965c7bebc3ac5e9a75450d866ee5e894e0a03c Mon Sep 17 00:00:00 2001 From: jamestynan-content Date: Wed, 15 Apr 2026 09:39:51 +0000 Subject: [PATCH 1/4] Added new 'get started' pages --- .../check-you-can-use-nhs-notify.md | 82 +++++++ ...ck-which-features-you-need-and-register.md | 26 -- .../check-you-can-use-nhs-notify.md | 72 ------ .../get-started-new/get-started-new.md | 24 -- ...ead-and-understand-our-terms-of-service.md | 81 ------- .../understand-onboarding-timescales.md | 32 --- docs/pages/get-started/get-started.md | 26 +- ...egration.md => onboard-with-nhs-notify.md} | 33 +-- docs/pages/get-started/onboard-with-notify.md | 223 ------------------ ...ead-and-understand-our-terms-of-service.md | 80 +++++++ .../get-started/register-your-interest.md | 46 ++++ .../create-and-submit-a-template.md | 2 +- 12 files changed, 228 insertions(+), 499 deletions(-) create mode 100644 docs/pages/get-started/check-you-can-use-nhs-notify.md delete mode 100644 docs/pages/get-started/get-started-new/check-which-features-you-need-and-register.md delete mode 100644 docs/pages/get-started/get-started-new/check-you-can-use-nhs-notify.md delete mode 100644 docs/pages/get-started/get-started-new/get-started-new.md delete mode 100644 docs/pages/get-started/get-started-new/read-and-understand-our-terms-of-service.md delete mode 100644 docs/pages/get-started/get-started-new/understand-onboarding-timescales.md rename docs/pages/get-started/{get-started-new/check-you-are-ready-for-integration.md => onboard-with-nhs-notify.md} (88%) delete mode 100644 docs/pages/get-started/onboard-with-notify.md create mode 100644 docs/pages/get-started/read-and-understand-our-terms-of-service.md create mode 100644 docs/pages/get-started/register-your-interest.md diff --git a/docs/pages/get-started/check-you-can-use-nhs-notify.md b/docs/pages/get-started/check-you-can-use-nhs-notify.md new file mode 100644 index 00000000..527b1573 --- /dev/null +++ b/docs/pages/get-started/check-you-can-use-nhs-notify.md @@ -0,0 +1,82 @@ +--- +layout: mini-hub +title: Check you can use NHS Notify +nav_order: 2 +permalink: /get-started/check-you-can-use-nhs-notify +mini_hub_topic: How to get prepared and start using NHS Notify +mini_hub_pages: + - title: Check you can use NHS Notify + url: + current: true + - title: Read and understand our terms of service + url: /get-started/read-and-understand-our-terms-of-service + - title: Register your interest + url: /get-started/register-your-interest + - title: Onboard with NHS Notify + url: /get-started/onboard-with-nhs-notify + +previous_page: +next_page: + title: Read and understand our terms of service + url: /get-started/read-and-understand-our-terms-of-service +published: true +--- + +What you need before you start. + +## Organisation type and funding + +You must: + +- be funded, directly or indirectly, by the NHS or NHS England +- have funding or a budget agreed for sending messages + +## Message types and content + +You can only use NHS Notify if your organisation or service sends: + +- [event-based messages](https://notify.nhs.uk/about/event-based-messaging) +- [direct messages](https://notify.nhs.uk/about/direct-messaging) +- [messages that are part of a campaign](https://notify.nhs.uk/about/campaigns) + +You must also: + +- intend to only send communications to patients or other members of the public – NHS Notify cannot be used to message NHS staff +- not use NHS Notify to send marketing communications +- check if other organisations or teams within NHS are already sending messages about the same subject matter + +### If you intend to add links in NHS App messages + +Your organisation must onboard with NHS login if your message links to a service that requires users to sign in. + +This keeps users logged in so they do not have to enter their details again. + +{% include components/inset-text.html + text='You must onboard with NHS login at the same time you onboard with NHS Notify. + + Onboard with NHS login (opens in a new tab)' + classes='nhsuk-u-margin-top-2' +%} + +## Commercial and data + +You must: + +- have a way to get the NHS numbers of your recipients +- be prepared to sign a connection agreement (if your organisation is part of NHS England) +- be prepared to sign our memorandum of understanding (if your organisation is not part of NHS England) + +## Technical preparation + +You must have a developer or a technical team to build your integration with NHS Notify. + +You must also decide how you want to integrate with NHS Notify. You can integrate through either: + +- [API](https://notify.nhs.uk/about/api) +- [MESH](https://notify.nhs.uk/about/mesh) + +If you're integrating through API, you can try our sandbox test environment for early developer testing (opens in a new tab). + +## Next step + +If you meet all these criteria, you now need to make sure you’re ready commercially. diff --git a/docs/pages/get-started/get-started-new/check-which-features-you-need-and-register.md b/docs/pages/get-started/get-started-new/check-which-features-you-need-and-register.md deleted file mode 100644 index 6cbb06a3..00000000 --- a/docs/pages/get-started/get-started-new/check-which-features-you-need-and-register.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: mini-hub -title: Check which features you need and register -nav_order: 6 -permalink: /get-started-new/check-which-features-you-need-and-register -mini_hub_topic: Answer a few questions to see which features you need before you register -mini_hub_pages: - - title: Check you can use NHS Notify - url: /get-started-new/check-you-can-use-nhs-notify - - title: Read and understand our terms of service - url: /get-started-new/read-and-understand-our-terms-of-service - - title: Understand our onboarding timescales - url: /get-started-new/understand-onboarding-timescales - - title: Check you are ready for integration - url: /get-started-new/check-you-are-ready-for-integration - - title: Check which features you need and register - url: - current: true -previous_page: - title: Check you are ready for integration - url: /get-started-new/check-you-are-ready-for-integration -next_page: -published: false ---- - -Link to decision tree and register interest form. diff --git a/docs/pages/get-started/get-started-new/check-you-can-use-nhs-notify.md b/docs/pages/get-started/get-started-new/check-you-can-use-nhs-notify.md deleted file mode 100644 index 0c06b414..00000000 --- a/docs/pages/get-started/get-started-new/check-you-can-use-nhs-notify.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -layout: mini-hub -title: Check you can use NHS Notify -nav_order: 2 -permalink: /get-started-new/check-you-can-use-nhs-notify -mini_hub_topic: How to get prepared and start using NHS Notify -mini_hub_pages: - - title: Check you can use NHS Notify - url: - current: true - - title: Read and understand our terms of service - url: /get-started-new/read-and-understand-our-terms-of-service - - title: Understand our onboarding timescales - url: /get-started-new/understand-onboarding-timescales - - title: Check you are ready for integration - url: /get-started-new/check-you-are-ready-for-integration - - title: Check which features you need and register - url: /get-started-new/check-which-features-you-need-and-register -previous_page: -next_page: - title: Read and understand our terms of service - url: /get-started-new/read-and-understand-our-terms-of-service -published: false ---- - -What you need before you start. - -## Organisation type and funding - -You must: - -- be funded, directly or indirectly, by the NHS or NHS England -- have funding or a budget agreed for sending messages - -## Message types and content - -You must: - -- intend to only send communications to patients or other members of the public – NHS Notify cannot be used to message NHS staff -- not use NHS Notify to send marketing communications -- check if other organisations or teams within NHS are already sending messages about the same subject matter - -{% include components/inset-text.html - text='If you intend to add links in NHS App messages, you must also onboard to NHS Login' - classes='nhsuk-u-margin-top-2' -%} - -## Commercial and data - -You must: - -- have a way to get the NHS numbers of your recipients -- be prepared to sign a connection agreement as an NHS England organisation -- be prepared to sign our Memorandum of Understanding and agree to our Payment terms - -## Technical preparation - -You must complete: - -- connection to MESH if you intend to use it for integration -- all sandbox testing - -You must also have the right technical support available to build your integration with NHS Notify: - -- Tester -- Clinical safety advisor -- Technical advisor -- Information governance or security advisor - -## Next step - -If you meet all these criteria, you now need to make sure you’re ready commercially. diff --git a/docs/pages/get-started/get-started-new/get-started-new.md b/docs/pages/get-started/get-started-new/get-started-new.md deleted file mode 100644 index bbe91398..00000000 --- a/docs/pages/get-started/get-started-new/get-started-new.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -# 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: Get started new -nav_order: 1 -has_children: true -permalink: /get-started-new/ -published: false ---- - -Before we can invite you to register your interest in using NHS Notify, you need to check: - -- your organisation can use it -- it's the right messaging product for your needs - -The following steps will help you check this. - -{% include components/button.html - text="Check you can use NHS Notify" - url="/get-started/check-you-can-use-nhs-notify" - target="_blank" -%} diff --git a/docs/pages/get-started/get-started-new/read-and-understand-our-terms-of-service.md b/docs/pages/get-started/get-started-new/read-and-understand-our-terms-of-service.md deleted file mode 100644 index 49d716a2..00000000 --- a/docs/pages/get-started/get-started-new/read-and-understand-our-terms-of-service.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -layout: mini-hub -title: Read and understand our terms of service -nav_order: 3 -permalink: /get-started-new/read-and-understand-our-terms-of-service -mini_hub_topic: You must read and understand our terms of service before you register -mini_hub_pages: - - title: Check you can use NHS Notify - url: /get-started-new/check-you-can-use-nhs-notify - - title: Read and understand our terms of service - url: - current: true - - title: Understand our onboarding timescales - url: /get-started-new/understand-onboarding-timescales - - title: Check you are ready for integration - url: /get-started-new/check-you-are-ready-for-integration - - title: Check which features you need and register - url: /get-started-new/check-which-features-you-need-and-register -previous_page: - title: Check you can use NHS Notify - url: /get-started-new -next_page: - title: Understand our onboarding timescales - url: /get-started-new/understand-onboarding-timescales -published: false ---- - -You must read and understand all of our service terms and get a legal opinion before you continue. - -## Online connection agreement - -If you’re an NHS England organisation, you’ll need to sign our [online connection agreement (opens in a new tab)](https://digital.nhs.uk/developer/guides-and-documentation/online-connection-agreement){:target="\_blank"}. - -## Payment terms - -The payment terms document is a financial agreement that sets out our charges and rules. - -It will forms part of your wider connection agreement with NHS England. - -[Read and understand our payment terms (opens in a new tab)]({% link pages/pricing-and-commercial/how-to-pay.md %}){:target="\_blank"} - -## Memorandum of understanding - -To use NHS Notify, you must agree to the terms in this memorandum of understanding and the payment terms. - -We’ll send you the memorandum of understanding to sign digitally during onboarding. You must sign this before you can go live with NHS Notify. - -[Read and understand our memorandum of understanding (opens in a new tab)]({% link pages/pricing-and-commercial/memorandum-of-understanding.md %}){:target="\_blank"} - -## General terms and conditions - -The purpose of the NHS Notify service terms and conditions is to outline the criteria that: - -- a Connecting Party must be compliant with -- are mandatory to be able to use the NHS Notify service - -[Read and understand our general terms and conditions (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/terms-and-conditions){:target="\_blank"} - -## Security - -NHS Notify is part of NHS England and is built for the security needs of its organisations and services. - -[Read and understand our security features and policy (opens in a new tab)]({% link pages/footer/security.md %}){:target="\_blank"} - -When you’ve read and understood these and received appropriate legal advice, you must now check you’re ready to integrate. - -## Acceptable use policy - -All End User Organisations using the NHS Notify service should read and abide by this NHS Notify acceptable use policy and the connection agreement acceptable use policy. - -[Read and understand our Acceptable use policy (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/acceptable-use-policy){:target="\_blank"} - -## Privacy (transparency notice) - -All End User Organisations using the NHS Notify service should read and abide by our privacy (transparency) notice. - -[Read and understand our privacy policy (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/transparency-notice){:target="\_blank"} - -## Next step - -Once you've read and understood our service terms, make sure you understand our onboarding timescales. diff --git a/docs/pages/get-started/get-started-new/understand-onboarding-timescales.md b/docs/pages/get-started/get-started-new/understand-onboarding-timescales.md deleted file mode 100644 index fc668b08..00000000 --- a/docs/pages/get-started/get-started-new/understand-onboarding-timescales.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: mini-hub -title: Understand our onboarding timescales -nav_order: 4 -permalink: /get-started-new/understand-onboarding-timescales -mini_hub_topic: You should understand our onboarding timescales before you register -mini_hub_pages: - - title: Check you can use NHS Notify - url: /get-started-new/check-you-can-use-nhs-notify - - title: Read and understand our terms of service - url: /get-started-new/read-and-understand-our-terms-of-service - - title: Understand our onboarding timescales - url: - current: true - - title: Check you are ready for integration - url: /get-started-new/check-you-are-ready-for-integration - - title: Check which features you need and register - url: /get-started-new/check-which-features-you-need-and-register -previous_page: - title: Read and understand our terms of service - url: /get-started-new/read-and-understand-our-terms-of-service -next_page: - title: Check you are ready for integration - url: /get-started-new/check-you-are-ready-for-integration -published: false ---- - -You must understand how long it might take to go live with NHS Notify so you can plan your integration. - -CONTENT TBC - -## Next step diff --git a/docs/pages/get-started/get-started.md b/docs/pages/get-started/get-started.md index 77005dbd..b170fdc2 100644 --- a/docs/pages/get-started/get-started.md +++ b/docs/pages/get-started/get-started.md @@ -9,28 +9,14 @@ has_children: true permalink: /get-started/ --- -## 1. Check if NHS Notify is right for you +Before we can invite you to register your interest in using NHS Notify, you need to: -You can only use NHS Notify if your organisation or service sends: +- check your organisation can use it +- understand our terms and conditions -- [event-based messages]({% link pages/about/event-based-messaging.md %}) -- [direct messages]({% link pages/about/direct-messaging.md %}) -- [messages that are part of a campaign]({% link pages/about/campaigns.md %}) - -You also need to have: - -- funding or a budget agreed for sending messages -- a way to get the NHS numbers of your recipients -- technical or developer support to build your integration with NHS Notify - -You should also know [how to onboard with NHS Notify]({% link pages/get-started/onboard-with-notify.md %}). - -## 2. Register your interest - -Complete the following form to register your interest with NHS Notify. This will open in a new tab. +The following steps will help you check this. {% include components/button.html - text="Register your interest" - url="https://forms.office.com/Pages/ResponsePage.aspx?id=slTDN7CF9UeyIge0jXdO4-wXWyN79ZdLkmec1Fsc491UNUNJUkpPTjBXMjdZM0xZT0ZHRUxBNFVWMy4u" - target="_blank" + text="Check you can use NHS Notify" + url="/get-started/check-you-can-use-nhs-notify" %} diff --git a/docs/pages/get-started/get-started-new/check-you-are-ready-for-integration.md b/docs/pages/get-started/onboard-with-nhs-notify.md similarity index 88% rename from docs/pages/get-started/get-started-new/check-you-are-ready-for-integration.md rename to docs/pages/get-started/onboard-with-nhs-notify.md index 2c47bdd3..fe3ce49b 100644 --- a/docs/pages/get-started/get-started-new/check-you-are-ready-for-integration.md +++ b/docs/pages/get-started/onboard-with-nhs-notify.md @@ -1,28 +1,25 @@ --- layout: mini-hub -title: Check you are ready for integration -nav_order: 5 -permalink: /get-started-new/check-you-are-ready-for-integration +title: Onboard with NHS Notify +nav_order: 4 +permalink: /get-started/onboard-with-nhs-notify mini_hub_topic: You must follow the steps to prepare for integration mini_hub_pages: - title: Check you can use NHS Notify - url: /get-started-new/check-you-can-use-nhs-notify + url: /get-started/check-you-can-use-nhs-notify - title: Read and understand our terms of service - url: /get-started-new/read-and-understand-our-terms-of-service - - title: Understand our onboarding timescales - url: /get-started-new/understand-onboarding-timescales - - title: Check you are ready for integration + url: /get-started/read-and-understand-our-terms-of-service + - title: Register your interest + url: /get-started/register-your-interest + - title: Onboard with NHS Notify url: current: true - - title: Check which features you need and register - url: /get-started-new/check-which-features-you-need-and-register previous_page: - title: Understand our onboarding timescales - url: /get-started-new/understand-onboarding-timescales + title: Register your interest + url: /get-started/register-your-interest next_page: - title: Check which features you need and register - url: /get-started-new/check-which-features-you-need-and-register -published: false + +published: true --- ## 1. Prepare your integration @@ -118,7 +115,7 @@ text='You’ll be asked if your organisation or service will: - use custom personalisation fields - have test data prepared for your custom personalisation fields -The form will also ask for the message plans that you want to use for your messages. +The form will also ask for the routing plans that you want to use for your messages. ' %} @@ -179,7 +176,3 @@ Your onboarding manager will ask for your: ### If you’re using NHS Notify MESH Your onboarding manager will ask for your PROD Mesh Mailbox ID. - -## Next step - -Once you've completed all these tasks, you can check which NHS Notify features you'll need and register your interest. diff --git a/docs/pages/get-started/onboard-with-notify.md b/docs/pages/get-started/onboard-with-notify.md deleted file mode 100644 index d27ed88c..00000000 --- a/docs/pages/get-started/onboard-with-notify.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -# 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: Onboard with NHS Notify -parent: Get started -nav_order: 2 -permalink: /get-started/onboard-with-nhs-notify ---- - -Use this page to find out what you need to do step by step to onboard with NHS Notify. - -1. [Get invited to onboard](#1-get-invited-to-onboard) -2. [Prepare your integration](#2-prepare-your-integration) -3. [Confirm your setup to get access to our integration environment](#3-confirm-your-setup-to-get-access-to-our-integration-environment) -4. [Build your integration](#4-build-your-integration) -5. [Complete integration testing](#5-complete-integration-testing) -6. [Apply to go live](#6-apply-to-go-live) -7. [Go live](#7-go-live) - -## 1. Get invited to onboard - -Once you [get started]({% link pages/get-started/get-started.md %}) and register your interest, we'll contact you to either: - -- learn more about your use case -- invite your organisation or service to onboard - -If your organisation or service is invited to onboard, we'll send you an email. This email will include: - -- what you need to do next -- an online form to confirm your setup -- the Supplier Conformance Assessment List SCAL you need to complete before you go live - -## 2. Prepare your integration - -You must prepare your integration before you can get access to NHS Notify's integration environment. - -You'll need technical or developer support to complete tasks in this step. - -### If you're using NHS Notify API - -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: - -1. Sign in to your NHS Digital developer account (opens in a new tab). -2. Create an APIM application. -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 (opens in a new tab) or choose to receive realtime message callbacks (opens in a new tab). - -If you want to receive realtime message status callbacks, you'll need to: - -- 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) 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 - -You must confirm how you'll be set up with NHS Notify using our online form so we can prepare your integration environment to meet your needs. - -{% 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' - text='Confirm your setup with NHS Notify' -%} - -### Before you confirm your setup - -In the form you'll be asked to: - -{% include components/details.html -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](/about/campaigns) -- [triggered when something happens in your service](/about/event-based-messaging) -- [sent directly on a one-to-one basis](/about/direct-messaging) - ' - %} - -{% include components/details.html -heading='Provide your message sender names' -text='When you send messages you’ll need to tell your recipients who your messages are from by creating message sender names. - -Before you provide your message sender names, you should understand more about: - -- [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) - ' - %} - -{% include components/details.html -heading='Provide more detail about your messages and how they’ll be sent' -text='You’ll be asked if your organisation or service will: - -- have finished drafts of the messages you want to send -- send NHS App messages and if so, which links and URLs you’ll include -- send letters in other languages and if so, which languages -- send letters in accessible formats and if so, which formats -- use Personal Demographics Service (PDS) fields -- have your PDS test data ready -- use custom personalisation fields -- have test data prepared for your custom personalisation fields - -The form will also ask for the message plans that you want to use for your messages. -' -%} - -{% include components/details.html -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](/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. - -To sign into NHS Notify you must have a Care Identity (CIS2 authentication). If you do not have a Care Identity, we can help you create one. -' -%} - -{% include components/details.html -heading='Give accurate estimates on your message volumes and frequency' -text='We need to understand how many messages you need to send and how often to set up your integration environment. - -You’ll need to provide: - -- how many messages you want to send per day -- the maximum amount of messages you might send per day - ' - %} - -After you submit the form, it will be reviewed by NHS Notify's onboarding team. - -They'll contact you to either: - -- ask you about some of the answers you provided -- provide access to NHS Notify's integration environment - -## 4. Build your integration - -Once you get access to our integration environment, you can start building your integration with NHS Notify API (opens in a new tab) or NHS Notify MESH (opens in a new tab). - -How you build your integration to meet your needs is your responsibility. - -If you're sending campaign or event based messages, you need to create and submit your templates during this step. You will also need to [approve your messages before we send them]({% link pages/using-nhs-notify/approve-your-messages.md %}). - -## 5. Complete integration testing - -You'll need to [complete integration testing]({% link pages/using-nhs-notify/complete-your-testing.md %}) to make sure you're ready to start sending messages with NHS Notify. - -If you're sending NHS App messages, you'll also need to [complete NHS App testing]({% link pages/using-nhs-notify/complete-your-testing.md %}). - -## 6. Apply to go live - -You'll need technical or developer support to complete tasks in this step. They must also be ready to support the go live process. - -When you’re ready to go live, contact your onboarding manager. - -They'll ask you to: - -- send them your SCAL -- sign our connection agreement (opens in a new tab) if you're a non-NHSE organisation - -### If you're using NHS Notify API - -Your onboarding manager will ask for your: - -- production (PROD) application name -- PROD application ID -- consumer organisation name -- JWKS resource URL (if you’re self-hosting) -- key ID for JWKS and public key (if NHS Notify is hosting your keys via APIM) - -### If you’re using NHS Notify MESH - -Your onboarding manager will ask for your PROD Mesh Mailbox ID. - -### Before you go live - -Once we’ve received your details, you’ll need to: - -- [complete smoke testing]({% link pages/using-nhs-notify/complete-your-testing.md %}), with support from NHS Notify and your technical team -- discuss your rollout or implementation plan with us - -We will: - -- check your SCAL and confirm all assurance is complete -- set you up in the production environment -- work with you to support your rollout or implementation plan -- agree a go live date with you - -## 7. Go live - -On your go live date, you can start making requests via NHS Notify API (opens in a new tab) or NHS Notify MESH (opens in a new tab) to send messages with NHS Notify. - -### After you go live - -NHS Notify will set up a series of early service support calls with you to check your integration is performing as expected. - -If you need help after these calls, contact [support]({% link pages/support/support.md %}). diff --git a/docs/pages/get-started/read-and-understand-our-terms-of-service.md b/docs/pages/get-started/read-and-understand-our-terms-of-service.md new file mode 100644 index 00000000..d446d019 --- /dev/null +++ b/docs/pages/get-started/read-and-understand-our-terms-of-service.md @@ -0,0 +1,80 @@ +--- +layout: mini-hub +title: Read and understand our terms of service +nav_order: 3 +permalink: /get-started/read-and-understand-our-terms-of-service +mini_hub_topic: You must read and understand our terms of service before you register +mini_hub_pages: + - title: Check you can use NHS Notify + url: /get-started/check-you-can-use-nhs-notify + - title: Read and understand our terms of service + url: + current: true + - title: Register your interest + url: /get-started/register-your-interest + - title: Onboard with NHS Notify + url: /get-started/onboard-with-nhs-notify + +previous_page: + title: Check you can use NHS Notify + url: /get-started/check-you-can-use-nhs-notify +next_page: + title: Register your interest + url: /get-started/register-your-interest +published: true +--- + +You must read and understand all of our service terms and get a legal opinion before you continue. + +## Online connection agreement + +If your organisation is not part of NHS England, you’ll need to sign our [online connection agreement (opens in a new tab)](https://digital.nhs.uk/developer/guides-and-documentation/online-connection-agreement){:target="\_blank"}. + +We'll send you the online connection agreement to sign during onboarding. You must sign this before you can go live with NHS Notify. + +## Payment terms + +The payment terms document is a financial agreement that sets out our charges and rules. + +It will forms part of your wider connection agreement with NHS England. + +[Read and understand our payment terms]({% link pages/pricing-and-commercial/how-to-pay.md %}) + +## Memorandum of understanding + +If your organisation is part of NHS England, you must agree to the terms in this memorandum of understanding and the payment terms. + +We’ll send you the memorandum of understanding to sign digitally during onboarding. You must sign this before you can go live with NHS Notify. + +[Read and understand our memorandum of understanding]({% link pages/pricing-and-commercial/memorandum-of-understanding.md %}) + +## General terms and conditions + +The purpose of the NHS Notify service terms and conditions is to outline the criteria that: + +- a Connecting Party must be compliant with +- are mandatory to be able to use the NHS Notify service + +[Read and understand our general terms and conditions (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/terms-and-conditions){:target="\_blank"} + +## Security + +NHS Notify is part of NHS England and is built for the security needs of its organisations and services. + +[Read and understand our security features and policy]({% link pages/footer/security.md %}) + +## Acceptable use policy + +All organisations using NHS Notify should read and abide by our acceptable use policy. + +[Read and understand our Acceptable use policy (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/acceptable-use-policy){:target="\_blank"} + +## Privacy (transparency notice) + +All organisations using the NHS Notify service should read and abide by our privacy (transparency) notice. + +[Read and understand our transparency notice (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/transparency-notice){:target="\_blank"} + +## Next step + +Once you've read and understood our service terms, you can register your interest in using NHS Notify. diff --git a/docs/pages/get-started/register-your-interest.md b/docs/pages/get-started/register-your-interest.md new file mode 100644 index 00000000..4df71358 --- /dev/null +++ b/docs/pages/get-started/register-your-interest.md @@ -0,0 +1,46 @@ +--- +layout: mini-hub +title: Register your interest +nav_order: 3 +permalink: /get-started/register-your-interest +mini_hub_topic: Answer a few questions to register your interest with NHS Notify +mini_hub_pages: + - title: Check you can use NHS Notify + url: /get-started/check-you-can-use-nhs-notify + - title: Read and understand our terms of service + url: /get-started/read-and-understand-our-terms-of-service + - title: Register your interest + url: + current: true + - title: Onboard with NHS Notify + url: /get-started/onboard-with-nhs-notify +previous_page: + title: Read and understand our terms of service + url: /get-started/read-and-understand-our-terms-of-service +next_page: + title: Onboard with NHS Notify + url: /get-started/onboard-with-nhs-notify +published: true +--- +Complete the following form to register your interest with NHS Notify. This will open in a new tab. + +{% include components/button.html + text="Register your interest" + url="https://forms.office.com/Pages/ResponsePage.aspx?id=slTDN7CF9UeyIge0jXdO4-wXWyN79ZdLkmec1Fsc491UNUNJUkpPTjBXMjdZM0xZT0ZHRUxBNFVWMy4u" + target="_blank" +%} + +## Next step + +Once you have registered your interest, we'll contact you to either: + +* learn more about your use case +* invite your organisation or service to onboard + +If your organisation or service is invited to onboard, we'll send you an email. This email will include: + +* what you need to do next +* an online form to continue your setup +* the Supplier Conformance Assessment List (SCAL) you need to complete before you go live. + +You can read more about the onboarding process on the next page. diff --git a/docs/pages/using-nhs-notify/create-and-submit-a-template.md b/docs/pages/using-nhs-notify/create-and-submit-a-template.md index d45a1c63..8d58e1d2 100644 --- a/docs/pages/using-nhs-notify/create-and-submit-a-template.md +++ b/docs/pages/using-nhs-notify/create-and-submit-a-template.md @@ -24,7 +24,7 @@ You can: ## Before you start -You can only create and submit templates when you're accepted to [onboard with NHS Notify]({% link pages/get-started/onboard-with-notify.md %}) and have access to our integration environment. +You can only create and submit templates when you're accepted to [onboard with NHS Notify]({% link pages/get-started/onboard-with-nhs-notify.md %}) and have access to our integration environment. You can sign in with your Care Identity. We'll support you to set this up. From 71153004c53fdc7efbc150a91b37286129667202 Mon Sep 17 00:00:00 2001 From: aidenvaines-cgi Date: Wed, 15 Apr 2026 15:56:30 +0100 Subject: [PATCH 2/4] CCM-15868 fixing vale defs --- .../config/vocabularies/words/accept.txt | 77 +++++++++---------- 1 file changed, 38 insertions(+), 39 deletions(-) diff --git a/scripts/config/vale/styles/config/vocabularies/words/accept.txt b/scripts/config/vale/styles/config/vocabularies/words/accept.txt index b31a6a50..51dc5eb1 100644 --- a/scripts/config/vale/styles/config/vocabularies/words/accept.txt +++ b/scripts/config/vale/styles/config/vocabularies/words/accept.txt @@ -1,53 +1,52 @@ -Bitwarden +: [cC]yber +[iI]nset +[Uu][Rr][Ll] +APIM +Bitwarden +bot +bundler +Burkina +clientRef +Cohorting +ctrl Dependabot +endfor +fullName +Futuna Gitleaks Grype +idempotence +Maarten +Marino +namePrefix +Notify's +Noto +npm OAuth Octokit +onboarding +pending_enrichment +permanent_failure +phoneNumber Podman +precompiled Python +realtime +Rica +rollout +Sao +SCAL +Sint +src Syft +technical_failure +temporary_failure Terraform -Trufflehog -bot -idempotence -onboarding +Tokelau toolchain -bundler -endfor -npm -src -[iI]nset -urlset -[A-Z]+s -Noto -[Uu][Rr][Ll] -ctrl -pending_enrichment +Trufflehog unnotified -permanent_failure -temporary_failure -technical_failure -precompiled +urlset validation_failed -fullName -namePrefix -clientRef -Cohorting -Sint -Maarten -Burkina -Sao -Marino -Rica -Futuna -Tokelau Wayfinder -phoneNumber -: -SCAL -APIM -realtime -Notify's -rollout From 75c5d712e348731f9f07f5a2d57ecd266cdee38f Mon Sep 17 00:00:00 2001 From: jamestynan-content Date: Fri, 17 Apr 2026 09:38:56 +0000 Subject: [PATCH 3/4] Changes to 'get started' pages --- docs/pages/get-started/check-you-can-use-nhs-notify.md | 10 ++++------ .../read-and-understand-our-terms-of-service.md | 9 +++------ 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/docs/pages/get-started/check-you-can-use-nhs-notify.md b/docs/pages/get-started/check-you-can-use-nhs-notify.md index 527b1573..14859045 100644 --- a/docs/pages/get-started/check-you-can-use-nhs-notify.md +++ b/docs/pages/get-started/check-you-can-use-nhs-notify.md @@ -3,7 +3,7 @@ layout: mini-hub title: Check you can use NHS Notify nav_order: 2 permalink: /get-started/check-you-can-use-nhs-notify -mini_hub_topic: How to get prepared and start using NHS Notify +mini_hub_topic: What you need before you start mini_hub_pages: - title: Check you can use NHS Notify url: @@ -22,8 +22,6 @@ next_page: published: true --- -What you need before you start. - ## Organisation type and funding You must: @@ -43,7 +41,7 @@ You must also: - intend to only send communications to patients or other members of the public – NHS Notify cannot be used to message NHS staff - not use NHS Notify to send marketing communications -- check if other organisations or teams within NHS are already sending messages about the same subject matter +- check if other organisations or teams within the NHS are already sending messages about the same subject matter ### If you intend to add links in NHS App messages @@ -72,8 +70,8 @@ You must have a developer or a technical team to build your integration with NHS You must also decide how you want to integrate with NHS Notify. You can integrate through either: -- [API](https://notify.nhs.uk/about/api) -- [MESH](https://notify.nhs.uk/about/mesh) +- [NHS Notify API](https://notify.nhs.uk/about/api) +- [NHS Notify MESH](https://notify.nhs.uk/about/mesh) If you're integrating through API, you can try our sandbox test environment for early developer testing (opens in a new tab). diff --git a/docs/pages/get-started/read-and-understand-our-terms-of-service.md b/docs/pages/get-started/read-and-understand-our-terms-of-service.md index d446d019..024f8437 100644 --- a/docs/pages/get-started/read-and-understand-our-terms-of-service.md +++ b/docs/pages/get-started/read-and-understand-our-terms-of-service.md @@ -3,7 +3,7 @@ layout: mini-hub title: Read and understand our terms of service nav_order: 3 permalink: /get-started/read-and-understand-our-terms-of-service -mini_hub_topic: You must read and understand our terms of service before you register +mini_hub_topic: You must read and understand all of our service terms and get a legal opinion before you continue mini_hub_pages: - title: Check you can use NHS Notify url: /get-started/check-you-can-use-nhs-notify @@ -23,9 +23,6 @@ next_page: url: /get-started/register-your-interest published: true --- - -You must read and understand all of our service terms and get a legal opinion before you continue. - ## Online connection agreement If your organisation is not part of NHS England, you’ll need to sign our [online connection agreement (opens in a new tab)](https://digital.nhs.uk/developer/guides-and-documentation/online-connection-agreement){:target="\_blank"}. @@ -36,7 +33,7 @@ We'll send you the online connection agreement to sign during onboarding. You mu The payment terms document is a financial agreement that sets out our charges and rules. -It will forms part of your wider connection agreement with NHS England. +It will form part of your wider connection agreement with NHS England. [Read and understand our payment terms]({% link pages/pricing-and-commercial/how-to-pay.md %}) @@ -67,7 +64,7 @@ NHS Notify is part of NHS England and is built for the security needs of its org All organisations using NHS Notify should read and abide by our acceptable use policy. -[Read and understand our Acceptable use policy (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/acceptable-use-policy){:target="\_blank"} +[Read and understand our acceptable use policy (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/acceptable-use-policy){:target="\_blank"} ## Privacy (transparency notice) From d8cbc35cb22d253d9875bb5e7341942d41ebdf70 Mon Sep 17 00:00:00 2001 From: jamestynan-content Date: Fri, 17 Apr 2026 09:54:06 +0000 Subject: [PATCH 4/4] Changes to get started pages --- docs/pages/get-started/check-you-can-use-nhs-notify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/get-started/check-you-can-use-nhs-notify.md b/docs/pages/get-started/check-you-can-use-nhs-notify.md index 14859045..68c8eb5d 100644 --- a/docs/pages/get-started/check-you-can-use-nhs-notify.md +++ b/docs/pages/get-started/check-you-can-use-nhs-notify.md @@ -73,7 +73,7 @@ You must also decide how you want to integrate with NHS Notify. You can integrat - [NHS Notify API](https://notify.nhs.uk/about/api) - [NHS Notify MESH](https://notify.nhs.uk/about/mesh) -If you're integrating through API, you can try our sandbox test environment for early developer testing (opens in a new tab). +If you're integrating through NHS Notify API, you can try our sandbox test environment for early developer testing (opens in a new tab). ## Next step