Skip to main content

Development scenarios

We have provided two development or deployment scenarios to describe the assurance process and how to complete the TOM. 

1. New supplier with no end user organisation

Acme Online are developing a new online application providing clinical workflow management for health care professionals, they would like to compare the local demographics (Patient Name, DOB, NHS Number, Address, Sex, Registered GP) with the NHS Digital Demographics system, and provide the users with an opportunity to update locally held data.

Their intended End User organisations are mainly NHS acute healthcare trusts. Currently they have no firm End Users, but are confident they have a viable product and would like to progress development. Acme Online are aware they need to be assured by NHS Digital, and would like to understand the process.


The key point with this scenario is that the Supplier currently has no immediate End User organisation. The aim is to support the development of the product to a phase that NHS Digital can technically assure the solution and validate their proposed use case. Once Acme Online have found an End User, the assurance process will be formally completed with the TOM being updated.Assessment

How this scenario develops

The Acme Online developer can use this site to understand how to develop against the SMSP API. The getting started page (and Quickstart Steps 1-4) will allow a developer with suitable environment access to very quickly connect to the SMSP API and start testing using the test data provided. In parallel Acme Online can submit a partially completed TOM (Phase 1 Usage and Setting) to NHS Digital, who will provide an initial view on the acceptability of the user case.

The developer will be able to use the test tools for local only development, and online environments available, via N3/HSCN  or Non-N3/HSCN connections. In this case Acme Online have no N3/HSCN access, so have chosen to use the Opentest environment.

Once the developer has understood the initial requirements to call the SMSP API, they will need to understand the web service interface behaviour requirements (error handling, exceptions, vocabs), and the wider foundation and demographics functional requirements. These requirements cover such things as IG, Audit, Demographics specific.

The developer will work to the point that the solution has implemented the following:

  • SMSP web service interface behaviours
  • the demographics functional requirements
  • the foundation functional requirements

Acme Online will provide two artefacts to NHS Digital:

  • Acme Online will test the developed interface against the Auto test manager Test Tool. This tool provides a suite of automated tests, which generate evidence for submission to NHS Digital.
  • At the same time Acme Online will complete the ITK supplier certified requirements spreadsheet for submission to NHS Digital.

Assuming technical tests have passed, the next step is for Acme Online to connect into a Path-to-Live (PTL) environment. This step provides value to Acme Online as they will learn the endpoint registration steps and pipe-clean their network connection, important steps prior to going live.

Once successfully connected to the PTL environment Acme Online will be asked to performed some limited positive testing (note: the interface behaviour has been tested against TKW at step 5).

End of technical conformance.

In parallel to the technical work Acme Online will complete and submit a TOM to NHS Digital. 


2. New supplier with an end user organisation

Acme Apps have developed in conjunction with a local care organisation a new mobile application for pre-op assessments. The pre-op form is completed by a healthcare professional along with the patient. The supplier would like the application to link into the NHS Digital demographics service. Acme Apps are aware they need to be assured by NHS Digital, and would like to understand the process.


This scenario involves both a supplier and End Use organisation (typically a care organisation), meaning the assurance can progress all the way to a live deployment (assuming the usage and settings is accepted by NHS Digital).

How this scenario develops

Acme Apps (in conjunction with their end user) will complete and submit to NHS Digital phase 1a sections of the TOM. The information in Phase 1a provides details of the usage and settings of the proposed service, sufficient to allow the demographics programme  to assess the application and approve or reject (with details).

The technical development, test and assurance steps are exactly the same as scenario 1.

Once technically assured and a fully completed TOM (phase 1 and 2) has been submitted and approved, and the End User has provided explicit acceptance of the client, the solution will move into live deployment.

Further information

  1. internal


    The Spine mini service capabilities are to make it an ITK compliant web service and an ITK complaint demographics service.

  2. internal

    Compliance process

    Explains the compliance process to connect PDS through the SMSP for usage, settings, technical conformance and user approval.

  3. internal

    Stage 1: Getting started quick start

    Enables a developer to become familiar with a typical journey that they will take to develop and deploy their solution in a live care setting.

Last edited: 3 July 2019 2:31 pm