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.

Using EPS for Medication Reconciliation

EPS has a store of accurate primary issues and dispensing history. This is currently only exposed via a prescription tracker API, a more general API would enable ...
Suggested by: Kevin Mayfield (06 Aug, '20) Upvoted: 13 Jun, '21 Comments: 0
Under consideration api eps-fhir-api

Role based access control (RBAC) for APIs

Currently, national APIs such as PDS rely on the calling system to implement role-based access controls (RBAC). This in turn increases the assurance burden on ...
Suggested by: API Management Team (05 Aug, '20) Upvoted: 14 Sep, '22 Comments: 0

APIs for the API platform itself

Provide APIs that allow API producers and/or API consumers to perform "platform" functions through an API. This might include API deployment, monitoring, analytics, ...
Suggested by: Tony Heap (10 Nov, '22) Upvoted: 15 Nov, '22 Comments: 5

PDS FHIR API - consent to share information

Enhance the PDS FHIR API to allow retrieval and update of consent to share information.
Suggested by: API Management Team (06 Aug, '20) Upvoted: 17 Dec, '21 Comments: 3
Not planned api pds-fhir-api

API services versus API standards

NHS Digital has two distinct categories of APIs - API services (an actual callable national service) and API standards (a specification that is intended to aid ...
Suggested by: API Management Team (16 Jul, '20) Upvoted: 22 Sep, '22 Comments: 3

Using POST instead of GET for search operations

It has been noticed that both the retrieve and search PDS FHIR APIs expect the search parameters as a query string. This means that private data like name, date of ...
Suggested by: Deepa Sobhana (11 Jan, '22) Upvoted: 11 Jan, '22 Comments: 2

NHS App API - messages containing links to onboarded services should support single sign on (SSO)

In-App messages that are sent containing links to onboarded "silver"/"web" integrated features should be rendered in such a manner that clicking upon them will ...
Suggested by: Ian Nelson (18 Dec, '20) Upvoted: 24 Nov, '21 Comments: 2

Information and training videos

Videos on the developer portal explaining things like how the portal works or tutorials on how to connect to our APIs.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 14 Nov, '22 Comments: 2

API catalogue - existing APIs documented to a minimum standard

Uplift documentation for all existing APIs to a minimum standard, so that external developers can easily learn what the API does, how to use the API, how to test it, ...
Suggested by: API Management Team (11 Jul, '20) Upvoted: 13 May, '22 Comments: 2

Expose a certificate renewal and download API

Every year 100s, if not 1000s of certificate renewals are performed by a human that requires too many manual steps. This is costly to the business, it is error ...
Suggested by: Bryan Madsen (22 Aug, '22) Upvoted: 30 Dec, '22 Comments: 1

Re-usable auth components

Provide auth components that API producer teams can easily plug into their APIs.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 16 Apr, '21 Comments: 1

Create a building healthcare software guide for patient-facing applications

Create a non-technical guide to building software that deals with patient-facing applications within the NHS in England.
Suggested by: Mick (05 Dec, '22) Upvoted: 16 Mar Comments: 0

PDS to proactively tell a GP System when a Patient record is updated

In order to keep the local record up to date in the Synchronisation process, GP Systems have to regularly poll the PDS for "new versions" of their registered ...
Suggested by: Emile Axelrad from Medicus (12 May, '21) Upvoted: 10 May, '22 Comments: 6

PDS - search on contact details

Ability to include contact details such as phone numbers and email addresses in PDS searches
Suggested by: Tony Heap (23 Feb, '21) Upvoted: 08 Nov, '22 Comments: 3
In progress api pds-fhir-api

PDS FHIR API - new API method to identify changed data

We have a general need to verify that personal data is correct and up to date; at present we poll the PDS FHIR API and/or SMSP to identify if data has been updated ...
Suggested by: Grahame Horner (22 Jan, '21) Upvoted: 10 Jan, '22 Comments: 3

My developer account - improved UX

The developer account is based on a product and has UX pain points. The scope of this feature is to refresh it and bring it more into the NHS Digital look & feel to ...
Suggested by: API Management Team (16 Jul, '20) Upvoted: 19 Nov, '20 Comments: 3

Onboarding - digitise

Make the onboarding process more online and more self-service.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 16 Apr, '21 Comments: 3

Create a building healthcare software guide for the workforce domain

Create a non-technical guide to building software that deals with the workforce within the NHS in England. This might include roster management and more general ...
Suggested by: Mick (01 Dec, '22) Upvoted: 05 Mar Comments: 2

User researcher capability

User research is really important for APIs, but API producer teams typically don't have a dedicated UR - perhaps because they don't see the value, perhaps because ...
Suggested by: Tony Heap (10 Nov, '21) Upvoted: 13 Feb, '22 Comments: 2

Deprecate / retire the Personal Demographics Service - Spine Mini Service Provider API

We are considering deprecating and eventually retiring the Personal Demographics Service - Spine Mini Service Provider (PDS SMSP) API. This is because the newer PDS ...
Suggested by: Tony Heap (06 Oct, '21) Upvoted: 04 Jan, '22 Comments: 2

Client libraries and reference implementations

Provide client libraries and / or reference implementations to make it easier for developers to integrate their software with our APIs.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 05 Feb Comments: 2

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

Make the PDS FHIR API available for production use, including the onboarding process.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 16 Oct, '21 Comments: 1

Accessibility - WCAG WAI conformance check

The site is already built largely using WCAG WAI-conformant page templates within the NHS Digital website, but to be sure we need to test conformance and fix any issues.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 13 May, '22 Comments: 1

Create a building healthcare software guide for the vaccinations domain

Create a non-technical guide to building software that deals with vaccinations within the NHS in England.
Suggested by: Mick (01 Dec, '22) Upvoted: 08 Jan Comments: 0

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

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

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

Move the Test Data Self Service Portal (TDSSP) to be internet-facing

Currently to generate PDS Test Data on the Test Data Self Service Portal (TDSSP) it requires a HSCN connection. It would make sense for this service to be available ...
Suggested by: Emile Axelrad from Medicus (20 May, '21) Upvoted: 20 May, '21 Comments: 2

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

Developer forum

Create an open forum where developers can ask questions and answers one another's questions. Curate it.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 25 Nov, '22 Comments: 2

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

Healthcare tech overview / beginner's guide

An overview of healthcare tech in the NHS in England, including topics like local systems, national systems, integration, APIs, privacy and security, clinical safety ...
Suggested by: Tony Heap (08 May, '21) Upvoted: 17 May, '21 Comments: 1

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

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

API specifications - improved look & feel

The MVP API specification page has a number of UX pain points and doesn't fit the NHS Digital brand and styling. This feature is to refresh is and bring it more into ...
Suggested by: Tony Heap (16 Jul, '20) Upvoted: 17 Sep, '20 Comments: 1

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

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