From e4da81343a2eb3c00e0b8d90f89817d8b3a82dca Mon Sep 17 00:00:00 2001 From: Alex Colbeck <36191568+alexcolbeck1@users.noreply.github.com> Date: Tue, 30 Dec 2025 16:26:50 +0000 Subject: [PATCH 1/6] Add mini-hub layout and pagination components with example pages --- docs/_includes/breadcrumb.html | 6 +++ docs/_includes/components/contents-list.html | 25 ++++++++++ docs/_includes/components/pagination.html | 48 +++++++++++++++++++ docs/_layouts/mini-hub.html | 49 ++++++++++++++++++++ docs/pages/mini-hub-example/page-1.md | 29 ++++++++++++ docs/pages/mini-hub-example/page-2.md | 31 +++++++++++++ docs/pages/mini-hub-example/page-3.md | 31 +++++++++++++ docs/pages/mini-hub-example/page-4.md | 31 +++++++++++++ docs/pages/mini-hub-example/page-5.md | 29 ++++++++++++ docs/pages/pagination-example/page-1.md | 22 +++++++++ docs/pages/pagination-example/page-2.md | 24 ++++++++++ docs/pages/pagination-example/page-3.md | 24 ++++++++++ docs/pages/pagination-example/page-4.md | 24 ++++++++++ docs/pages/pagination-example/page-5.md | 22 +++++++++ 14 files changed, 395 insertions(+) create mode 100644 docs/_includes/components/contents-list.html create mode 100644 docs/_includes/components/pagination.html create mode 100644 docs/_layouts/mini-hub.html create mode 100644 docs/pages/mini-hub-example/page-1.md create mode 100644 docs/pages/mini-hub-example/page-2.md create mode 100644 docs/pages/mini-hub-example/page-3.md create mode 100644 docs/pages/mini-hub-example/page-4.md create mode 100644 docs/pages/mini-hub-example/page-5.md create mode 100644 docs/pages/pagination-example/page-1.md create mode 100644 docs/pages/pagination-example/page-2.md create mode 100644 docs/pages/pagination-example/page-3.md create mode 100644 docs/pages/pagination-example/page-4.md create mode 100644 docs/pages/pagination-example/page-5.md diff --git a/docs/_includes/breadcrumb.html b/docs/_includes/breadcrumb.html index 525cdbe..14c49af 100644 --- a/docs/_includes/breadcrumb.html +++ b/docs/_includes/breadcrumb.html @@ -40,6 +40,12 @@ {% endif %} + {% if page.parent == "Pagination example" %} +
  • + Pagination example +
    • + {% endif %} + diff --git a/docs/_includes/components/contents-list.html b/docs/_includes/components/contents-list.html new file mode 100644 index 0000000..24142d1 --- /dev/null +++ b/docs/_includes/components/contents-list.html @@ -0,0 +1,25 @@ +{%- comment -%} +NHS Contents List Component +Used for mini-hub navigation + +Parameters: +- items: array of objects with 'title', 'url', and optional 'current' (boolean) + +Example usage: +{% include components/contents-list.html items=page.mini_hub_pages %} +{%- endcomment -%} + + diff --git a/docs/_includes/components/pagination.html b/docs/_includes/components/pagination.html new file mode 100644 index 0000000..39ad123 --- /dev/null +++ b/docs/_includes/components/pagination.html @@ -0,0 +1,48 @@ +{%- comment -%} +NHS Pagination Component +Used for mini-hub page navigation + +Parameters: +- previous: object with 'title' and 'url' (optional) +- next: object with 'title' and 'url' (optional) + +Example usage: +{% include components/pagination.html previous=page.previous_page next=page.next_page %} +{%- endcomment -%} + + diff --git a/docs/_layouts/mini-hub.html b/docs/_layouts/mini-hub.html new file mode 100644 index 0000000..a117f78 --- /dev/null +++ b/docs/_layouts/mini-hub.html @@ -0,0 +1,49 @@ +--- +layout: default +--- + +
    +
    +
    +
    + + {%- comment -%} + Mini-hub heading with topic subtitle + {%- endcomment -%} +

    + + {{ page.title }} + {% if page.mini_hub_topic %} + + + - + + {{ page.mini_hub_topic }} + + {% endif %} + +

    + + {%- comment -%} + Contents list navigation + {%- endcomment -%} + {% if page.mini_hub_pages %} + {% include components/contents-list.html items=page.mini_hub_pages %} + {% endif %} + + {%- comment -%} + Page content + {%- endcomment -%} + {{ content }} + + {%- comment -%} + Pagination navigation + {%- endcomment -%} + {% if page.previous_page or page.next_page %} + {% include components/pagination.html previous=page.previous_page next=page.next_page %} + {% endif %} + +
    +
    +
    +
    diff --git a/docs/pages/mini-hub-example/page-1.md b/docs/pages/mini-hub-example/page-1.md new file mode 100644 index 0000000..1342c56 --- /dev/null +++ b/docs/pages/mini-hub-example/page-1.md @@ -0,0 +1,29 @@ +--- +layout: mini-hub +title: Page 1 title +nav_order: 1 +permalink: /mini-hub-example/ +mini_hub_topic: Mini hub example +mini_hub_pages: + - title: Page 1 title + url: /mini-hub-example/ + current: true + - title: Page 2 title + url: /mini-hub-example/page-2 + - title: Page 3 title + url: /mini-hub-example/page-3 + - title: Page 4 title + url: /mini-hub-example/page-4 + - title: Page 5 title + url: /mini-hub-example/page-5 +previous_page: +next_page: + title: Page 2 title + url: /mini-hub-example/page-2 +--- + +## Placeholder content + +This is placeholder content for page 1. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. diff --git a/docs/pages/mini-hub-example/page-2.md b/docs/pages/mini-hub-example/page-2.md new file mode 100644 index 0000000..bd4df96 --- /dev/null +++ b/docs/pages/mini-hub-example/page-2.md @@ -0,0 +1,31 @@ +--- +layout: mini-hub +title: Page 2 title +nav_order: 2 +permalink: /mini-hub-example/page-2 +mini_hub_topic: Mini hub example +mini_hub_pages: + - title: Page 1 title + url: /mini-hub-example + - title: Page 2 title + url: /mini-hub-example/page-2 + current: true + - title: Page 3 title + url: /mini-hub-example/page-3 + - title: Page 4 title + url: /mini-hub-example/page-4 + - title: Page 5 title + url: /mini-hub-example/page-5 +previous_page: + title: Page 1 title + url: /mini-hub-example/ +next_page: + title: Page 3 title + url: /mini-hub-example/page-3 +--- + +## Placeholder content + +This is placeholder content for page 2. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. diff --git a/docs/pages/mini-hub-example/page-3.md b/docs/pages/mini-hub-example/page-3.md new file mode 100644 index 0000000..f12c7b4 --- /dev/null +++ b/docs/pages/mini-hub-example/page-3.md @@ -0,0 +1,31 @@ +--- +layout: mini-hub +title: Page 3 title +nav_order: 3 +permalink: /mini-hub-example/page-3 +mini_hub_topic: Mini hub example +mini_hub_pages: + - title: Page 1 title + url: /mini-hub-example/ + - title: Page 2 title + url: /mini-hub-example/page-2 + - title: Page 3 title + url: /mini-hub-example/page-3 + current: true + - title: Page 4 title + url: /mini-hub-example/page-4 + - title: Page 5 title + url: /mini-hub-example/page-5 +previous_page: + title: Page 2 title + url: /mini-hub-example/page-2 +next_page: + title: Page 4 title + url: /mini-hub-example/page-4 +--- + +## Placeholder content + +This is placeholder content for page 3. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. diff --git a/docs/pages/mini-hub-example/page-4.md b/docs/pages/mini-hub-example/page-4.md new file mode 100644 index 0000000..9608cae --- /dev/null +++ b/docs/pages/mini-hub-example/page-4.md @@ -0,0 +1,31 @@ +--- +layout: mini-hub +title: Page 4 title +nav_order: 4 +permalink: /mini-hub-example/page-4 +mini_hub_topic: Mini hub example +mini_hub_pages: + - title: Page 1 title + url: /mini-hub-example/ + - title: Page 2 title + url: /mini-hub-example/page-2 + - title: Page 3 title + url: /mini-hub-example/page-3 + - title: Page 4 title + url: /mini-hub-example/page-4 + current: true + - title: Page 5 title + url: /mini-hub-example/page-5 +previous_page: + title: Page 3 title + url: /mini-hub-example/page-3 +next_page: + title: Page 5 title + url: /mini-hub-example/page-5 +--- + +## Placeholder content + +This is placeholder content for page 4. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. diff --git a/docs/pages/mini-hub-example/page-5.md b/docs/pages/mini-hub-example/page-5.md new file mode 100644 index 0000000..ba5c2c4 --- /dev/null +++ b/docs/pages/mini-hub-example/page-5.md @@ -0,0 +1,29 @@ +--- +layout: mini-hub +title: Page 5 title +nav_order: 5 +permalink: /mini-hub-example/page-5 +mini_hub_topic: Mini hub example +mini_hub_pages: + - title: Page 1 title + url: /mini-hub-example/ + - title: Page 2 title + url: /mini-hub-example/page-2 + - title: Page 3 title + url: /mini-hub-example/page-3 + - title: Page 4 title + url: /mini-hub-example/page-4 + - title: Page 5 title + url: /mini-hub-example/page-5 + current: true +previous_page: + title: Page 4 title + url: /mini-hub-example/page-4 +next_page: +--- + +## Placeholder content + +This is placeholder content for page 5. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. diff --git a/docs/pages/pagination-example/page-1.md b/docs/pages/pagination-example/page-1.md new file mode 100644 index 0000000..d8a0499 --- /dev/null +++ b/docs/pages/pagination-example/page-1.md @@ -0,0 +1,22 @@ +--- +layout: page +title: Page 1 title +parent: Pagination example +nav_order: 1 +permalink: /pagination-example/ +mini_hub_pages: +previous_page: +next_page: + title: Page 2 title + url: /pagination-example/page-2 +--- + +## Placeholder content + +This is placeholder content for page 1. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. + +{% if page.previous_page or page.next_page %} +{% include components/pagination.html previous=page.previous_page next=page.next_page %} +{% endif %} diff --git a/docs/pages/pagination-example/page-2.md b/docs/pages/pagination-example/page-2.md new file mode 100644 index 0000000..1818715 --- /dev/null +++ b/docs/pages/pagination-example/page-2.md @@ -0,0 +1,24 @@ +--- +layout: page +title: Page 2 title +parent: Pagination example +nav_order: 2 +permalink: /pagination-example/page-2 +mini_hub_pages: +previous_page: + title: Page 1 title + url: /pagination-example/ +next_page: + title: Page 3 title + url: /pagination-example/page-3 +--- + +## Placeholder content + +This is placeholder content for page 2. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. + +{% if page.previous_page or page.next_page %} +{% include components/pagination.html previous=page.previous_page next=page.next_page %} +{% endif %} diff --git a/docs/pages/pagination-example/page-3.md b/docs/pages/pagination-example/page-3.md new file mode 100644 index 0000000..ddf9c0f --- /dev/null +++ b/docs/pages/pagination-example/page-3.md @@ -0,0 +1,24 @@ +--- +layout: page +title: Page 3 title +parent: Pagination example +nav_order: 3 +permalink: /pagination-example/page-3 +mini_hub_pages: +previous_page: + title: Page 2 title + url: /pagination-example/page-2 +next_page: + title: Page 4 title + url: /pagination-example/page-4 +--- + +## Placeholder content + +This is placeholder content for page 3. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. + +{% if page.previous_page or page.next_page %} +{% include components/pagination.html previous=page.previous_page next=page.next_page %} +{% endif %} diff --git a/docs/pages/pagination-example/page-4.md b/docs/pages/pagination-example/page-4.md new file mode 100644 index 0000000..6c53fa0 --- /dev/null +++ b/docs/pages/pagination-example/page-4.md @@ -0,0 +1,24 @@ +--- +layout: page +title: Page 4 title +parent: Pagination example +nav_order: 4 +permalink: /pagination-example/page-4 +mini_hub_pages: +previous_page: + title: Page 3 title + url: /pagination-example/page-3 +next_page: + title: Page 5 title + url: /pagination-example/page-5 +--- + +## Placeholder content + +This is placeholder content for page 4. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. + +{% if page.previous_page or page.next_page %} +{% include components/pagination.html previous=page.previous_page next=page.next_page %} +{% endif %} diff --git a/docs/pages/pagination-example/page-5.md b/docs/pages/pagination-example/page-5.md new file mode 100644 index 0000000..9314962 --- /dev/null +++ b/docs/pages/pagination-example/page-5.md @@ -0,0 +1,22 @@ +--- +layout: page +title: Page 5 title +parent: Pagination example +nav_order: 5 +permalink: /pagination-example/page-5 +mini_hub_pages: +previous_page: + title: Page 4 title + url: /pagination-example/page-4 +next_page: +--- + +## Placeholder content + +This is placeholder content for page 5. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. + +{% if page.previous_page or page.next_page %} +{% include components/pagination.html previous=page.previous_page next=page.next_page %} +{% endif %} From 023eb0d0d2fa3ef94b1edbebd0a4c20c0ab327c2 Mon Sep 17 00:00:00 2001 From: emmagifford <162720670+emmagifford@users.noreply.github.com> Date: Tue, 30 Dec 2025 17:32:16 +0000 Subject: [PATCH 2/6] Add breadcrumb to mini-hub layout --- docs/_layouts/mini-hub.html | 5 ++++- docs/assets/css/_nhsnotify.scss | 10 ++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/_layouts/mini-hub.html b/docs/_layouts/mini-hub.html index a117f78..d6f80c8 100644 --- a/docs/_layouts/mini-hub.html +++ b/docs/_layouts/mini-hub.html @@ -2,7 +2,7 @@ layout: default --- -
    +
    @@ -10,6 +10,9 @@ {%- comment -%} Mini-hub heading with topic subtitle {%- endcomment -%} + + {% include breadcrumb.html %} +

    {{ page.title }} diff --git a/docs/assets/css/_nhsnotify.scss b/docs/assets/css/_nhsnotify.scss index 7eb7b14..19efd0f 100644 --- a/docs/assets/css/_nhsnotify.scss +++ b/docs/assets/css/_nhsnotify.scss @@ -198,6 +198,16 @@ } */ +/* Mini-hub: adjust breadcrumb spacing to match NHS Service Manual pattern */ +.nhsnotify-mini-hub .nhsuk-breadcrumb { + margin-top: 0; + margin-bottom: nhsuk-spacing(3); + + @include nhsuk-media-query($from: tablet) { + margin-bottom: nhsuk-spacing(4); + } +} + // Home page button margin override .nhsnotify-home-page .nhsuk-button { margin-bottom: 0; From 99fafa044367f7eb5e959b82a55dbb786b17794d Mon Sep 17 00:00:00 2001 From: emmagifford <162720670+emmagifford@users.noreply.github.com> Date: Wed, 31 Dec 2025 15:32:15 +0000 Subject: [PATCH 3/6] Remove breadcrumb from mini-hub example pages --- docs/_layouts/mini-hub.html | 2 +- docs/assets/css/_nhsnotify.scss | 10 +--------- 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/_layouts/mini-hub.html b/docs/_layouts/mini-hub.html index d6f80c8..c733761 100644 --- a/docs/_layouts/mini-hub.html +++ b/docs/_layouts/mini-hub.html @@ -11,7 +11,7 @@ Mini-hub heading with topic subtitle {%- endcomment -%} - {% include breadcrumb.html %} +

    diff --git a/docs/assets/css/_nhsnotify.scss b/docs/assets/css/_nhsnotify.scss index 19efd0f..7a02329 100644 --- a/docs/assets/css/_nhsnotify.scss +++ b/docs/assets/css/_nhsnotify.scss @@ -198,15 +198,7 @@ } */ -/* Mini-hub: adjust breadcrumb spacing to match NHS Service Manual pattern */ -.nhsnotify-mini-hub .nhsuk-breadcrumb { - margin-top: 0; - margin-bottom: nhsuk-spacing(3); - - @include nhsuk-media-query($from: tablet) { - margin-bottom: nhsuk-spacing(4); - } -} +/* Mini-hub breadcrumb styles removed */ // Home page button margin override .nhsnotify-home-page .nhsuk-button { From 7f7aa86215975c5674bdc283169f796eae555545 Mon Sep 17 00:00:00 2001 From: emmagifford <162720670+emmagifford@users.noreply.github.com> Date: Wed, 31 Dec 2025 16:44:40 +0000 Subject: [PATCH 4/6] Update /get-started content CCM-13340 --- ...ck-which-features-you-need-and-register.md | 12 ++ .../check-you-are-ready-for-integration.md | 174 ++++++++++++++++++ .../check-you-can-use-nhs-notify.md | 35 ++++ docs/pages/get-started/get-started.md | 26 +-- docs/pages/get-started/onboard-with-notify.md | 3 +- ...ead-and-understand-our-terms-of-service.md | 66 +++++++ .../understand-onboarding-timescales.md | 28 +++ docs/pages/mini-hub-example copy/page-1.md | 29 +++ docs/pages/mini-hub-example copy/page-2.md | 31 ++++ docs/pages/mini-hub-example copy/page-3.md | 31 ++++ docs/pages/mini-hub-example copy/page-4.md | 31 ++++ docs/pages/mini-hub-example copy/page-5.md | 29 +++ .../create-and-submit-a-template.md | 2 +- 13 files changed, 473 insertions(+), 24 deletions(-) create mode 100644 docs/pages/get-started/check-which-features-you-need-and-register.md create mode 100644 docs/pages/get-started/check-you-are-ready-for-integration.md create mode 100644 docs/pages/get-started/check-you-can-use-nhs-notify.md create mode 100644 docs/pages/get-started/read-and-understand-our-terms-of-service.md create mode 100644 docs/pages/get-started/understand-onboarding-timescales.md create mode 100644 docs/pages/mini-hub-example copy/page-1.md create mode 100644 docs/pages/mini-hub-example copy/page-2.md create mode 100644 docs/pages/mini-hub-example copy/page-3.md create mode 100644 docs/pages/mini-hub-example copy/page-4.md create mode 100644 docs/pages/mini-hub-example copy/page-5.md diff --git a/docs/pages/get-started/check-which-features-you-need-and-register.md b/docs/pages/get-started/check-which-features-you-need-and-register.md new file mode 100644 index 0000000..63dec40 --- /dev/null +++ b/docs/pages/get-started/check-which-features-you-need-and-register.md @@ -0,0 +1,12 @@ +--- +# 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: Check which features you need and register +parent: Get started +nav_order: 5 +permalink: /get-started/check-which-features-you-need-and-register +--- + +Link to decision tree and register interest form. diff --git a/docs/pages/get-started/check-you-are-ready-for-integration.md b/docs/pages/get-started/check-you-are-ready-for-integration.md new file mode 100644 index 0000000..d7087d0 --- /dev/null +++ b/docs/pages/get-started/check-you-are-ready-for-integration.md @@ -0,0 +1,174 @@ +--- +# 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: Check you're ready for integration +parent: Get started +nav_order: 4 +permalink: /get-started/check-you-are-ready-for-integration +--- + +## 1. 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. + +## 2. 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](/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) + ' + %} + +{% 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 routing 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 + +## 3. 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 %}). + +## 4. 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 %}). + +### 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. + +## Next step + +Once you've completed all these tasks, you can check which NHS Notify features you'll need and register your interest. + +{% include components/action-link.html + url='/get-started/read-and-understand-our-terms-of-service' + text='Check which features you can use and register' +%} 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 0000000..376529f --- /dev/null +++ b/docs/pages/get-started/check-you-can-use-nhs-notify.md @@ -0,0 +1,35 @@ +--- +# 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: Check you can use NHS Notify +parent: Get started +nav_order: 1 +permalink: /get-started/check-you-can-use-nhs-notify +--- + +You can only use NHS Notify if your organisation or service sends: + +- event-based messages +- direct messages +- messages that are part of a campaign + +You must also: + +- be funded, directly or indirectly, by the NHS or NHS England +- have funding or a budget agreed for sending messages +- 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 +- have a way to get the NHS numbers of your recipients +- have technical or developer support to build your integration with NHS Notify + +## Next step + +If you meet all these criteria, you now need to make sure you’re ready commercially. + +{% include components/action-link.html + url='/get-started/read-and-understand-our-terms-of-service' + text='Read and understand our terms of service' +%} diff --git a/docs/pages/get-started/get-started.md b/docs/pages/get-started/get-started.md index 77005db..c538339 100644 --- a/docs/pages/get-started/get-started.md +++ b/docs/pages/get-started/get-started.md @@ -9,28 +9,10 @@ has_children: true permalink: /get-started/ --- -## 1. Check if NHS Notify is right for you +If we use the original side-nav layout, we need a parent page for the get started section. -You can only use NHS Notify if your organisation or service sends: +Then the 5 stages would sit as child pages under the parent page. -- [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 %}) +This parent page could contain a high-level overview of the get started section. -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. - -{% include components/button.html - text="Register your interest" - url="https://forms.office.com/Pages/ResponsePage.aspx?id=slTDN7CF9UeyIge0jXdO4-wXWyN79ZdLkmec1Fsc491UNUNJUkpPTjBXMjdZM0xZT0ZHRUxBNFVWMy4u" - target="_blank" -%} +This content isn't really necessary, but a parent page is necessary for this particular structure. diff --git a/docs/pages/get-started/onboard-with-notify.md b/docs/pages/get-started/onboard-with-notify.md index 153a61f..791bf19 100644 --- a/docs/pages/get-started/onboard-with-notify.md +++ b/docs/pages/get-started/onboard-with-notify.md @@ -5,8 +5,9 @@ layout: page title: Onboard with NHS Notify parent: Get started -nav_order: 2 +nav_order: 6 permalink: /get-started/onboard-with-nhs-notify +published: false --- Use this page to find out what you need to do step by step to onboard with NHS Notify. 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 0000000..41dbbac --- /dev/null +++ b/docs/pages/get-started/read-and-understand-our-terms-of-service.md @@ -0,0 +1,66 @@ +--- +# 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: Read and understand our terms of service +parent: Get started +nav_order: 2 +permalink: /get-started/read-and-understand-our-terms-of-service +--- + +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 + +Needed at this stage? + +## Privacy (transparency notice) + +Needed at this stage? + +## Next step + +Once you've read and understood our service terms, make sure you understand our onboarding timescales. + +{% include components/action-link.html + url='/get-started/understand-onboarding-timescales' + text='Understand our onboarding timescales' +%} diff --git a/docs/pages/get-started/understand-onboarding-timescales.md b/docs/pages/get-started/understand-onboarding-timescales.md new file mode 100644 index 0000000..58cfa26 --- /dev/null +++ b/docs/pages/get-started/understand-onboarding-timescales.md @@ -0,0 +1,28 @@ +--- +# 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: Understand our onboarding timescales +parent: Get started +nav_order: 3 +permalink: /get-started/understand-onboarding-timescales +--- + +You must understand how long it might take to go live with NHS Notify so you can plan your integration. + +CONTENT TBC + +## Next step + +You must check you're ready for integration before you can register for NHS Notify. + +{% include components/inset-text.html + text='You’ll need technical or developer support to complete tasks in this next step.' + classes='nhsuk-u-margin-top-2' +%} + +{% include components/action-link.html + url='/get-started/check-you-are-ready-for-integration' + text='Check you’re ready for integration' +%} diff --git a/docs/pages/mini-hub-example copy/page-1.md b/docs/pages/mini-hub-example copy/page-1.md new file mode 100644 index 0000000..1342c56 --- /dev/null +++ b/docs/pages/mini-hub-example copy/page-1.md @@ -0,0 +1,29 @@ +--- +layout: mini-hub +title: Page 1 title +nav_order: 1 +permalink: /mini-hub-example/ +mini_hub_topic: Mini hub example +mini_hub_pages: + - title: Page 1 title + url: /mini-hub-example/ + current: true + - title: Page 2 title + url: /mini-hub-example/page-2 + - title: Page 3 title + url: /mini-hub-example/page-3 + - title: Page 4 title + url: /mini-hub-example/page-4 + - title: Page 5 title + url: /mini-hub-example/page-5 +previous_page: +next_page: + title: Page 2 title + url: /mini-hub-example/page-2 +--- + +## Placeholder content + +This is placeholder content for page 1. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. diff --git a/docs/pages/mini-hub-example copy/page-2.md b/docs/pages/mini-hub-example copy/page-2.md new file mode 100644 index 0000000..bd4df96 --- /dev/null +++ b/docs/pages/mini-hub-example copy/page-2.md @@ -0,0 +1,31 @@ +--- +layout: mini-hub +title: Page 2 title +nav_order: 2 +permalink: /mini-hub-example/page-2 +mini_hub_topic: Mini hub example +mini_hub_pages: + - title: Page 1 title + url: /mini-hub-example + - title: Page 2 title + url: /mini-hub-example/page-2 + current: true + - title: Page 3 title + url: /mini-hub-example/page-3 + - title: Page 4 title + url: /mini-hub-example/page-4 + - title: Page 5 title + url: /mini-hub-example/page-5 +previous_page: + title: Page 1 title + url: /mini-hub-example/ +next_page: + title: Page 3 title + url: /mini-hub-example/page-3 +--- + +## Placeholder content + +This is placeholder content for page 2. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. diff --git a/docs/pages/mini-hub-example copy/page-3.md b/docs/pages/mini-hub-example copy/page-3.md new file mode 100644 index 0000000..f12c7b4 --- /dev/null +++ b/docs/pages/mini-hub-example copy/page-3.md @@ -0,0 +1,31 @@ +--- +layout: mini-hub +title: Page 3 title +nav_order: 3 +permalink: /mini-hub-example/page-3 +mini_hub_topic: Mini hub example +mini_hub_pages: + - title: Page 1 title + url: /mini-hub-example/ + - title: Page 2 title + url: /mini-hub-example/page-2 + - title: Page 3 title + url: /mini-hub-example/page-3 + current: true + - title: Page 4 title + url: /mini-hub-example/page-4 + - title: Page 5 title + url: /mini-hub-example/page-5 +previous_page: + title: Page 2 title + url: /mini-hub-example/page-2 +next_page: + title: Page 4 title + url: /mini-hub-example/page-4 +--- + +## Placeholder content + +This is placeholder content for page 3. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. diff --git a/docs/pages/mini-hub-example copy/page-4.md b/docs/pages/mini-hub-example copy/page-4.md new file mode 100644 index 0000000..9608cae --- /dev/null +++ b/docs/pages/mini-hub-example copy/page-4.md @@ -0,0 +1,31 @@ +--- +layout: mini-hub +title: Page 4 title +nav_order: 4 +permalink: /mini-hub-example/page-4 +mini_hub_topic: Mini hub example +mini_hub_pages: + - title: Page 1 title + url: /mini-hub-example/ + - title: Page 2 title + url: /mini-hub-example/page-2 + - title: Page 3 title + url: /mini-hub-example/page-3 + - title: Page 4 title + url: /mini-hub-example/page-4 + current: true + - title: Page 5 title + url: /mini-hub-example/page-5 +previous_page: + title: Page 3 title + url: /mini-hub-example/page-3 +next_page: + title: Page 5 title + url: /mini-hub-example/page-5 +--- + +## Placeholder content + +This is placeholder content for page 4. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. diff --git a/docs/pages/mini-hub-example copy/page-5.md b/docs/pages/mini-hub-example copy/page-5.md new file mode 100644 index 0000000..ba5c2c4 --- /dev/null +++ b/docs/pages/mini-hub-example copy/page-5.md @@ -0,0 +1,29 @@ +--- +layout: mini-hub +title: Page 5 title +nav_order: 5 +permalink: /mini-hub-example/page-5 +mini_hub_topic: Mini hub example +mini_hub_pages: + - title: Page 1 title + url: /mini-hub-example/ + - title: Page 2 title + url: /mini-hub-example/page-2 + - title: Page 3 title + url: /mini-hub-example/page-3 + - title: Page 4 title + url: /mini-hub-example/page-4 + - title: Page 5 title + url: /mini-hub-example/page-5 + current: true +previous_page: + title: Page 4 title + url: /mini-hub-example/page-4 +next_page: +--- + +## Placeholder content + +This is placeholder content for page 5. Replace this with your actual content. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 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 d45a1c6..1ebe259 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/get-started.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 ee5466bf71aeeced15b9ba961ccc397406fc1a80 Mon Sep 17 00:00:00 2001 From: AndyLongContentNHS Date: Fri, 23 Jan 2026 11:47:49 +0000 Subject: [PATCH 5/6] Pending changes exported from your codespace --- ...ck-which-features-you-need-and-register.md | 25 +++ .../check-you-are-ready-for-integration.md | 184 ++++++++++++++++++ .../check-you-can-use-nhs-notify.md | 48 +++++ ...ead-and-understand-our-terms-of-service.md | 76 ++++++++ .../understand-onboarding-timescales.md | 31 +++ 5 files changed, 364 insertions(+) create mode 100644 docs/pages/get-started-2/check-which-features-you-need-and-register.md create mode 100644 docs/pages/get-started-2/check-you-are-ready-for-integration.md create mode 100644 docs/pages/get-started-2/check-you-can-use-nhs-notify.md create mode 100644 docs/pages/get-started-2/read-and-understand-our-terms-of-service.md create mode 100644 docs/pages/get-started-2/understand-onboarding-timescales.md diff --git a/docs/pages/get-started-2/check-which-features-you-need-and-register.md b/docs/pages/get-started-2/check-which-features-you-need-and-register.md new file mode 100644 index 0000000..626fa71 --- /dev/null +++ b/docs/pages/get-started-2/check-which-features-you-need-and-register.md @@ -0,0 +1,25 @@ +--- +layout: mini-hub +title: Check which features you need and register +nav_order: 5 +permalink: /get-started-2/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-2/check-you-can-use-nhs-notify + - title: Read and understand our terms of service + url: /get-started-2/read-and-understand-our-terms-of-service + - title: Understand our onboarding timescales + url: /get-started-2/understand-onboarding-timescales + - title: Check you are ready for integration + url: /get-started-2/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-2/check-you-are-ready-for-integration +next_page: +--- + +Link to decision tree and register interest form. diff --git a/docs/pages/get-started-2/check-you-are-ready-for-integration.md b/docs/pages/get-started-2/check-you-are-ready-for-integration.md new file mode 100644 index 0000000..8933481 --- /dev/null +++ b/docs/pages/get-started-2/check-you-are-ready-for-integration.md @@ -0,0 +1,184 @@ +--- +layout: mini-hub +title: Check you are ready for integration +nav_order: 4 +permalink: /get-started-2/check-you-are-ready-for-integration +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-2/check-you-can-use-nhs-notify + - title: Read and understand our terms of service + url: /get-started-2/read-and-understand-our-terms-of-service + - title: Understand our onboarding timescales + url: /get-started-2/understand-onboarding-timescales + - title: Check you are ready for integration + url: + current: true + - title: Check which features you need and register + url: /get-started-2/check-which-features-you-need-and-register +previous_page: + title: Understand our onboarding timescales + url: /get-started-2/understand-onboarding-timescales +next_page: + title: Check which features you need and register + url: /get-started-2/check-which-features-you-need-and-register +--- + +## 1. 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. + +## 2. 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](/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) + ' + %} + +{% 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 routing 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 + +## 3. 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 %}). + +## 4. 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 %}). + +### 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. + +## 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-2/check-you-can-use-nhs-notify.md b/docs/pages/get-started-2/check-you-can-use-nhs-notify.md new file mode 100644 index 0000000..1c9cbaa --- /dev/null +++ b/docs/pages/get-started-2/check-you-can-use-nhs-notify.md @@ -0,0 +1,48 @@ +--- +layout: mini-hub +title: Check you can use NHS Notify +nav_order: 1 +permalink: /get-started-2/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-2/read-and-understand-our-terms-of-service + - title: Understand our onboarding timescales + url: /get-started-2/understand-onboarding-timescales + - title: Check you are ready for integration + url: /get-started-2/check-you-are-ready-for-integration + - title: Check which features you need and register + url: /get-started-2/check-which-features-you-need-and-register +previous_page: +next_page: + title: Read and understand our terms of service + url: /get-started-2/read-and-understand-our-terms-of-service +--- + +You can only use NHS Notify if your organisation or service sends: + +- event-based messages +- direct messages +- messages that are part of a campaign + +You must also: + +- be funded, directly or indirectly, by the NHS or NHS England +- have funding or a budget agreed for sending messages +- 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 +- have a way to get the NHS numbers of your recipients +- have technical or developer support to build your integration with NHS Notify + +{% 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' +%} + +## 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-2/read-and-understand-our-terms-of-service.md b/docs/pages/get-started-2/read-and-understand-our-terms-of-service.md new file mode 100644 index 0000000..bebe7dd --- /dev/null +++ b/docs/pages/get-started-2/read-and-understand-our-terms-of-service.md @@ -0,0 +1,76 @@ +--- +layout: mini-hub +title: Read and understand our terms of service +nav_order: 2 +permalink: /get-started-2/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-2/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-2/understand-onboarding-timescales + - title: Check you are ready for integration + url: /get-started-2/check-you-are-ready-for-integration + - title: Check which features you need and register + url: /get-started-2/check-which-features-you-need-and-register +previous_page: + title: Check you can use NHS Notify + url: /get-started-2/ +next_page: + title: Understand our onboarding timescales + url: /get-started-2/understand-onboarding-timescales +--- + +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 + +Needed at this stage? + +## Privacy (transparency notice) + +Needed at this stage? + +## 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-2/understand-onboarding-timescales.md b/docs/pages/get-started-2/understand-onboarding-timescales.md new file mode 100644 index 0000000..08ae697 --- /dev/null +++ b/docs/pages/get-started-2/understand-onboarding-timescales.md @@ -0,0 +1,31 @@ +--- +layout: mini-hub +title: Understand our onboarding timescales +nav_order: 3 +permalink: /get-started-2/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-2/check-you-can-use-nhs-notify + - title: Read and understand our terms of service + url: /get-started-2/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-2/check-you-are-ready-for-integration + - title: Check which features you need and register + url: /get-started-2/check-which-features-you-need-and-register +previous_page: + title: Read and understand our terms of service + url: /get-started-2/read-and-understand-our-terms-of-service +next_page: + title: Check you are ready for integration + url: /get-started-2/check-you-are-ready-for-integration +--- + +You must understand how long it might take to go live with NHS Notify so you can plan your integration. + +CONTENT TBC + +## Next step From 2d670f8bc5a9b7ba1ba266504ab2d4cc3a928e6d Mon Sep 17 00:00:00 2001 From: AndyLongContentNHS Date: Mon, 2 Feb 2026 14:13:10 +0000 Subject: [PATCH 6/6] Update new get started section using mini hub design --- .../check-you-can-use-nhs-notify.md | 37 +++++++++++++++---- ...ead-and-understand-our-terms-of-service.md | 8 +++- 2 files changed, 36 insertions(+), 9 deletions(-) diff --git a/docs/pages/get-started-2/check-you-can-use-nhs-notify.md b/docs/pages/get-started-2/check-you-can-use-nhs-notify.md index 1c9cbaa..f49d80e 100644 --- a/docs/pages/get-started-2/check-you-can-use-nhs-notify.md +++ b/docs/pages/get-started-2/check-you-can-use-nhs-notify.md @@ -22,27 +22,50 @@ next_page: url: /get-started-2/read-and-understand-our-terms-of-service --- -You can only use NHS Notify if your organisation or service sends: +What you need before you start. -- event-based messages -- direct messages -- messages that are part of a campaign +## Organisation type and funding -You must also: +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 -- have a way to get the NHS numbers of your recipients -- have technical or developer support to build your integration with NHS Notify {% 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-2/read-and-understand-our-terms-of-service.md b/docs/pages/get-started-2/read-and-understand-our-terms-of-service.md index bebe7dd..d585607 100644 --- a/docs/pages/get-started-2/read-and-understand-our-terms-of-service.md +++ b/docs/pages/get-started-2/read-and-understand-our-terms-of-service.md @@ -65,11 +65,15 @@ When you’ve read and understood these and received appropriate legal advice, y ## Acceptable use policy -Needed at this stage? +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) -Needed at this stage? +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