Onboarding guidance and downloadable templates

This page provides an outline of the whole onboarding process and downloadable templates for some of the evidence and documentation that you'll be asked to submit via the Digital onboarding portal.

• connecting parties submit the details of their product, organisation and use case via the Digital onboarding page

• connecting parties are also expected to complete the mandatory prerequisites to initiate their onboarding. These prerequisites are listed in the Digital onboarding page

• once the connecting party completes Stage 1, we will determine whether there is a valid use case for the connecting party to use the DoS REST API

• connecting parties are granted access to the DoS REST API test environment to help develop their product

• before progressing with Stage 2 via Digital onboarding, connecting parties will be asked to acknowledge the Find the Right Service Onboarding Rules of Engagement

• connecting parties will be asked to provide all necessary documentation to demonstrate the product is clinically and technically compliant. This will involve downloading and completing the templates listed below, and uploading them to the Digital onboarding page

• other questions will not require evidence to be submitted in a specific format, and this will be left at the discretion of the connecting party

• additional evidence will be provided during online meetings with NHSE Subject Matter Experts. During these meetings, the connecting party will be asked to demonstrate their product - this will be the last chance for the connecting party to complete any outstanding prerequisites

• we will review all submitted documentation and either accept or ask to iterate where necessary

• when we are satisfied that all required documentation and evidence has been submitted, the connecting party will receive a Technical Conformance certificate

• once the API assurance has been approved you need to accept the connection agreement to get access to the production API. When your connection agreement is ready, an email notification will be issued from [email protected], you will be directed to the customer portal to view and accept your connection agreement

• upon reception of the signed agreement, we will grant access to the DoS REST API live environment or request the connecting party to iterate the connection agreement and submit it again

• Reference guide - use the Reference guide to explore the terms we use, the type of technologies we have, and find important information
• Building healthcare software - organisations and healthcare services - a non-technical guide to building software that deals with organisations and healthcare services within the NHS in England
• Operations - the Operations team is responsible for the ongoing maintenance and support of operational services
• Health and Social Care Network (HSCN) - provides a reliable, efficient and flexible way for health and care organisations to access and exchange electronic information