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.

Include "A008 - Retrieve referral worklist" in e-Referral (eRS) Application Restricted API

This development would help us make more use of the available endpoints for retrieving referrals via UBRN and download their attachments as we will be able to ...
Suggested by: Doug Bainbridge (29 Jun, '22) Upvoted: 05 Feb Comments: 0
Under consideration api e-rs-api

DM&D Rest API

There are medicine products are available only in your DM&D browser, also provide same through the rest API, so it can be implemented in software's to get all details.
Suggested by: Sukhchain (09 Mar, '21) Upvoted: 25 Nov, '22 Comments: 0
Under consideration api unknown-api

Strategic Data Collection Service (SDCS) submission API

API to submit data collections to SDCS - https://digital.nhs.uk/services/strategic-data-collection-service-sdcs.
Suggested by: API Management Team (08 Feb, '21) Upvoted: 04 Nov, '21 Comments: 0
Under consideration api sdcs-api

PDS FHIR API - verify NHS Number (cross-check trace)

The PDS FHIR API currently supports search (not using NHS Number) and retrieve (using only NHS Number). Either of these can be used to verify an NHS Number is ...
Suggested by: API Management Team (11 Nov, '20) Upvoted: 21 Oct, '21 Comments: 0
Under consideration api pds-fhir-api

Child Protection - Information Sharing (CP-IS) - additional information

Enhance CP-IS to capture additional information on care events, such as reason for attendance, contact details for the healthcare professional, which specific site, ...
Suggested by: Tony Heap (20 Oct, '20) Upvoted: 11 Feb, '22 Comments: 0
Planned api cp-is-api

Capability to transform between FHIR versions

Provide a mechanism to allow (for example) a FHIR V3 resource to be converted to FHIR V4
Suggested by: Tim Coates (16 Jun, '21) Upvoted: 16 Dec, '21 Comments: 4

Reasonable Adjustment Flag - FHIR API

API for accessing and updating a patient's reasonable adjustment information.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 26 Jan Comments: 3

pds-fhir-api - sort out names

Patient names in the PDS FHIR api usage types do not match our other APIs PDS FHIR API uses the "use value" of "usual" for the official name, however all out other ...
Suggested by: Kate Gill (25 Jan, '22) Upvoted: 31 Jan Comments: 2
Under consideration api pds-fhir-api

Change log / release notes / what's new

Add a change log to the developer hub to provide external developers with updates on (a) what's new on the API platform in general and (b) what's new for a given API. ...
Suggested by: Tony Heap (07 Dec, '21) Upvoted: 17 Jan, '22 Comments: 2

PDS FHIR API - update related persons

Ability to update related persons via the PDS FHIR API
Suggested by: Tony Heap (07 Aug, '20) Upvoted: 11 Apr, '22 Comments: 2
Not planned api pds-fhir-api

GP Connect Appointments Management - Patient-Facing

NHS Digital are developing a new set of Patient Facing Service (PFS) APIs to standardise the PFS APIs for New Market Entrants/ GP foundation system suppliers. This ...
Suggested by: Peter Love (15 Nov, '22) Upvoted: 15 Nov, '22 Comments: 1
In progress api

gRPC support

Please consider creating/supporting contract first API protocols like gRPC; gRPC is more performant over other API protocols and has a contract first approach where ...
Suggested by: Grahame Horner (22 Jan, '21) Upvoted: 05 Jan, '22 Comments: 1

Improve Directory of Services API (REST)

Documentation is rather scarce - no code samples for example. Would love the NHS Developer portal in general to look more like some of the better documentation ...
Suggested by: Matt Bourne (07 Aug, '20) Upvoted: 05 Feb, '21 Comments: 1
Under consideration api dos-api make-learning-easier

Remove Spine Security Proxy (SSP)

Replace Spine Security Proxy (SSP) with a more point-to-point alternative, with some other form of auth wrap.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 20 Aug, '21 Comments: 1
Under consideration api ssp-api

Developer guide exemplar - GP software

An online guide containing best practice guidance for developing GP software, including details of how to use NHS Digital APIs for specific use cases.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 12 Feb, '21 Comments: 1

GP Connect (Patient Facing) Access Record - FHIR API

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: Ramsey Baker (14 Nov, '22) Upvoted: 06 Feb Comments: 0
Under consideration api gp-connect patientfacingservices

Transfer of Care FHIR APIs - Support for End-to-End Testing

We must stand-up GP Foundation IT systems such as EMIS Web and SystmOne long term in the INT environment to support secondary care providers / suppliers with their ...
Suggested by: Michael Moore (10 Nov, '22) Upvoted: yesterday Comments: 0
Under consideration

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

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

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

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

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

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

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

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 NHS.uk 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