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

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: 23 Mar Comments: 0
Under consideration api ods-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

Exemplar API - PDS FHIR API - authentication for healthcare professionals using NHS Identity

Allow the PDS FHIR API to be accessed by healthcare professionals by authenticating with NHS Identity - using a smartcard or more modern alternative.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 19 Feb, '21 Comments: 0

Align FHIR versions in PDS FHIR API

The PDS FHIR API (R4) makes direct references to the FHIR ODS (STU3) API. It is not permitted within FHIR to mix versions of FHIR. This should be addressed - ...
Suggested by: Richard Kavanagh (16 Aug, '20) Upvoted: 22 Dec, '21 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

NHS App API - default the push notification URL to the messaging inbox when sending by both channels

Suggestion received from Glen Robson @ Enigma Interactive on 23 Nov 2020: "If we want to link the push notification with a message (by sending both in the same ...
Suggested by: Ian Nelson (09 Dec, '20) Upvoted: 10 Dec, '20 Comments: 1

PDS FHIR API - gender free search

Currently, a non-fuzzy search on the PDS FHIR API requires the calling application to specify the patient's gender. This causes issues with (a) asking citizens to ...
Suggested by: API Management Team (11 Nov, '20) Upvoted: 29 Jan, '21 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

Hello World API and tutorials

Example "Hello World" API for developers to play with, including endpoints that are open access, application-restricted and user-restricted. Tutorial explaining how ...
Suggested by: API Management Team (11 Jul, '20) Upvoted: 29 Apr, '22 Comments: 1

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

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

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

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

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

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

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

Update Record API (MVP) - new method to update patient record with structured data

An API that enables the GP Patient record to be updated with structured data. Initially this will be for Encounter, Observation and Medicines for the Pharmacy First ...
Suggested by: [email protected] (16 May) Upvoted: 10 Jun Comments: 0
In progress api

Immunisation FHIR API

The creation of a centralised API immunisation events is part of a wider strategic piece to share and record data in real time. This allows health care workers to ...
Suggested by: Tom Burnett (15 Dec, '22) Upvoted: 15 Aug Comments: 0

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 User Permissions

Specifying a new API which allows the NHS App and other patient facing services to integrate more easily with GP Systems, specifically around user permissions for ...
Suggested by: Mohammad Ramzan (08 Nov, '22) Upvoted: 27 Jul Comments: 0
In progress api gp-connect

NHS website content API

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

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

Allow PDS Updates in Application-Restricted mode

For a GP system, being able to send PDS Updates in Application-Restricted mode would allow these use cases to be handled nicely: 1. The update of patient demographic ...
Suggested by: Emile Axelrad from Medicus (09 May, '21) Upvoted: 15 Jun, '22 Comments: 0
Under consideration api pds-fhir-api

PDS FHIR API - match rate analytics

Analytics on match rates for PDS search so we can react if match rates are low and also track progress when we tweak or search algorithm. This is probably ...
Suggested by: API Management Team (09 Feb, '21) Upvoted: 29 Jun Comments: 0
Under consideration api pds-fhir-api

NHS App API - allow a single communication request to send both in-app message and push notification

A common use case of the NHS App API is to send citizens an in-app message, with an associated native push notification alerting the recipient to the existence of ...
Suggested by: Ian Nelson (09 Dec, '20) Upvoted: 17 May, '21 Comments: 0

NHS App API - provide endpoints based upon HL7 FHIR R4

The current Communication endpoint in the NHS App API is non-FHIR. Transition to providing only endpoints that are based on HL7 FHIR R4. Endpoints for creating ...
Suggested by: Ian Nelson (09 Dec, '20) Upvoted: 17 May, '21 Comments: 0

PDS FHIR API supports Patient/$match operation

PDS FHIR API supports Patient $match operation (http://hl7.org/fhir/R4/patient.html#match) so that it is consistent with other MPIs
Suggested by: Dunmail (01 Dec, '20) Upvoted: 18 May, '21 Comments: 0
Under consideration api pds-fhir-api

PDS FHIR API - R4 UK Core

At the moment PDS FHIR API seems to be STU3 , this breaks expectations for implementations that want to adopt UKCore R4 FHIR specification.
Suggested by: Ravi Natarajan (01 Dec, '22) Upvoted: 01 Dec, '22 Comments: 3
Not planned api pds-fhir-api

Deprecate / retire the Query Accredited System Interface (QASI) API

We are considering deprecating and retiring the Query Accredited System Interface (QASI) API, now that the SDS FHIR API has equivalent functionality.
Suggested by: Tony Heap (06 Oct, '21) Upvoted: 06 Oct, '21 Comments: 3
Under consideration api deprecation-retirement qasi-api

Address Finder (Gazetteer) RESTful API

RESTful JSON API to validate or retrieve UK-based postal addresses. Enhancement to existing Gazetteer SOAP API: ...
Suggested by: Fahim Mukhtar (14 May, '21) Upvoted: 14 May, '21 Comments: 3
Not planned api

Exemplar API - PDS FHIR API - update

Enhance the PDS FHIR API to allow patient records to be updated.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 11 Jul, '20 Comments: 3

NHS App API - Elective Waiting List

An API to deliver waiting list data to the NHS App via the Wayfinder aggregator. This will provide data on the point at which a patient was added to a waiting list.
Suggested by: Jordan Azam (09 May) Upvoted: 09 May Comments: 2

Police Missing Person Search

There would be significant efficiency benefits to Police having the ability to search a missing persons name against hospital admissions. This would save Police ...
Suggested by: Colin (22 Nov, '21) Upvoted: 22 Nov, '21 Comments: 2
Under consideration api