Testing processes

Outline a suggested testing approach to aid an Immunisation FHIR® API consumer/provider application in the completion of the assurance criteria of the Digital Onboarding process (DOS Process)

Aims and outcomes

Aim:

outline a suggested testing approach to aid an Immunisation FHIR API consumer/provider application in the completion of the assurance criteria of the Digital Onboarding process (DOS Process)

Outcome:

to create communication and testing support channels between NHS England assurance lead and the Immunisation API consumer/provider application
to enable you to successfully assure your connecting system with the Immunisation FHIR API

Supplier testing approach

Testing process	Comments	Engagement
Documentation checklist and review	API Catalogue: Immunisation FHIR API Catalogue v5 Data specification Validation rule specification Digital onboarding process: DOS Onboarding	Connecting system internal assurance
Supplier testing approach review	To enable the connecting system to engage with the NHS England assurance lead with the aim of discussing and reviewing the proposed test and assurance approach. NHS England assurance can assist with the testing approach, processes, scenarios and test data requirements. This will provide an opportunity to discuss and review any connecting system risks (further to the risks outlined in DOS) and proposed mitigations via testing.	Connecting system → NHS England Connecting system test Approach review Test data requests
Sandbox testing	API information on the sandbox can be found in the Immunisation FHIR API.	Connecting system internal assurance
Functional testing of the Immunisation FHIR API	Without using your application, you will have the ability to connect to the integration test environment of the Immunisation FHIR API - using a Postman collection provided by NHS England. The Postman collection can be authenticated with the integration test environment of the Immunisation FHIR API, where you can test each of the endpoints and have the potential to create your own test data within the API. With the immunisation FHIR API Integrating with PDS in the Integration environment, we must use Integration test data for PDS. Test packs are available from NHS England Test Data team. In addition pre-loaded immunisation history data can be created in the API by NHS England. Authentication and Authorisation will be arranged within the Postman collection.	Connecting system internal and NHS England → Connecting system Postman collection PDS test data Immunisation test data
Continuous integration testing of your application	This depends largely on your approach to development and delivery of your product. However standard practice to enable continuous delivery of your application would utilise stubbed endpoints of our API leading to continuous integration testing and automated regression testing.	Connecting system internal assurance
Integrated E2E testing of your application with the Immunisation FHIR API	When you application is integrated with the Immunisation FHIR API in the integration environment we can begin integrated end to end testing. This testing phase has a focus on your applications behaviour in its interaction with the Immunisation FHIR API and its ability to consume and/or provide Immunisation event data. With the focus on data consumption, this will refer to reading and searching immunisation events using the appropriate endpoints and displaying them accurately on your application. Where the focus is on providing data, and in the use case of direct API operations, this will refer to creating, updating, and deleting immunisation events using the appropriate endpoints as triggered by your application, assuring that the events are created successfully and accurately. Where the focus is on providing data, and in the use case of Batch CSV immunisation data, this will refer to use of the batch process and interactions with MESH in order to create update and delete immunisation events. A high level test plan would include test scenario definitions including: API operation testing: reading searching creating updating deleting re-instating Immunisation event data driven test scenarios target disease full and mandatory data PDS patient demographic data driven test scenarios demographic permutations sensitive patient permutations Validation rule operation outcome handling within your application observe a validation error observe a duplication error observe an auth error Observe a patient not found error	Connecting system → NHS England Test plan (test and data scenarios) Test evidence Demonstrations Defect triage
Non-functional testing of your application	The API is performant to an agreed standard of 350 TPS. Excess of this will incur throttling and appropriate erroring that should be handled. It is recommended that you performance, load and soak test your application with a stubbed Immunisation FHIR API response	Connecting system internal assurance
Ready for operation testing	This testing phase takes into consideration day zero and a week in the life of your application interacting with the API post go Live. This is an opportunity to discuss, review and examine the behaviour of data between your application and the Immunisation FHIR API. In addition we must also consider how data migration from the Immunisation History API may affect your application and how the switch over to Immunisation FHIR API can be managed. Consideration of the round trip and flow of data when data may be affected by other sources. Consideration of delays in data availability.	Connecting system → NHS England RFO review and discussion
Digital onboarding process testing	The DOS contains detailed scenarios of what to test and how to demonstrate compliance. Ultimately the assurance sign off relies on successful completion of the DOS providing evidence where required. The testing processes defined here absolutely contribute to the DOS, and in no way should be repeated where the testing has been completed.	Connecting system → NHS England DOS process completion (assurance sections)

Last edited: 8 May 2025 3:43 pm