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.
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.
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
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
Deprecation of Digital Maternity API standards
Deprecation of Digital Maternity API standards - we discourage their use for new applications.
Under consideration
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, ...
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.
In progress
CaaS Cohort Definition Management 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 ...
In progress
CaaS Published Cohort Definitions 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 ...
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 ...
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 ...
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. ...
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
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. ...
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 ...
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
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 ...
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 ...
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
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 ...
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: ...
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 - ...
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 ...
Under consideration
Live chat developer support
Ability to chat to us in real time to get developer support.
Under consideration
NHS Booking and Referral (BaRS) - event subscription and publication API
This is a placeholder - features coming soon
NHS Booking and Referral (BaRS) - endpoint lookup and management API
This is a placeholder - features coming soon
NHS Booking and Referral (BaRS) - booking and service request (orchestration/registry) API
This is a placeholder - features coming soon
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 ...
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 ...
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 ...
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) ...
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.
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
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 ...