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.

PDS FHIR API - application-restricted / smartcardless access

Enhance the PDS FHIR API so it can be accessed without an authenticated end user present (i.e. without the need for a smartcard) - similar to the way PDS Spine Mini ...
Suggested by: API Management Team (11 Jul, '20) Upvoted: 22 Nov Comments: 12

Smartcard authentication internet-facing

Make it possible to authenticate with a smartcard using NHS Identity on the internet i.e. without needing an HSCN connection.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 25 Nov Comments: 1

NHS App API - Patient Appointments

Allow Hospital Patient appointments to be sent to NHS App. Most hospitals have extensive support for appointment messages (in HL7v2) these can easily be transformed ...
Suggested by: Kevin Mayfield (18 May, '21) Upvoted: 17 Aug Comments: 3
Under consideration api nhs-app-api

Application registration - self-service

Ability for developers to register applications on the API platform and get their credentials - self-service (although manual approval will be required for production ...
Suggested by: API Management Team (11 Jul, '20) Upvoted: 17 Aug Comments: 0

Electronic Prescription Service (EPS) FHIR API - dispensing

Ability to access EPS as a dispenser, including getting prescriptions and updating prescription status.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 22 Nov Comments: 2
In progress api eps-fhir-api

PDS FHIR API - patient access using NHS login

Allow the PDS FHIR API to be accessed by patients. This would require the citizen to have an NHS login account (so they are strongly authenticated) and allow them to ...
Suggested by: API Management Team (11 Jul, '20) Upvoted: 15 Nov Comments: 8

Summary Care Record (SCR) FHIR API - primary care

FHIR-conformant API for creating, adding to, or accessing a patient's Summary Care Record. The first version of this will be for primary care use.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 22 Nov Comments: 6
In progress api scr-fhir-api

PDS FHIR API - birth registration / NHS number allocation

Ability to register a birth using the PDS FHIR API.
Suggested by: API Management Team (21 Oct, '20) Upvoted: 13 Jul Comments: 6
Planned api pds-fhir-api

PDS FHIR API - Including system effective dates

As a trust with local demographic records which are not synchronised with PDS I want to be able to see the system effective date of attributes in the PDS record So ...
Suggested by: Aled Greenhalgh (06 May, '21) Upvoted: 06 Oct Comments: 0
Under consideration api pds-fhir-api

Spine Directory Service (SDS) FHIR API

FHIR-compliant API for accessing the Spine Directory Service (SDS), for example to retrieve details of endpoints for messaging other healthcare systems.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 04 Oct, '21 Comments: 8

Allow the EPS Prescription data 'status' API to be accessed for citizen facing services

Prescription State AWAITING_RELEASE_READY = '0000' TO_BE_DISPENSED = '0001' WITH_DISPENSER = '0002' WITH_DISPENSER_ACTIVE = '0003' EXPIRED = ...
Suggested by: Sagar (06 Sep, '20) Upvoted: 11 Nov Comments: 6
Under consideration api eps-fhir-api eps-tracker-api

Summary Care Record (SCR) FHIR API - other use cases

The first version of our SCR FHIR API is for primary care. If you are interested in other use cases, please let us know your use case by adding a comment to this feature.
Suggested by: API Management Team (27 Jan, '21) Upvoted: 22 Nov Comments: 3
Under consideration api scr-fhir-api

Authorisation - NHS Identity - separate authentication and authorisation model

Currently, the only way to complete authorisation for a user-restricted API is using "combined authentication and authorisation" - authentication with NHS Identity ...
Suggested by: API Management Team (16 Jul, '20) Upvoted: 06 May, '21 Comments: 1

Open ID Connect (OIDC) support on the OAuth server

Currently we use OAuth 2.0 to authorise external software to access APIs for healthcare workers. There is no standard way for external software to get the end user's ...
Suggested by: API Management Team (22 Jul, '20) Upvoted: 02 Sep Comments: 1

PDS FHIR API - current data only / business effective dates

A number of data fields in the PDS FHIR API include a "period" during which the data is effective (in HL7 V3 these were referred to as "business effective dates"). ...
Suggested by: Tony Heap (18 Nov, '21) Upvoted: 21 Sep Comments: 0
Under consideration api pds-fhir-api

Testing - standardised patient data across APIs

When testing integration across multiple APIs, it would be really helpful to have standardised test patients (NHS numbers) across the APIs.
Suggested by: API Management Team (09 Feb, '21) Upvoted: 11 Nov Comments: 7

Onboarding - process re-engineering

Identify process pain points in the onboarding process and re-engineer the process to remove those pain points.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 22 Nov Comments: 5

Self-service signed JWT public key set up

Currently, to set up a public key for signed JWT auth, API consumers need to email API management and ask them to do it. This feature would make it self service, just ...
Suggested by: Tony Heap (15 Mar) Upvoted: yesterday Comments: 1

Eyecare e-Referral Service API standard

An API standard for eyecare referrals. This API standard supports auto-population of digital referral platforms used when referring patients to NHS services from a ...
Suggested by: Tony Heap (22 Sep, '21) Upvoted: 18 Oct, '21 Comments: 2

API platform internet-facing

Make our API platform available on the internet, rather than being only available on the HSCN network.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 20 Jan, '21 Comments: 1

Ability to update nominated pharmacy element in application restricted access mode

For the PDS FHIR API, ability to update nominated pharmacy element in application restricted access mode. Being a fully online pharmacy 24/7 & having a large number ...
Suggested by: Charlotte Brady (29 Jun, '21) Upvoted: 10 Aug Comments: 0
Under consideration api pds-fhir-api

Performance testing capability

Provide something to help API consumers do performance testing. This might be a hosted service or a set of ready-to-go stubs.
Suggested by: API Management Team (26 Jan, '21) Upvoted: 23 Aug Comments: 0
Under consideration make-testing-easier platform

Expose APIs as a GraphQL gateway

It would be amazing if you could query a tree of data, then have role based access control to limit what data is returned based on your identity. This means data can ...
Suggested by: Rich McIntyre (13 Aug, '20) Upvoted: 27 Sep Comments: 4
Under consideration platform

Organisation Data Service (ODS) API

Improved, easier-to-use API for accessing organisation data in ODS via the API platform. Possibly FHIR-compliant.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 02 Sep Comments: 5
Planned api ods-api

PDS FHIR API - Expose person ethnicity

Person data on Spine includes ethnicity. This is not available through PDS FHIR API (or the PDS HL7 v3 API). It is sensitive data and so may be excluded for IG ...
Suggested by: Kate Gill (28 Jan) Upvoted: 22 Mar Comments: 1
Under consideration api pds-fhir-api

Electronic Prescription Service (EPS) FHIR API - prescribing

Ability to access EPS as a prescriber, including creating prescriptions and cancelling prescriptions.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 26 Jul Comments: 5
In progress api eps-fhir-api

Self-service API deployments

Currently, all API deployments have to be done by the API Management central team. This change would allow API producer teams to do their own API deployments at a ...
Suggested by: Tony Heap (03 Nov, '21) Upvoted: 22 Mar Comments: 2

Immunisation History API (COVID and more)

API to allow citizens to get (prove) details of immunisations they have received, such as for COVID-19. For third party apps using NHS login to prove the citizen's ...
Suggested by: API Management Team (17 Mar, '21) Upvoted: 11 Mar Comments: 2

Non-NHS Digital API producer teams

Make the API platform available to non-NHS Digital API producer teams. It's not clear what specific use cases this might be for.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 14 Feb, '21 Comments: 6

Other Spine (Flags, record or other) information exists indicator in PDS API

An addition to the PDS API that indicates if (spine) flags (or other spine information) exists for the current patient. This would allow an organisation to know if ...
Suggested by: Steve Robinson (05 Aug, '20) Upvoted: 28 Jan Comments: 4

Data publications as API feeds

A number of NHS Digital publications are made as CSV, Excel and Power BI dashboards. An examples of the types of publications in question: ...
Suggested by: William Wood (21 Jun) Upvoted: 08 Sep Comments: 1
Under consideration api unknown-api

Single Directory of Service API

Consolidate the numerous directory of service API's into a single service. At present we have DoS for specific areas such as UEC, EPS, eRS, etc.
Suggested by: Kevin Mayfield (05 Feb, '21) Upvoted: 29 Jun Comments: 0
Under consideration api dos-api

Healthcare Professionals API

Healthcare professional information in England can currently be obtained from a number of different sources such as sds ldap API, publicly available csv file and ...
Suggested by: Fahim Mukhtar (24 Aug, '21) Upvoted: 26 Oct Comments: 7
Under consideration api sds-fhir-api

Make swagger/OAS files available

IMHO it would be good to provide developers with open-api/swagger.json documentation to allow the generation of http restful clients using open-api tooling for the ...
Suggested by: Grahame Horner (19 Jan, '21) Upvoted: 13 Jul Comments: 3

Remote signing API

API for signing things remotely, removing the need to developers to build their own signing logic. Primary use case is signing prescriptions. To be used in ...
Suggested by: API Management Team (11 Jul, '20) Upvoted: 17 Oct Comments: 2
In progress api eps-fhir-api

API to convert ASID to ODS code

An API that, given an ASID, provides the corresponding ODS code.
Suggested by: Tony Heap (09 Feb, '21) Upvoted: 10 Feb, '21 Comments: 1
Under consideration api unknown-api

PDS FHIR API - patient registration / NHS number allocation

Ability to register a new patient (not a birth) in PDS through the PDS FHIR API.
Suggested by: API Management Team (21 Oct, '20) Upvoted: 28 Feb Comments: 0
Under consideration api pds-fhir-api

Creation of EBSX02 API endpoint (JSON)

At the moment it's possible to manually download an EBSX02 (daily) spreadsheet, then ingest that into whatever systems. Can you help to cut out the manual ...
Suggested by: Dan Henderson (21 Sep, '20) Upvoted: 17 Aug Comments: 0
Under consideration api e-rs-api

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 Comments: 0

Self-service testing

Ability to access test environments without needing our help.
Suggested by: API Management Team (11 Jul, '20) Upvoted: 16 Apr, '21 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) Upvoted: 15 Nov Comments: 5

e-RS APIs - Rebook/Reschedule an Appointment for a Referral

Addition to the e-RS APIs suite to allow an existing booking to be rescheduled from the provider system. This would need to book the new slot and then release the ...
Suggested by: A.Browning (06 Aug, '20) Upvoted: 20 Jan Comments: 4
Under consideration api e-rs-api

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 Comments: 3

Make MESH API onboarding easier

The MESH API is a relatively high volume onboarding journey. We should digitise the onboarding process.
Suggested by: Alex Lord (20 Jun) Upvoted: 13 Oct Comments: 2

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) Upvoted: 11 Jan Comments: 2

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 Comments: 2
In progress api pds-fhir-api

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

Electronic Prescription Service Tracker API - enable detailed medicines view

The current Electronic Prescription Service (EPS) Tracker API supports a basic search on the status of the prescription. The proposal is to develop the facility to ...
Suggested by: Katharine Smith (25 Nov, '20) Upvoted: 14 Aug Comments: 2
Under consideration api eps-tracker-api