Feedback portal

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.

Deprecate / retire the Gazetteer SOAP API

We are considering deprecating and eventually retiring the Gazetteer SOAP API. This is in favour of recommending use of the Ordinance Survey OS Places API which ...

Suggested by: Dave Long (25 Mar, '22) • Upvoted: 25 Mar, '22 • Comments: 1

Planned api deprecation-retirement gazetteer-api

Visitors and Migrants FHIR API

We are considering deprecating and eventually retiring the Visitor and Migrant FHIR API as this was never built and has not been applied to any product in the ...

Suggested by: Avanti (01 Mar, '22) • Upvoted: 01 Mar, '22 • Comments: 1

Done api

Retire General Practice Extraction Service - HL7 V3 API

The General Practice Extraction Service - HL7 V3 API is obsolete and unused and we are considering retiring it. It has been replaced by the General Practice ...

Suggested by: Tony Heap (06 Oct, '21) • Upvoted: 06 Oct, '21 • Comments: 1

Done api deprecation-retirement gpes-hl7-v3-api

Retire Outpatients HL7 V3 API

The Outpatients HL7 V3 API is obsolete and unused and we are considering retiring it.

Suggested by: Tony Heap (06 Oct, '21) • Upvoted: 06 Oct, '21 • Comments: 1

Done api deprecation-retirement

Retire Discharge HL7 V3 API

The Discharge HL7 V3 API is obsolete and unused and we are considering retiring it.

Suggested by: Tony Heap (06 Oct, '21) • Upvoted: 06 Oct, '21 • Comments: 1

Done api deprecation-retirement

Retire Emergency Department HL7 V3 API

The Emergency Department HL7 V3 API is obsolete and unused and we are considering retiring it.

Suggested by: Tony Heap (06 Oct, '21) • Upvoted: 06 Oct, '21 • Comments: 1

Done api deprecation-retirement

Retire Ambulance Messaging HL7 V3 API

The Ambulance Messaging HL7 V3 API is obsolete and unused and we are considering retiring it.

Suggested by: Tony Heap (06 Oct, '21) • Upvoted: 06 Oct, '21 • Comments: 1

Done api deprecation-retirement

NHS App API - allow push notification content to include the message sender name

The NHS App API offers an endpoint that allows the sending of an in-app message with an associated push notification. ...

Suggested by: Ian Nelson (23 Aug, '21) • Upvoted: 23 Aug, '21 • Comments: 1

Under consideration api nhs-app-api

NHS App - include EPS Medications (EPS FHIR RESTful API)

The NHS Digital EPS Service acts as a prescription tracker and has real time information on both prescriptions and fulfilment of these prescription orders ...

Suggested by: Kevin Mayfield (26 May, '21) • Upvoted: 26 May, '21 • Comments: 1

Under consideration api nhs-app-api

PDS FHIR API - exit information

Include Exit information in the retrieve so that we can identify who has left the NHS. This is included in the HL7 v3 MIM and required to complete migration

Suggested by: Mark Reynolds (13 May, '21) • Upvoted: 13 May, '21 • Comments: 1

Under consideration api pds-fhir-api

NHS App API

An API that allows healthcare providers to engage with NHS App users. The first use case is sending in-app messages and notifications to patients via the NHS App.

Suggested by: API Management Team (09 Oct, '20) • Upvoted: 09 Oct, '20 • Comments: 1

Done api nhs-app-api

COVID-19 risk stratification API

Suggested by: API Management Team (06 Aug, '20) • Upvoted: 06 Aug, '20 • Comments: 1

Not planned api

Consistent endpoint discovery

A consistent method for discovering endpoints across all our API technologies - MESH, SSP etc

Suggested by: API Management Team (16 Jul, '20) • Upvoted: 29 Jan, '21 • Comments: 1

In progress api mesh-api platform platform-phase-2

Exemplar API - PDS FHIR API - search & retrieve - sandbox

Build a callable sandbox for the PDS FHIR API search & retrieve endpoints.

Suggested by: API Management Team (11 Jul, '20) • Upvoted: 11 Jul, '20 • Comments: 1

Done api make-design-and-build-easier make-learning-easier pds-fhir-api platform-phase-1

Exemplar API - PDS FHIR API - search & retrieve - specification

API specification for the exemplar API (PDS FHIR API) - search & retrieve endpoints, generated from an OAS file.

Suggested by: API Management Team (28 Jun, '20) • Upvoted: 28 Jun, '20 • Comments: 1

Done api make-learning-easier pds-fhir-api platform-phase-1

Immunisation CRUD API

API to allow access to change read update and delete all immunisation and vaccination information held on national platforms for all vaccinations. This will allow ...

Suggested by: Tom Burnett (15 Dec, '22) • Upvoted: 15 Dec, '22 • Comments: 0

Planned api Immunisation S7A Vaccination

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: 08 Nov, '22 • Comments: 0

In progress api gp-connect

Deprecate / retire the Pathology Messaging - HL7 V3 integration

We are considering deprecating and retiring the Pathology Messaging - HL7 V3 integration. Usage is minimal and will be superseded by another API. ...

Suggested by: SACHIN PATHAK (15 Aug, '22) • Upvoted: 15 Aug, '22 • Comments: 0

Under consideration api deprecation-retirement integration mesh-api

Deprecate / retire the Data Registers Service - REST API

We are considering deprecating and ultimately retiring the Data Registers Service - REST API. Usage is either minimal or it is not being used. ...

Suggested by: Matty Firth (20 Jul, '22) • Upvoted: 20 Jul, '22 • Comments: 0

Under consideration api deprecation-retirement

Deprecate / retire the Pathology Messaging FHIR (STU3) API

We are considering deprecating and retiring the Pathology Messaging FHIR (STU3) API as this API is going to be superseded by Pathology Messaging FHIR (R4) API

Suggested by: Sachin Pathak (07 Jul, '22) • Upvoted: 07 Jul, '22 • Comments: 0

Planned api deprecation-retirement fhir-stu3

Open Access APIs can be digitally onboarded - POC: Health Research Data (HRD) API

Given we have APIs with relatively low barriers to entry - e.g. open access APIs - we should digitise them quickly rather than sit them in a queue behind some of the ...

Suggested by: Alex Lord (20 Jun, '22) • Upvoted: 20 Jun, '22 • Comments: 0

Done api health-research-data-api make-onboarding-easier

Deprecate / retire the NHS Booking API

We are considering deprecating and eventually retiring the NHS Digital API in favour of the NHS Booking and Referral API

Suggested by: Avanti (08 Mar, '22) • Upvoted: 08 Mar, '22 • Comments: 0

Under consideration api deprecation-retirement nhs-booking-api

Patient Care Aggregator

The Patient Care Aggregator will pull together appointment and referral data from Patient Engagement Portal providers and the NHS e-Referrals service. This will be ...

Suggested by: Matt Visser (10 Feb, '22) • Upvoted: 10 Feb, '22 • Comments: 0

Done api patient-care-aggregator-fhir

Dose to Text API

Ability for systems to send a structured dose syntax to an API and in response receive the dosage as a text string as outlined here - ...

Suggested by: Shafique Aksar (23 Dec, '21) • Upvoted: 23 Dec, '21 • Comments: 0

Under consideration api dose-to-text-api

ETP Web Services REST API

A .NET web service that returns a list of pharmacies/dispensers based on name, location or ODS code. This API exists and will be replaced with a newer version.

Suggested by: Kieran Brough (30 Jul, '21) • Upvoted: 30 Jul, '21 • Comments: 0

Done api etp-api

NHS Booking and Referral (BaRS) - event subscription and publication API

This is a placeholder - features coming soon

Suggested by: David Ruddy (21 Jul, '21) • Upvoted: 21 Jul, '21 • Comments: 0

Under consideration api nhs-bookingreferral-event-api

NHS Booking and Referral (BaRS) - endpoint lookup and management API

This is a placeholder - features coming soon

Suggested by: David Ruddy (21 Jul, '21) • Upvoted: 21 Jul, '21 • Comments: 0

Under consideration api nhs-bookingreferral-endpoints

NHS Booking and Referral (BaRS) - booking and service request (orchestration/registry) API

This is a placeholder - features coming soon

Suggested by: David Ruddy (21 Jul, '21) • Upvoted: 21 Jul, '21 • Comments: 0

In progress api nhs-bookingandreferral-basr-ap

PDS FHIR API - limited data returned

The citizen record to be returned could be specified, and limited, when calling the PDS FHIR API. This may help with information governance, and other "only as much ...

Suggested by: Alex Lord (26 Apr, '21) • Upvoted: 26 Apr, '21 • 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: 09 Feb, '21 • Comments: 0

Under consideration api pds-fhir-api

National Record Locater API - standards

As suggested by techUK in their draft ten point plan, the National Record Locater should support key standards such as Integrating the Healthcare Enterprise (IHE) ...

Suggested by: API Management Team (12 Jan, '21) • Upvoted: 12 Jan, '21 • Comments: 0

Under consideration api nrl-api

NHS App API - Allow NHS App API consumers to sign up without providing a Callback URL

API consumers signing up to use the NHS App API at https://portal.developer.nhs.uk/my-apps are forced to enter a dummy Callback URL, despite this information not ...

Suggested by: Ian Nelson (09 Dec, '20) • Upvoted: 09 Dec, '20 • Comments: 0

Done api nhs-app-api

NHS App API - support markdown in the body of in-app messages

Allow rich formatted text within the body of in-app messages by supporting a subset of the markdown, instead of only plain text with linkified URLs.

Suggested by: Ian Nelson (09 Dec, '20) • Upvoted: 09 Dec, '20 • Comments: 0

Done api nhs-app-api

Child Protection - Information Sharing (CP-IS) - scheduled care

Extend the CP-IS service to support scheduled care organisations (currently only for unscheduled care). This includes enhancing alerts to local authorities to state ...

Suggested by: API Management Team (20 Oct, '20) • Upvoted: 20 Oct, '20 • Comments: 0

Planned api cp-is-api

Exemplar API - PDS FHIR API - search & retrieve - onboarding - MVP

Allow developers to onboard for the PDS FHIR API - with a minimum viable product process which is well-explained but might still be a bit long-winded.

Suggested by: API Management Team (11 Jul, '20) • Upvoted: 11 Jul, '20 • Comments: 0

Done api make-onboarding-easier pds-fhir-api platform-phase-1

Exemplar API - PDS FHIR API - FHIR conformance

Make the PDS FHIR API a FHIR-conformant API

Suggested by: API Management Team (11 Jul, '20) • Upvoted: 11 Jul, '20 • Comments: 0

Done api make-design-and-build-easier pds-fhir-api platform-phase-1

Exemplar API - PDS FHIR API - REST conformance

Make the PDS FHIR API a REST conformant API

Suggested by: API Management Team (11 Jul, '20) • Upvoted: 11 Jul, '20 • Comments: 0

Done api make-design-and-build-easier pds-fhir-api platform-phase-1

NHS 111 Online

Request for NHS 111 online - This is a brief description of the request. Toxic ingestion calls and dental calls to have more information on overdose that is ...

Suggested by: Dean Booker (01 Oct, '21) • Comments: 3

Not planned api