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.
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 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 ...
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 ...
PDS FHIR API - match rate analytics
Analytics on match rates for PDS search so we can react if match rates are low and also track progress when we tweak or search algorithm.
This is probably ...
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 ...
Other developer guides
As part of our vision to make learning easier, we want to produce a number of "developer guides" - on this page: ...
OAuth support for installed apps
Some of our APIs require the end user to authenticate themselves and/or authorise their software to access them, using the OAuth 2.0 standard. OAuth 2.0 uses ...
API producer guidance
Provide guidance for API producer teams on how to come onboard, how the tech works, how to do documentation, what path-to-live environments are available etc.
Developer portal - improve information architecture
There are numerous dead-ends on the NHS Digital website, for example if I find a service in the "services" area, it doesn't always link through to the relevant API ...
NHS 111 Online
Request for NHS 111 online -
This is a brief description of the request.
Toxic ingestion calls and dental calls to have more information on overdose that is ...
Suggested by:
Dean Booker
(01 Oct, '21)
•
Comments: 3
Not planned
api
Medicines use over time
I have developed a Prescribing Data Analysis app for my work over the past 18 months. This app uses the English Prescribing Dataset (NHS BSA) and Patient data (NHS ...
Suggested by:
Stewart Palmer
(23 Dec, '22)
•
Comments: 1
Under consideration