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.

Access Control Service - HL7 V3 API is under review for deprecation

The Access Control Service - HL7 V3 API is under review for deprecation. If you are developing a new integration, consider using the Summary Care Record - FHIR API, ...
Suggested by: Matty Firth (31 Oct, '22) Upvoted: 31 Oct, '22 Comments: 0
In progress

Electronic Transmission of Prescription Web Services - SOAP API is under review

We are considering deprecating the ETP Web Services SOAP API. This API is currently under review.
Suggested by: Matty Firth (28 Sep, '22) Upvoted: 28 Sep, '22 Comments: 0
In progress

CaaS Cohort Manager GraphQL API

Cohorting as a Service securely identifies groups of people with shared characteristics from national health data. The results enable tailored direct care to be ...
Suggested by: Darren Hickling (27 Sep, '22) Upvoted: 27 Sep, '22 Comments: 0
In progress

National Record Locator Cloud API

API to provide pointer data to consumers so that they may access documents stored by producers (e.g Ambulance staff "Consumer" access pointer data to Mental health ...
Suggested by: Joe Walker (07 Sep, '22) Upvoted: 07 Sep, '22 Comments: 0
In progress

API / live Data for A&E Services

This would allow both internal and external personnels to monitor on the number of clients/patients waiting at any given time at an A&E department, enabling better ...
Suggested by: Amrol (02 Sep, '22) Upvoted: 06 Sep, '22 Comments: 0
Under consideration

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

Deprecate / retire the Spine Security Broker API

We have deprecated and will ultimately retire the Spine Security Broker API. https://digital.nhs.uk/developer/api-catalogue/spine-security-broker
Suggested by: Matty Firth (09 Aug, '22) Upvoted: 09 Aug, '22 Comments: 0
Planned

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

PDS to add other gazetteer property references e..g UPRN

Currently PDS only adds PAF code to addresses like Home address - but a lot of supplier systems out there use OS Addressbase as it is now free to gov agencies, that ...
Suggested by: Kate Gill (11 Jul, '22) Upvoted: 11 Jul, '22 Comments: 0
Under consideration

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

Publish a list of API consumers / register of healthcare software

It might be useful for people building healthcare software to see which software applications are consuming each of our APIs - this might help them make decisions on ...
Suggested by: Tony Heap (30 May, '22) Upvoted: 30 May, '22 Comments: 0
Under consideration

Spine re-imagined

This is a big one! As suggested by Gary McAllister, could we organise information in a better way, with less focus on GP records and more focus on a set of ...
Suggested by: Tony Heap (26 May, '22) Upvoted: 26 May, '22 Comments: 0
Under consideration

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

Support rendering externalDocs objects in the OpenAPI schema

https://swagger.io/specification/#external-documentation-object can be attached to: the whole specification; operations; schema. For example on the PDS FHIR API ...
Suggested by: Alex Hawdon (11 Jan, '22) Upvoted: 11 Jan, '22 Comments: 0
Under consideration

API Specification - Additional navigation level under Operation

The content under a given operation may be quite lengthy, one example is the "Update patient details" (PATCH /Patient operation) on the PDS FHIR API: ...
Suggested by: Alex Hawdon (11 Jan, '22) Upvoted: 11 Jan, '22 Comments: 0
Under consideration

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

Update ITK2.2 catalogue entry to reflect this is HL7 v2 and v3 messages

https://digital.nhs.uk/developer/api-catalogue/interoperability-toolkit-messaging-hl7-v2-standard - this is not correct. ITK2.2 includes specific messaging domains ...
Suggested by: Kate Gill (09 Dec, '21) Upvoted: 09 Dec, '21 Comments: 0
Under consideration

Live chat developer support

Ability to chat to us in real time to get developer support.
Suggested by: Tony Heap (09 Nov, '21) Upvoted: 09 Nov, '21 Comments: 0
Under consideration

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

Calling application version management

Add an optional field in API requests specifying the software version of the Connecting System. This could be descriptive, such as 'v1.0.5', or an ID such as a GUID ...
Suggested by: Martin Fison (04 May, '21) Upvoted: 04 May, '21 Comments: 0
Under consideration platform platform-phase-3

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

Merge the two oath2 endpoints in the API-M INT environment into a single endpoint

Description: There are two identity services in INT, both using Oauth2: • One identity service “/oauth2” needs to use a smartcard/OIDC and uses NHS Identity to ...
Suggested by: Danny Ruttle (04 Mar, '21) Upvoted: 04 Mar, '21 Comments: 0
Under consideration platform platform-phase-3

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

FHIR policy update

Our FHIR policy hasn't been looked at in a while. The scope of this feature is to revisit it and refresh it, maybe adding further details.
Suggested by: API Management Team (12 Jan, '21) Upvoted: 12 Jan, '21 Comments: 0

Developer / integration guide - Urgent and Emergency care and 111

An online guide containing best practice guidance for integrating urgent and emergency care software with NHS Digital APIs
Suggested by: Katharine (23 Oct, '20) Upvoted: 17 Nov, '20 Comments: 0

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

Other developer guides

As part of our vision to make learning easier, we want to produce a number of "developer guides" - on this page: ...
Suggested by: API Management Team (07 Sep, '20) Upvoted: 07 Sep, '20 Comments: 0
Under consideration platform platform-phase-3

OAuth support for installed 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: 12 Aug, '20 Comments: 0
Under consideration platform platform-phase-3

API producer guidance

Provide guidance for API producer teams on how to come onboard, how the tech works, how to do documentation, what path-to-live environments are available etc.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 11 Jul, '20 Comments: 0

Developer portal - improve information architecture

There are numerous dead-ends on the NHS Digital website, for example if I find a service in the "services" area, it doesn't always link through to the relevant API ...
Suggested by: API Management Team (08 Jul, '20) Upvoted: 08 Jul, '20 Comments: 0

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

Medicines use over time

I have developed a Prescribing Data Analysis app for my work over the past 18 months. This app uses the English Prescribing Dataset (NHS BSA) and Patient data (NHS ...
Suggested by: Stewart Palmer (23 Dec, '22) Comments: 1
Under consideration