|
| 1 | +--- |
| 2 | +# Feel free to add content and custom Front Matter to this file. |
| 3 | +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults |
| 4 | + |
| 5 | +layout: page |
| 6 | +title: Onboarding |
| 7 | +parent: Get started |
| 8 | +nav_order: 2 |
| 9 | +permalink: /get-started/onboarding |
| 10 | +--- |
| 11 | + |
| 12 | +Use this page to find out what you need to do to onboard with NHS Notify. |
| 13 | + |
| 14 | +1. [Register your interest](#1-register-your-interest)<!-- markdownlint-disable-line --> |
| 15 | +2. [Attend an early engagement call](#2-attend-an-early-engagement-call) |
| 16 | +3. [Get invited to start integration and onboarding](#3-get-invited-to-start-integration-and-onboarding) |
| 17 | +4. [Confirm setup and eligibility](#4-confirm-setup-and-eligibility) |
| 18 | +5. [Prepare for technical integration](#5-prepare-for-technical-integration) |
| 19 | +6. [Create your templates](#6-create-your-templates) |
| 20 | +7. [Create your routing plans](#7-create-your-routing-plans) |
| 21 | +8. [Integrate and test with NHS Notify](#8-integrate-and-test-with-nhs-notify) |
| 22 | +9. [Meet the technical conformance requirements](#9-meet-the-technical-conformance-requirements) |
| 23 | +10. [Complete the connection agreement](#10-complete-the-connection-agreement) |
| 24 | +11. [Onboarding complete](#11-onboarding-complete) |
| 25 | + |
| 26 | +## Before you start |
| 27 | + |
| 28 | +NHS organisations or services must be eligible to use NHS Notify before they can onboard. |
| 29 | + |
| 30 | +You can use NHS Notify if your programme or service: |
| 31 | + |
| 32 | +- is part of NHS England |
| 33 | +- supports direct care |
| 34 | + |
| 35 | +You'll need to integrate with [NHS Notify API]({% link pages/using-nhs-notify/api.md %}) or [NHS Notify MESH]({% link pages/using-nhs-notify/mesh.md %}) to send messages. You may need a developer or a technical team to do this. |
| 36 | + |
| 37 | +If you want to try NHS Notify API, use our sandbox environments. |
| 38 | + |
| 39 | +## 1. Register your interest |
| 40 | + |
| 41 | +If you’re eligible to use NHS Notify, you can email our onboarding team at < [email protected]> to register your interest. |
| 42 | + |
| 43 | +We'll aim to contact you within 10 working days to arrange an early engagement call. |
| 44 | + |
| 45 | +## 2. Attend an early engagement call |
| 46 | + |
| 47 | +The early engagement call will help NHS Notify to understand your needs. We'll ask you about: |
| 48 | + |
| 49 | +- estimated volumes |
| 50 | +- which channels you want to use |
| 51 | +- what your organisation or service is trying to achieve |
| 52 | + |
| 53 | +The call will also cover some costing estimates based on the information you give. |
| 54 | + |
| 55 | +## 3. Get invited to start integration and onboarding |
| 56 | + |
| 57 | +After your early engagement call, NHS Notify will prioritise your case along with other onboarding services and organisations. |
| 58 | + |
| 59 | +Due to our current service capacity and features, you may have to wait before you can continue onboarding. We're working hard to increase the scale of our service. |
| 60 | + |
| 61 | +[Read our roadmap to find out what we're doing next]({% link pages/features/roadmap.md %}). |
| 62 | + |
| 63 | +## 4. Confirm setup and eligibility |
| 64 | + |
| 65 | +NHS Notify needs to confirm that your service is eligible and suitable to integrate with its API. |
| 66 | + |
| 67 | +You will need to provide detailed information about: |
| 68 | + |
| 69 | +- your product or service and the organisation it represents |
| 70 | +- why you want to use NHS Notify to send messages to patients |
| 71 | +- what messages you plan to send |
| 72 | +- how your messages will meet the accessible information standard |
| 73 | +- how you want to send your messages |
| 74 | +- the frequency and volumes of messages you plan to send |
| 75 | + |
| 76 | +You will also need to provide information about: |
| 77 | + |
| 78 | +- what data items you plan to process |
| 79 | +- why you need to process this data |
| 80 | +- if you use children's data |
| 81 | +- what data processing activities you need to undertake |
| 82 | +- your product or service's Data Protection Impact Assessment (DPIA) |
| 83 | + |
| 84 | +{% include components/inset-text.html |
| 85 | +text='This information will be reviewed by the NHS Notify service team. If your organisation or service is eligible and suitable, you will be able to continue onboarding. |
| 86 | + |
| 87 | +If your organisation or service is not suitable or eligible to use NHS Notify for any reason, the service team will contact you to explain.' |
| 88 | + |
| 89 | +%} |
| 90 | + |
| 91 | +## 5. Prepare for technical integration |
| 92 | + |
| 93 | +This stage covers the requirements your service needs to meet before it begins integration with NHS Notify. |
| 94 | + |
| 95 | +Your service will need to: |
| 96 | + |
| 97 | +{% include components/details.html |
| 98 | +heading='Declare Data and Information security controls' |
| 99 | +text='To ensure you have controls in place to keep patient data private and secure, you must complete the Data and Security Protection Toolkit (DSPT). |
| 100 | + |
| 101 | +You will need to evidence: |
| 102 | + |
| 103 | +- processes for ensuring End User Organisations of your product or service have a ‘standards met’ or ‘approaching standards’ DSPT |
| 104 | +- a formal and documented Information Security Management System (ISMS) that covers the scope of your product or service' |
| 105 | + %} |
| 106 | + |
| 107 | +{% include components/details.html |
| 108 | +heading='Implement a Clinical Risk Management process' |
| 109 | +text='As an organisation of healthcare software, you must ensure you implement a clinical risk management process that conforms to the DCB0129 standard. |
| 110 | + |
| 111 | +You will need to evidence: |
| 112 | + |
| 113 | +- your service is compliant with the DCB0129 standard |
| 114 | +- who your Clinical Safety Officer is and their contact details |
| 115 | +- that your Clinical Safety Officer has approved a clinical safety report of your product or service |
| 116 | +- you considered the NHS Digital hazard log during development |
| 117 | +- the Caldicott Guardian is aware of each of your use cases and plans to send messages to patients and the public' |
| 118 | + %} |
| 119 | + |
| 120 | +{% include components/details.html |
| 121 | +heading='Register for service and incident management' |
| 122 | +text='If you’re an NHS organisation or service, you may already be registered for service management with the NHS England National Service Desk. |
| 123 | + |
| 124 | +If you’re not already registered, you can register with the NHS England National Service Desk. |
| 125 | + |
| 126 | +Your programme or service will also need to have an incident management process that is consistent with the NHS England Incident Management process.' |
| 127 | +%} |
| 128 | + |
| 129 | +Once this stage is completed, you can begin to technically integrate and test with NHS Notify. |
| 130 | + |
| 131 | +## 6. Create your templates |
| 132 | + |
| 133 | +To send an NHS App message, email, text message or letter with NHS Notify, you must create a reusable message template. |
| 134 | + |
| 135 | +Templates let you send the same thing to lots of people, as often as you need to, without writing a new message each time. |
| 136 | + |
| 137 | +Learn how to create: |
| 138 | + |
| 139 | +- [NHS App message templates]({% link pages/using-nhs-notify/nhs-app-templates.md %}) |
| 140 | +- [email templates]({% link pages/using-nhs-notify/email-templates.md %}) |
| 141 | +- [text message templates]({% link pages/using-nhs-notify/text-message-templates.md %}) |
| 142 | +- [letter templates]({% link pages/using-nhs-notify/letter-templates.md %}) |
| 143 | + |
| 144 | +## 7. Create your routing plans |
| 145 | + |
| 146 | +You’ll need to create a routing plan to decide how messages will be sent to your recipients. The NHS Notify team will support you to create your routing plans. |
| 147 | + |
| 148 | +[Learn more about routing plans]({% link pages/using-nhs-notify/routing-plans.md %}). |
| 149 | + |
| 150 | +## 8. Integrate and test with NHS Notify |
| 151 | + |
| 152 | +Use NHS Notify’s integration test environments to run formal integration sandbox-testing. |
| 153 | + |
| 154 | +You'll need at least one template and one routing plan for testing. These can contain mock data. |
| 155 | + |
| 156 | +The integration test environment is stateful, which means it receive updates. It also includes [signed JWT authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) which allows you to test the integration environment without writing any code. |
| 157 | + |
| 158 | +You can try the integration environment using [NHS Notify’s Postman collection](https://god.gw.postman.com/run-collection/28740466-ec078d1e-d4d7-4460-92b9-7d79d51f967a?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D28740466-ec078d1e-d4d7-4460-92b9-7d79d51f967a%26entityType%3Dcollection%26workspaceId%3D3664098f-4f8b-4edf-874d-ed33e1eea8ed). |
| 159 | + |
| 160 | +## 9. Meet the technical conformance requirements |
| 161 | + |
| 162 | +This stage covers the technical requirements your service or organisations needs to meet before it can go live with NHS Notify. |
| 163 | + |
| 164 | +You will need to: |
| 165 | + |
| 166 | +{% include components/details.html |
| 167 | +heading='Show that it meets NHS Notify’s technical conformance requirements' |
| 168 | +text='Your service will need to accept that it is responsible for: |
| 169 | + |
| 170 | +- using the correct processes to identify the recipients of messages you plan to send |
| 171 | +- authoring and proofing the content of messages |
| 172 | +- managing the volume of messages it sends so it does not exceed any previously agreed amounts |
| 173 | + |
| 174 | +You will also need to confirm that you have successfully completed integration testing with NHS Notify.' |
| 175 | +%} |
| 176 | + |
| 177 | +{% include components/details.html |
| 178 | +heading='Prove you have developed your integration securely' |
| 179 | +text='Your service should be designed, developed and deployed in a way that minimises and mitigates threats to its security. |
| 180 | + |
| 181 | +Overall, you will need to evidence that your organisation or service: |
| 182 | + |
| 183 | +- has a System Level Security Policy (SLSP) in place |
| 184 | +- aligns with NCSC Secure development and deployment guidance |
| 185 | +- adheres to the 10 data security standards – Security Self Assessment |
| 186 | + |
| 187 | +To prove that your service has developed securely, we ask for information and evidence around the following topics. |
| 188 | + |
| 189 | +### People |
| 190 | + |
| 191 | +Do the staff and people operating your organisation or service: |
| 192 | + |
| 193 | +- commit to handle information respectfully and safely, according to the Caldicott Principles |
| 194 | +- understand their responsibilities under the National Data Guardian’s Data Security Standards |
| 195 | +- complete appropriate annual data security training and pass mandatory tests provided through the DSPT |
| 196 | + |
| 197 | +### Processes |
| 198 | + |
| 199 | +Does your organisation or service: |
| 200 | + |
| 201 | +- ensure personal confidential information is only accessible by required staff and is attributable to individuals |
| 202 | +- complete annual reviews to prevent instances where data security is compromised |
| 203 | +- have processes and procedures to deal with security incidents resultant of cyber attacks |
| 204 | +- have a continuity plan in place to respond to data security that is tested annually |
| 205 | + |
| 206 | +### Technology |
| 207 | + |
| 208 | +Does your organisation or service have proof that: |
| 209 | + |
| 210 | +- it only uses supported operating systems, software or browsers within its IT estate |
| 211 | +- a strategy is in place to protect IT systems from cyber threats |
| 212 | +- processes and procedures are in place to deal with security incidents resultant of cyber attacks |
| 213 | +- any third party IT suppliers are contractually accountable for protecting personal confidential data that they process and meet National Data Guardian’s Data Security Standards |
| 214 | + |
| 215 | +### Data in transit protection |
| 216 | + |
| 217 | +Does your organisation or service confirm that data in transit is: |
| 218 | + |
| 219 | +- encrypted by default, including sensitive data in transit |
| 220 | +- protected between your end-user device(s) and your service |
| 221 | +- protected between internal components within the service |
| 222 | +- protected where exposed to other external service, for example, via an API |
| 223 | + |
| 224 | +### Identity and authentication |
| 225 | + |
| 226 | +Access to service interfaces should be constrained to authenticated and authorised individuals. |
| 227 | + |
| 228 | +Does your organisation or service confirm that: |
| 229 | + |
| 230 | +- access to internal and external interfaces is authenticated |
| 231 | +- it has processes to manage the lifecycle of service credentials |
| 232 | + ' |
| 233 | + %} |
| 234 | + |
| 235 | +## 10. Complete the connection agreement |
| 236 | + |
| 237 | +{% include components/inset-text.html |
| 238 | +text='You only need to complete the connection agreement if your organisation or service is not part of NHS England.' |
| 239 | +%} |
| 240 | + |
| 241 | +This stage is about accepting the terms of use for NHS Notify, otherwise known as the Connection Agreement. |
| 242 | + |
| 243 | +It is a legal document that is signed alongside any financial agreements between NHS Notify, its suppliers and your service. |
| 244 | + |
| 245 | +Accepting and signing the Connection Agreement must be done by someone in your service’s organisation with the appropriate authority. |
| 246 | + |
| 247 | +## 11. Onboarding complete |
| 248 | + |
| 249 | +Once you have proven you integrated securely, you will be given a go live date by the NHS Notify team. You can then start using NHS Notify to send messages to patients or members of the public. |
0 commit comments