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.
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 ...
In progress
api
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 ...
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 ...
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 ...
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 ...
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 ...
Remove Spine Security Proxy (SSP)
Replace Spine Security Proxy (SSP) with a more point-to-point alternative, with some other form of auth wrap.
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 ...
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.
Make Node.js based API integration examples and ready to run demo sites available to use.
Feedback from Consumer survey highlighted the need for more Node.js based examples to be made available
This is something we often see with other API providers - ...
Under consideration
Make the National Data Opt-out (NDOP) FHIR API available to third parties
Currently the National Data Opt-out (NDOP) FHIR API (https://digital.nhs.uk/developer/api-catalogue/national-data-opt-out-fhir) is only for internal use. This feature ...
Under consideration
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 ...
Under consideration
NHS number card for Apple / Android wallets
Ability to add an NHS card to your Apple or Android wallet. Which would include; name and NHS number.
SCR API: Patient access to summary care records
Please could you consider opening up the Summary Care Record API to patient access?
API for NHS job search
API for NHS job search to appear on local Health & Care careers website
PDS Reference Implementation and Library in C#
We are working on creating a PDS Reference Implementation specifically in C# to help developers integration journey of their software with the PDS API. Please add ...
PDS FHIR API supports capabilities interaction
FHIR R4 includes the capabilities interaction: "Applications SHALL return a resource that describes the functionality of the server end-point." ...
Electronic Prescription Service (EPS) - application restricted nomination update
Dispensing systems have a requirement to update patient nomination, we are trying to move towards an application restricted model for dispensers and at the moment ...
PDS "Get Patient" should support If-None-Match request
GP System regularly poll for changes to the Patient record. Most of the time that PDS Record has no changes.
The PDS FHIR API sends back the "ETag" header when ...
COVID-19 Test Results API
Use this API to access the COVID 19 Test Results for a patient using their NHS Number. Only results that have been matched to an NHS number will be returned. For each ...
PDS search - nicknames
PDS search already copes with phoneme matches such as "Isobel" and "Isabel" and shortened names such as "Rob" for "Robert", but won't match common nicknames such as ...
Message Exchange for Social Care and Health REST API
API for exchange of healthcare data between organisations
Child Protection - Information Sharing (CP-IS) FHIR API
A FHIR-conformant API for accessing child protection information in CP-IS. This would replace parts of the existing HL7 V3 API and would include improved ...
OAuth support for single page 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 ...
Status monitoring
Ability for developers to monitor the status for the platform and APIs
Exemplar API - PDS FHIR API - search & retrieve - integration test
Provide an integration testing environment for the PDS FHIR API - search & retrieve endpoints, including testing authentication with NHS Identity.
FHIR validation service
Provide a service for validating FHIR message payloads. Possibly, this should be part and parcel of API sandboxes (and to some extent it already is).
Make NHS App onboarding easier
Bringing this strategic, high volume service on to digital onboarding.
NHS App API - Allow sending in-app messages larger than 1000 characters in length
The NHS App API currently restricts the length of the body text of in-app messages to 1000 characters. This is proving to be too restrictive for some desired use ...
Ambulance Analytics API
FHIR API for ambulance trusts to submit details of ambulance transfers of care to NHS Digital's DPS system.
This enables analysis of ambulance data and emergency ...
Data Landing Portal metadata API
APIs that would allow Senders, Receivers and Stakeholders (as a new role) to view configuration and submission metadata available in the Data Landing Portal (DLP). ...
Under consideration
API service level documentation
Update our API specifications to include the service level that applies to that API. For example, is the API a "platinum" service which is supported 24x7 or is it ...
HDRUK Integration
Generic API endpoint to automatically submit NHSD metadata for Health Data Research (HDR) UK Innovation Gateway publication.
The Health Data Research Innovation ...
Utilise Android OS for personal device CIS2 Authentication
Permit the functionality of iOS user/authentication for CIS2 to be extended (built out) for Android devices, negating the need for the most expensive form of mobile ...
Facility for people interested in an API to be notified of new releases
Historically it has been difficult to stay informed of API updates, particularly if these were not on TRUD.
It would help if developers could subscribe to an Api ...
Add usage patterns to API-M website
I think it would be useful to add the usage pattern to entries in the API catalogue pages - "open access", "application restricted" and "user restricted" as a ...
API finder / wizard
An addition to the API catalogue that allows you to find the API you need based on the user case you're trying to achieve. For example, you might type "search for a ...
National RBAC role selection UI
Currently, for smartcard users, the Identity Agent will ask the end user to select a role to use for the current session (using the list of nationally-defined roles ...
PDS FHIR API - application-restricted / smartcardless - search match uniqueness
If the application-restricted form of this API were to provide a single result per query, regardless of a multi-match trace scenario, is it possible to provide a ...
e-RS APIs - Book/Schedule an Appointment for a Referral
Addition to the e-RS APIs suite to allow a new booking to be scheduled from a 3rd party system.
PDS FHIR API - exit beta
Get enough user feedback to be sure the PDS FHIR API is "good enough" to be considered a stable service.
API producer analytics
Ability for API producer teams to see analytics on the use of their API.
Help and support - response time SLAs
Define and implement response time service level agreements for responding to support requests.
Test data tool refresh / single sign-on
The test data tool is a little long in the tooth, and also requires a separate account from the developer account, which we have to set up for you (not self service). ...
Developer portal - role specific user journeys
Enhance the developer portal with user journeys for user journeys for specific roles e.g. coder / architect, tester, product owner / BA, security officer, clinical ...
API catalogue - remove obsolete API portals and specifications
Remove obsolete API portals such as those on TRUD and Health Developer Network and redirect them to the new API catalogue. Remove specifications for retired APIs.
Developer guide exemplar - PDS
An online guide containing best practice guidance for developing software that uses the PDS APIs.
Domain model
Build and publish a domain model for NHS Digital APIs that defines a taxonomy for domains and consider how that impacts our API URL namespace. Ties in with feature to ...
Online developer portal
Internet-facing web pages with single starting point and general info on getting started with NHS Digital APIs.
Open source Core Spine including PDS, EPS, SCR and more
In line with the UK Government remit to code in the open, move the Core Spine code base into the open so that people might inspect, contribute to and re-use it for ...
Under consideration