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.
Tile layout for the API catalogue
The API catalogue (https://digital.nhs.uk/developer/api-catalogue) is a big long alphabetical list. The old Health Developer Network had a nicer tile layout (see ...
Not planned
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 ...
Done
api
Sample code for encode and sign a jwt with rsa512 in c#
please provide a sample code for encode and sign a jwt with rsa512 in c#
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 ...
Retire Outpatients HL7 V3 API
The Outpatients HL7 V3 API is obsolete and unused and we are considering retiring it.
Retire Discharge HL7 V3 API
The Discharge HL7 V3 API is obsolete and unused and we are considering retiring it.
Retire Emergency Department HL7 V3 API
The Emergency Department HL7 V3 API is obsolete and unused and we are considering retiring it.
Retire Ambulance Messaging HL7 V3 API
The Ambulance Messaging HL7 V3 API is obsolete and unused and we are considering retiring it.
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. ...
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 ...
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
PDS FHIR API - synchronous responses
Enable the PDS FHIR API to perform updates synchronously, as an alternative to the existing asynchronous/polling design.
We are interested in what use cases are ...
Done
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.
COVID-19 risk stratification API
Not planned
api
API platform - enhanced service levels
Currently the API platform is a "bronze" service - it is available 24x7 but only supported during office hours, so out of-hours incidents might not be resolved until ...
Consistent endpoint discovery
A consistent method for discovering endpoints across all our API technologies - MESH, SSP etc
Help and support - process / training / culture
Work to instil a greater sense of a developer-centric support ethic within delivery teams.
Help and support - service desk tool integration
Ability for developers to raise service desk tickets online via their developer account and view the status of those tickets.
Help and support - email
Email address for developers to contact the API Management team for help and support.
Help and support - self-service guidance
On the help and support page, include details of how developers can help themselves, for example links to tutorials.
API design guide and process for API producer teams
A design guide for our API producer teams, backed up by a design review process, that will help ensure consistency across APIs.
Exemplar API - PDS FHIR API - search & retrieve - sandbox
Build a callable sandbox for the PDS FHIR API search & retrieve endpoints.
Vision and roadmap - published
Publish our vision and roadmap so developers can see it and contribute to it.
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 ...
Search engine optimisation
Ensure that our API documentation can be found by external and internal search engines.
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.
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.
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.
Diagnostic Imaging API
The National Imaging Registry programme proposes making a patient's diagnostic imaging history discoverable by querying the National Record Locator.
A Diagnostic ...
Under consideration
NHS website Ratings and Reviews API
Migration of the Ratings and Reviews API from the NHS website developer portal onto the NHS Digital API Management platform
Planned
Diagnostic Imaging Report API
The Diagnostic Imaging Report API would focus initially on the radiology domain to enable radiology imaging study reports to be retrieved in a standard format.
No ...
Under consideration
Deprecate Digital Medicine - FHIR
The Digital Medicine - FHIR message integration has been deprecated - this includes the following MESH workflow IDs:
- DIGMED_FLU_VAC
- DIGMED_EMG_MED
You can ...
Under consideration
Structured Summary Care Record API
This API is intended to replace the existing Summary Care Record HL7v3 Interface. The API will orchestrate the API calls (PDS, SDS and Access Strcutured Record via ...
Under consideration
Prescriptions for Patients API
API to provide patients with access to prescriptions sent by the Electronic Prescription Service (EPS).
PDS Notifications FHIR API - Nominated Pharmacy Change Event
Currently if a notification is required when a nominated pharmacy changes then PDS Notifications FHIR API will send a “general record change” event, meaning a ...
Under consideration
Update Record API (Iteration 2)
This is likely to be around a mechanism to enable some updates to notify GP systems an update has been received and allow them to accept / reject that update. This ...
Done
The Data Registers Service - REST API is deprecated
The Data Registers Service - REST API is deprecated. It is still available but is planned for retirement. The proposed retirement date is 1st September 2023.
Done
GP Connect (Patient Facing) User Management - 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 ...
Multicast Notification Service (Event Management) API
Connecting NHSE product teams by providing notifications of patient related state changes in easily consumable formats via data streams and filtered subscriptions ...
In progress
Deprecation of Electronic Prescription Service Directory of Services
This API is under review for deprecation. We will contact all suppliers before agreeing a retirement date.
Under consideration
Genomic Order Comms
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.
Under consideration
Genomic Test Directory
The ability to query tests from the Test Directory based on a pre defined search criteria.
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.
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.
In progress
Map for NHS facilities
Having a map of the NHS facilities on the NHS app may help patients who may get lost
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 ...
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 ...
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 ...
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 ...
Under consideration
Make Reasonable Adjustment Flag API onboarding easier
Please digitise this APIs onboarding journey