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.

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

Vision and roadmap - published

Publish our vision and roadmap so developers can see it and contribute to it.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 11 Jul, '20 Comments: 1

API catalogue - tags, filters and searching

Improve the API catalogue so that APIs are tagged and users can filter by things like domain (demographics, medication etc), technology (REST, FHIR, HL7 V3 etc), type ...
Suggested by: API Management Team (08 Jul, '20) Upvoted: 08 Jul, '20 Comments: 1

Search engine optimisation

Ensure that our API documentation can be found by external and internal search engines.
Suggested by: API Management Team (07 Jul, '20) Upvoted: 07 Jul, '20 Comments: 1

Exemplar legacy API specification - PDS HL7 V3 API

A single page for the PDS HL7 V3 API including summary information and links out to existing documentation.
Suggested by: API Management Team (28 Jun, '20) Upvoted: 28 Jun, '20 Comments: 1

API catalogue - include all existing APIs

Make sure the API catalogue page (https://digital.nhs.uk/developer/api-catalogue) has all existing APIs listed in it.
Suggested by: API Management Team (28 Jun, '20) Upvoted: 28 Jun, '20 Comments: 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

Genomic Test Order Management

The ability to order a new test or track an ongoing test. This would be between an Ordering Entity and a GLH with a Central Broker sat between the two.
Suggested by: Tahir Malik (yesterday) Upvoted: yesterday Comments: 0
Under consideration

Genomic Test Directory

The ability to query tests from the Test Directory based on a pre defined search criteria.
Suggested by: Tahir Malik (yesterday) Upvoted: yesterday Comments: 0
Under consideration

Clarify the dependencies between APIs - where access to one API requires access to other APIs

From the annual survey feedback, we heard that clarifying dependencies between APIs (where access to one also requires access to others) would be an important ...
Suggested by: Mick Schonhut (15 Mar) Upvoted: 15 Mar Comments: 0
Under consideration

Retirement of COVID-19 Medical Exemptions - FHIR API

The COVID-19 Medical Exemptions - FHIR API is now retired and no longer available for use.
Suggested by: Matty Firth (15 Mar) Upvoted: 15 Mar Comments: 0
Under consideration

Make Node.js based API integration examples and ready to run demo sites available to use.

Feedback from Consumer survey highlighted the need for more Node.js based examples to be made available This is something we often see with other API providers - ...
Suggested by: APIM Deathstar Team (14 Mar) Upvoted: 14 Mar Comments: 0
Under consideration

Make the National Data Opt-out (NDOP) FHIR API available to third parties

Currently the National Data Opt-out (NDOP) FHIR API (https://digital.nhs.uk/developer/api-catalogue/national-data-opt-out-fhir) is only for internal use. This feature ...
Suggested by: Tony Heap (13 Mar) Upvoted: 13 Mar Comments: 0
Under consideration

Add onboarding requirements to API specs

Currently, there are a number of integration requirements that you only discover when you start onboarding. It would be better if these were stated upfront in the ...
Suggested by: Tony Heap (13 Mar) Upvoted: 13 Mar Comments: 0
Under consideration

Deprecation of COVID-19 Medical Exemptions - FHIR API

The COVID-19 Medical Exemptions - FHIR API has been deprecated. Do not use for new integrations.
Suggested by: Matty Firth (09 Feb) Upvoted: 09 Feb Comments: 0
In progress

Communications Manager Send API

The Communications Manager Send API will allow services to send requests into the Communications Manager solution so that messages can be sent to their intended ...
Suggested by: Tom Hattersley (16 Jan) Upvoted: 16 Jan Comments: 0
Under consideration

Map for NHS facilities

Having a map of the NHS facilities on the NHS app may help patients who may get lost
Suggested by: Abubakr (09 Jan) Upvoted: 09 Jan Comments: 0
Under consideration

Having hospital canteen menus and pricing online

Adding the ability to add opening times of facilities of hospitals and other places of care on the app along with menus and pricing and location of the facilities on ...
Suggested by: Abubakr (09 Jan) Upvoted: 09 Jan Comments: 0
Under consideration

Having an individualised QR code for every patient

Assigning a personalised QR code for each account would allow many new features to be used. For example, in the future, it could allow patients to use their phones to ...
Suggested by: Abubakr (09 Jan) Upvoted: 09 Jan Comments: 0
Under consideration

Making d-CBT features available on the app

Making digital cognitive behavioural therapy (d-CBT) features on the app may be a good addition. NHS Scotland already has an agreement with Daylight for usage of ...
Suggested by: Abubakr (09 Jan) Upvoted: 09 Jan Comments: 0
Under consideration

Adding smoking and perhaps tracker and digital aids to quit

Adding how many cigarettes/drinks one has had may help in tracking progress and helping to quit. Aids such as 2 minute games or other help and advice might help in ...
Suggested by: Abubakr (09 Jan) Upvoted: 09 Jan Comments: 0
Under consideration

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

Make the Patient Care Aggregator API available to third party patient-facing apps

The Patient Care Aggregator API gives access to a patient's secondary care referrals and bookings. At the moment, it is for internal use only - the sole API consumer ...
Suggested by: Tony Heap (08 Dec, '22) Upvoted: 08 Dec, '22 Comments: 0
Under consideration

Make Reasonable Adjustment Flag API onboarding easier

Please digitise this APIs onboarding journey
Suggested by: Alex Lord (24 Nov, '22) Upvoted: 24 Nov, '22 Comments: 0

Make GP Registrations Enhanced Management Information API onboarding easier

Digitise the onboarding for this API
Suggested by: Alex Lord (24 Nov, '22) Upvoted: 24 Nov, '22 Comments: 0

Deprecation of Digital Maternity API standards

Deprecation of Digital Maternity API standards - we discourage their use for new applications.
Suggested by: Matty Firth (24 Nov, '22) Upvoted: 24 Nov, '22 Comments: 0
Under consideration

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

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

Deprecation of Out of hours message integration

The Out of hours message integration has been deprecated - it is still available and service levels still apply, but we plan to retire it at some point. Consumers ...
Suggested by: Matty Firth (12 Oct, '22) Upvoted: 12 Oct, '22 Comments: 0
Done

PDS FHIR API - support for UPRN instead of PAF in address lookups currently, the PDS FHIR API suppor

Replace PAF with UPRN support, the recommended address lookup API now supports OS Places. References ...
Suggested by: Grant Bishop (30 Sep, '22) Upvoted: 30 Sep, '22 Comments: 0
Done

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

Digitise the Summary Care Record (SCR) FHIR API onboarding experience

Bring a digitised journey to the SCR FHIR API onboarding https://digital.nhs.uk/developer/api-catalogue/summary-care-record-fhir
Suggested by: Alex Lord (22 Jun, '22) Upvoted: 22 Jun, '22 Comments: 0

Make NHS login onboarding easier

NHS login has been a much requested capability build from NHS digital. Given it is a new service, we have decided it could be built from day one with a digital ...
Suggested by: Alex Lord (20 Jun, '22) Upvoted: 20 Jun, '22 Comments: 0

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

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

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

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