Product Backlog

This product backlog contains the features we're delivering to realise our API management vision. You can comment on features, upvote features, and suggest new features. If your suggestion relates to our e-Referral service then please complete this form instead. To view e-Referral service requests, see here.

NHS number card for Apple / Android wallets

Ability to add an NHS card to your Apple or Android wallet. Which would include; name and NHS number.
Suggested by: Andrew Raynes (19 Mar, '22) Upvoted: 14 Aug, '22 Comments: 0
Under consideration platform platform-phase-3

SCR API: Patient access to summary care records

Please could you consider opening up the Summary Care Record API to patient access?
Suggested by: Antoni Peychev (16 Mar, '22) Upvoted: 07 Feb Comments: 0
Under consideration api scr-fhir-api

API for NHS job search

API for NHS job search to appear on local Health & Care careers website
Suggested by: Tina (20 Jan, '22) Upvoted: 19 Aug, '22 Comments: 0
Under consideration api unknown-api

PDS Reference Implementation and Library in C#

We are working on creating a PDS Reference Implementation specifically in C# to help developers integration journey of their software with the PDS API. Please add ...
Suggested by: Sanjay Champaneria (19 Nov, '21) Upvoted: 05 Feb Comments: 0
In progress api pds-fhir-api

PDS FHIR API supports capabilities interaction

FHIR R4 includes the capabilities interaction: "Applications SHALL return a resource that describes the functionality of the server end-point." ...
Suggested by: Dunmail (12 Nov, '21) Upvoted: 01 Mar, '22 Comments: 0
Under consideration api pds-fhir-api

Organisation Data Service (ODS) API - Search by address

Currently, we can search for an organisation by name and by postcode but not by address. Can you add a search by address feature to the ORD & FHIR versions of the API?
Suggested by: S Path (20 Oct, '21) Upvoted: 13 Jan Comments: 0
Under consideration api ods-api

Electronic Prescription Service (EPS) - application restricted nomination update

Dispensing systems have a requirement to update patient nomination, we are trying to move towards an application restricted model for dispensers and at the moment ...
Suggested by: Toby Moore (31 Aug, '21) Upvoted: 05 Feb Comments: 0
Under consideration api eps-fhir-api

PDS "Get Patient" should support If-None-Match request

GP System regularly poll for changes to the Patient record. Most of the time that PDS Record has no changes. The PDS FHIR API sends back the "ETag" header when ...
Suggested by: Emile Axelrad from Medicus (12 May, '21) Upvoted: 05 Dec, '22 Comments: 0
Under consideration api pds-fhir-api

COVID-19 Test Results API

Use this API to access the COVID 19 Test Results for a patient using their NHS Number. Only results that have been matched to an NHS number will be returned. For each ...
Suggested by: Gareth Dempsey (04 Mar, '21) Upvoted: 01 Jun, '21 Comments: 0

PDS search - nicknames

PDS search already copes with phoneme matches such as "Isobel" and "Isabel" and shortened names such as "Rob" for "Robert", but won't match common nicknames such as ...
Suggested by: Tony Heap (23 Feb, '21) Upvoted: 14 Sep, '22 Comments: 0
Under consideration api pds-fhir-api

Message Exchange for Social Care and Health REST API

API for exchange of healthcare data between organisations
Suggested by: Mike Mcatominey (19 Oct, '20) Upvoted: 27 Jan, '21 Comments: 0
Under consideration api mesh-api

Child Protection - Information Sharing (CP-IS) FHIR API

A FHIR-conformant API for accessing child protection information in CP-IS. This would replace parts of the existing HL7 V3 API and would include improved ...
Suggested by: API Management Team (09 Oct, '20) Upvoted: 12 Dec, '22 Comments: 0
Under consideration api cp-is-api

OAuth support for single page apps

Some of our APIs require the end user to authenticate themselves and/or authorise their software to access them, using the OAuth 2.0 standard. OAuth 2.0 uses ...
Suggested by: API Management Team (12 Aug, '20) Upvoted: 05 Jan, '21 Comments: 0

Status monitoring

Ability for developers to monitor the status for the platform and APIs
Suggested by: API Management Team (11 Jul, '20) Upvoted: 18 Mar, '22 Comments: 0

Exemplar API - PDS FHIR API - search & retrieve - integration test

Provide an integration testing environment for the PDS FHIR API - search & retrieve endpoints, including testing authentication with NHS Identity.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 16 Apr, '21 Comments: 0

FHIR validation service

Provide a service for validating FHIR message payloads. Possibly, this should be part and parcel of API sandboxes (and to some extent it already is).
Suggested by: API Management Team (11 Jul, '20) Upvoted: 28 Jan, '22 Comments: 0

Make NHS App onboarding easier

Bringing this strategic, high volume service on to digital onboarding.
Suggested by: Alex Lord (24 Nov, '22) Upvoted: 13 Jan Comments: 3

NHS App API - Allow sending in-app messages larger than 1000 characters in length

The NHS App API currently restricts the length of the body text of in-app messages to 1000 characters. This is proving to be too restrictive for some desired use ...
Suggested by: Ian Nelson (06 Feb, '21) Upvoted: 06 Feb, '21 Comments: 2

Ambulance Analytics API

FHIR API for ambulance trusts to submit details of ambulance transfers of care to NHS Digital's DPS system. This enables analysis of ambulance data and emergency ...
Suggested by: API Management Team (11 Jul, '20) Upvoted: 04 Sep, '20 Comments: 2

API service level documentation

Update our API specifications to include the service level that applies to that API. For example, is the API a "platinum" service which is supported 24x7 or is it ...
Suggested by: Tony Heap (17 Nov, '21) Upvoted: 28 Feb, '22 Comments: 1

HDRUK Integration

Generic API endpoint to automatically submit NHSD metadata for Health Data Research (HDR) UK Innovation Gateway publication. The Health Data Research Innovation ...
Suggested by: Rachel Brown (12 Oct, '21) Upvoted: 22 Mar, '22 Comments: 1

Utilise Android OS for personal device CIS2 Authentication

Permit the functionality of iOS user/authentication for CIS2 to be extended (built out) for Android devices, negating the need for the most expensive form of mobile ...
Suggested by: Andrew Reavell (22 Jul, '21) Upvoted: 03 Oct, '21 Comments: 1

Facility for people interested in an API to be notified of new releases

Historically it has been difficult to stay informed of API updates, particularly if these were not on TRUD. It would help if developers could subscribe to an Api ...
Suggested by: Afzal Mufti (21 Apr, '21) Upvoted: 17 May, '21 Comments: 1

Add usage patterns to API-M website

I think it would be useful to add the usage pattern to entries in the API catalogue pages - "open access", "application restricted" and "user restricted" as a ...
Suggested by: Danny Ruttle (31 Mar, '21) Upvoted: 17 May, '21 Comments: 1

API finder / wizard

An addition to the API catalogue that allows you to find the API you need based on the user case you're trying to achieve. For example, you might type "search for a ...
Suggested by: API Management Team (12 Mar, '21) Upvoted: 15 Mar, '21 Comments: 1

National RBAC role selection UI

Currently, for smartcard users, the Identity Agent will ask the end user to select a role to use for the current session (using the list of nationally-defined roles ...
Suggested by: API Management Team (16 Nov, '20) Upvoted: 18 Nov, '20 Comments: 1

PDS FHIR API - application-restricted / smartcardless - search match uniqueness

If the application-restricted form of this API were to provide a single result per query, regardless of a multi-match trace scenario, is it possible to provide a ...
Suggested by: JKMCS (14 Oct, '20) Upvoted: 21 Oct, '21 Comments: 1
Under consideration api pds-fhir-api

e-RS APIs - Book/Schedule an Appointment for a Referral

Addition to the e-RS APIs suite to allow a new booking to be scheduled from a 3rd party system.
Suggested by: Simon Hudson (11 Aug, '20) Upvoted: 05 Feb Comments: 1
Planned api e-rs-api

PDS FHIR API - exit beta

Get enough user feedback to be sure the PDS FHIR API is "good enough" to be considered a stable service.
Suggested by: API Management Team (06 Aug, '20) Upvoted: 09 Mar, '21 Comments: 1

API producer analytics

Ability for API producer teams to see analytics on the use of their API.
Suggested by: API Management Team (31 Jul, '20) Upvoted: 29 Jan, '21 Comments: 1

Help and support - response time SLAs

Define and implement response time service level agreements for responding to support requests.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 16 Feb Comments: 1

Test data tool refresh / single sign-on

The test data tool is a little long in the tooth, and also requires a separate account from the developer account, which we have to set up for you (not self service). ...
Suggested by: API Management Team (11 Jul, '20) Upvoted: 28 Oct, '20 Comments: 1

Developer portal - role specific user journeys

Enhance the developer portal with user journeys for user journeys for specific roles e.g. coder / architect, tester, product owner / BA, security officer, clinical ...
Suggested by: API Management Team (11 Jul, '20) Upvoted: 16 Apr, '21 Comments: 1

API catalogue - remove obsolete API portals and specifications

Remove obsolete API portals such as those on TRUD and Health Developer Network and redirect them to the new API catalogue. Remove specifications for retired APIs.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 22 Jan, '21 Comments: 1

Developer guide exemplar - PDS

An online guide containing best practice guidance for developing software that uses the PDS APIs.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 22 Sep, '20 Comments: 1

Domain model

Build and publish a domain model for NHS Digital APIs that defines a taxonomy for domains and consider how that impacts our API URL namespace. Ties in with feature to ...
Suggested by: API Management Team (08 Jul, '20) Upvoted: 04 Dec, '22 Comments: 1

Online developer portal

Internet-facing web pages with single starting point and general info on getting started with NHS Digital APIs.
Suggested by: API Management Team (28 Jun, '20) Upvoted: 10 Nov, '22 Comments: 1

Streamline testing for API consumers in INT

Feedback from multiple teams reiterated the need for more aligned/standardised test data packs and examples can be made available for testing. 1. Need for test ...
Suggested by: APIM Deathstar Team (14 Mar) Upvoted: 2 days ago Comments: 0
Under consideration

Building healthcare software guide for user authentication and authorisation

A guide explaining how to do user authentication and authorisation in healthcare software for the NHS in England, including NHS Care Identity Service 1 & 2, NHS ...
Suggested by: Tony Heap (06 Mar) Upvoted: 09 Mar Comments: 0
Under consideration

Female Genital Mutilation (FGM) API - updates - FHIR R4

Provide a version of the Female Genital Mutilation (FGM) API which allows updates and uses the FHIR R4 standard.
Suggested by: Tony Heap (10 Nov, '22) Upvoted: 15 Dec, '22 Comments: 0
Under consideration api fgm-api

GP Connect Prescriptions Management FHIR

NHS Digital are developing a new set of Patient Facing Service (PFS) APIs to standardise the PFS APIs for New Market Entrants/foundation system suppliers. This work ...
Suggested by: Paul Swinson (09 Nov, '22) Upvoted: 14 Nov, '22 Comments: 0
Under consideration api gp-connect

ODS - correctly-cased organisation names on JSON and FHIR APIs

Currently the name of an organisation that is returned from either ODS API is in all-caps. It would be a lot nice for display purposes if the names were in a ...
Suggested by: Richard Ward (19 Oct, '22) Upvoted: 13 Jan Comments: 0
Under consideration api ods-api

NHS website content API

Migration of content APIs (Health A-Z, Medicines, Mental Health, Live Well, Common Health Questions, Pregnancy, Video from the developer portal ...
Suggested by: Rachel Gibson (05 Oct, '22) Upvoted: 10 Oct, '22 Comments: 0
In progress api NHSuk-content-api

Create a building healthcare software guide for the terminology domain

Create a non-technical guide to building software that deals with the terminology used within the NHS in England.
Suggested by: SACHIN PATHAK (23 Aug, '22) Upvoted: 09 Dec, '22 Comments: 0
In progress make-learning-easier

Make EPS FHIR API onboarding easier - Dispensing POC

EPS is sometimes described as one of our most difficult APIs to onboard. It has been suggested that we could test if it can be made easier via the Digital Onboarding ...
Suggested by: Alex Lord (20 Jun, '22) Upvoted: 25 Nov, '22 Comments: 0

Service Search API

API to find information about NHS services, including lists of NHS organisation types, organisations, and coronavirus (COVID 19) walk-in sites. search for NHS ...
Suggested by: Joe Walker (10 Jun, '22) Upvoted: 02 Sep, '22 Comments: 0
In progress api service-search-api

MESH APIs - services or standards?

We have a number of entries in our API catalogue which are centrally-defined MESH message formats, such as the various Transfer of Care messages - see ...
Suggested by: Tony Heap (04 Mar, '22) Upvoted: 05 Feb Comments: 0
In progress

PDS FHIR API - search exclusion criteria e.g. death

The ability to exclude certain search criteria from results in PDS e.g. exclude PDS records that have a formal death.
Suggested by: Laura (08 Nov, '21) Upvoted: 21 Sep, '22 Comments: 0
Under consideration api pds-fhir-api

Prescription tracker API to expose EPS data

A new version of the FHIR tracker API to allow medication information to be exposed.
Suggested by: Toby Moore (07 Sep, '21) Upvoted: 15 Sep, '21 Comments: 0

GP Registrations Management Information API

Capture Management Information from Foundation Suppliers in order to diagnose the health of GP Registrations that happen via GP2GP or via the PSS, to improve the ...
Suggested by: Alina Balusescu (23 Jul, '21) Upvoted: 27 Jun, '22 Comments: 0