Access Document Assurance Process
Please note this process is not yet live - please refer back to your Onboarding Lead for the current 'as-is' process.
API Overview Page: Access Document
Onboarding to GP Connect is performed via the Digital Onboarding Service and comprises of 3 different gates (1, 2 & 3). All functional and non-functional requirements needed to achieve technical conformance will be displayed within your application once it has been configured correctly. The Digital Onboarding Service is used to onboard many NHS England products, so you may already have an account from another integration.
There are a few generic DOS guides available which cover creating an account, managing your application and amending users which can be found here: Digital assurance user guides - NHS England Digital.
Once your application has successfully been set up (instructions in Gate 1 below) you will see several different sections that you will need to complete.
To commence the assurance process you will first need to submit the following sections:
- Product Details
- Organisation Details
Towards the bottom of the page, you will find the API-specific sections which will become available once your Onboarding Lead has approved the two sections mentioned above. Each requirement will detail what evidence you are required to submit. Several requirements will also have a test case referenced which you will need complete using the relevant test patients and test environments before uploading the supporting evidence. Each gate of assurance will be subject to a review and sign-off by our Technical Assurance team and any relevant subject matter experts (SMEs) before you can progress to the next gate.
Review SLA: Each submission is subject to a 10-working-day review SLA. This may increase during periods of high submission volume.
During the assurance process you will be expected to use the various test tools/environments to construct (following the technical specifications) and send API requests to our test endpoints which will return a response. You will then need to render the response within your UI/application and provide the relevant evidence for us to review (e.g. API request & response messages and screenshots of UI).
It is important to develop your product in accordance with the relevant GP Connect Product Specification. Supporting materials are available with our specifications. As our products evolve, our specifications may change to reflect this. Please ensure that you're always developing to the latest GP Connect specifications, as not doing so may affect your ability to achieve technical conformance.
- Product is developed and ready to integrate
- Clinical safety prerequisite is met
- Information Governance (IG) prerequisites are met
The Internet facing demonstrator(Orange Test Lab) provides consumers with the ability to test GP Connect APIs only.
This environment:
- Does not include Spine capabilities (PDS/SDS)
- Requires no authentication.
- Is accessible via the internet (no HSCN required at this stage).
The aim of this stage is to allow consumers to integrate their product with the GP Connect API and verify that API requests and responses can be successfully presented.
Create an account and sign in using your credentials. Guides available here: Getting started - NHS England Digital
Upon successful login, navigate to the Digital Onboarding Service section.
You will be redirected to the Products section.
- If you have previously started or completed onboarding for PDS, your product may already be listed.
- If not, create a new product.
Important:
- GP Connect APIs are restricted meaning you cannot add the GP Connect APIs directly yourself, your NHS England onboarding lead must add these for you.
- During product creation, select the relevant PDS API.
- Spine Directory Services API is not required for Gate 1 testing.
Once your onboarding lead has granted access to the GP Connect APIs, the relevant assurance sections will become available.
| Section | Sub-section | Gate 1 Submission Requirements | Notes |
|---|---|---|---|
| Check your eligibility | Product details | Complete in full prior to Gate 1 | |
| Check your eligibility | Organisation details | Complete in full prior to Gate 1 | |
| Shared sections | Declare Data Security and Information Security | Aim to submit (not mandatory for Gate 1 review, but advised to complete as early as possible) | |
| Shared sections | Implement a clinical risk management process | Aim to submit (not mandatory for Gate 1 review, but advised to complete as early as possible) | |
| Shared sections | Register for service and incident management | Aim to submit (not mandatory for Gate 1 review, but advised to complete as early as possible) | |
| Shared sections | Declare your medical device status | Aim to submit (not mandatory for Gate 1 review, but advised to complete as early as possible) | |
| Shared sections | Demonstrate your product meets the core conformance criteria | Aim to submit (not mandatory for Gate 1 review, but advised to complete as early as possible) | |
| Shared sections | Approved Connection Agreement | Onboarding Lead will request the connection agreement | |
| Complete API assurance | GP Connect – Spine Integration Demonstrate technical conformance for the GPC Spine Integration (Gate 1 – Internet Facing Environment) | Complete in full for Gate 1 Submission | |
| Complete API assurance | GP Connect – Access Document Demonstrate technical conformance for the GPC Access Document - FHIR API (Gate 1 – Internet Facing Environment) | Complete in full for Gate 1 Submission |
Approximately 70% of conformance requirements can be met during Gate 1. Evidence from this environment must be submitted to support those requirements.
Progression to the next gate requires sign-off by NHS England SMEs.
For requirements with associated test cases, scripts can be found below: (They will also be detailed in your Digital Onboarding Service application).
-Access Record: Structured (Full Record)
-Spine Integration Test Scripts
- Successful completion of Gate 1
- HSCN connection established
- Consumer system topology decided and INT setup enabled
- PDS compliance achieved
The Integration environment allows full end-to-end testing and validation of GP Connect requirements.
Instructions on how to establish a connection in the Integration environment can be found here: Integration environment Set-up Instructions
Following registration and ASID creation:
- Access is granted to the integration environment.
- Testing continues using a mock Spine Secure Proxy (SSP).
- API requests are validated in a manner that replicates the live environment.
Consumers must have a minimum viable product before entering this stage. If you already have INT access through another NHS England integration, your product can be updated with the relevant GP Connect interactions.
Navigate to:
Environment Access & Onboarding → Environment Access
- Select Add New Application
- Select Integration Test as the environment
- Assign an Application Owner
- Enter an Application Name
- Review details and select Create Application
- Open the new application
- Select Add APIs
- Enable Spine Directory Service (Integration Testing)
| Section | Sub-section | Gate 2 Submission Requirements | Notes |
|---|---|---|---|
| Complete API assurance | GP Connect – Spine Integration Demonstrate technical conformance for the GPC Spine Integration (Gate 2 – Integration Environment) | Complete in full for Gate 2 Submission | |
| Complete API assurance | GP Connect – Access Document Demonstrate technical conformance for the GPC Access Document - FHIR API (Gate 2 – Integration Environment) | Complete in full for Gate 2 Submission |
- Successful completion of Gate 2
- Test data provided by onboarding lead
Gate 3 allows consumers to interact directly with GP Connect providers in provider-provisioned environments that closely reflect live production environments. Testing continues within the INT environment and no additional environment setup is required.
| NHS Number | Patient Name | Date of Birth | GP ODS Code | Notes |
|---|---|---|---|---|
| 944 450 0764 | Ms Orpha Gracie | 13-Aug-56 | J82132 | Test Patient has a Revised Mobile Number |
| 945 006 3869 | Mr Yi Yeh | 24-Jan-06 | J82132 | Configured for 0.7.3 |
| 945 005 6234 | Ms Adelle Gregor | 03-Jul-10 | J82132 | This patient has not consented to share out her data. |
| NHS Number | Patient Name | Date of Birth | GP ODS Code | Notes |
|---|---|---|---|---|
| TBC | TBC | TBC | TBC | TBC |
| TBC | TBC | TBC | TBC | TBC |
| TBC | TBC | TBC | TBC | TBC |
| Section | Sub-Section | Gate 3 Submission Requirement |
|---|---|---|
| Shared Sections | Approved Connection Agreement | Submit for Gate 3 review. The Onboarding Lead will request the Connection Agreement for you. |
| Complete API Assurance | GP Connect – Access Document Demonstrate technical conformance for the GPC Access Document– FHIR API (Gate 3 – Provider Environment) | Complete in full for Gate 3 submission following approval of Gate 2. Integration environment access is required to perform testing. |
You should also ensure that all remaining sections within:
- Check Your Eligibility
- Shared Sections
are completed and approved by this stage.
We are here to support you to develop clinically safe systems in line with your responsibility to achieve the relevant DCB0129 or DCB0160 clinical safety standards.
We host a series of meetings to help you develop clinically safe systems:
- initial meeting
- clinical safety process readiness review meeting
- clinical evaluation of readiness for deployment meeting For more information, see Clinical assurance process details.
Once all application sections have been completed and approved, NHS England's Technical Assurance Team will issue a Technical Conformance Certificate.
This certificate finalises the assurance process and provides approval to deploy your consumer product into Live, subject to:
- A signed Connection Agreement
- A signed National Data Sharing Arrangement