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.
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 ...
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 ...
Make MESH API onboarding easier
The MESH API is a relatively high volume onboarding journey. We should digitise the onboarding process.
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 ...
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 ...
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 ...
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 ...
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, ...
Reasonable Adjustment Flag - FHIR API
API for accessing and updating a patient's reasonable adjustment information.
PDS FHIR API - consent to share information
Enhance the PDS FHIR API to allow retrieval and update of consent to share information.
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 ...
Create a building healthcare software guide for the workforce domain
Create a non-technical guide to building software that deals with the workforce within the NHS in England.
This might include roster management and more general ...
ODS - correctly-cased organisation names on JSON and FHIR APIs
Currently the name of an organisation that is returned from either ODS API is in all-caps. It would be a lot nice for display purposes if the names were in a ...
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 ...
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 ...
Information and training videos
Videos on the developer portal explaining things like how the portal works or tutorials on how to connect to our APIs.
API catalogue - existing APIs documented to a minimum standard
Uplift documentation for all existing APIs to a minimum standard, so that external developers can easily learn what the API does, how to use the API, how to test it, ...
Expose a certificate renewal and download API
Every year 100s, if not 1000s of certificate renewals are performed by a human that requires too many manual steps.
This is costly to the business, it is error ...
Re-usable auth components
Provide auth components that API producer teams can easily plug into their APIs.
Explain how long onboarding will take
It may be useful if I were able to find out how long it takes to go through the compliance/assurance and onboarding processes for the NHS APIs.
Under consideration
GP Connect (Patient Facing) Access Record - 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 ...
Service Search API
API to find information about NHS services, including lists of NHS organisation types, organisations, and coronavirus (COVID 19) walk-in sites.
search for NHS ...
DM&D Rest API
There are medicine products are available only in your DM&D browser, also provide same through the rest API, so it can be implemented in software's to get all details.
Strategic Data Collection Service (SDCS) submission API
API to submit data collections to SDCS - https://digital.nhs.uk/services/strategic-data-collection-service-sdcs.
PDS to proactively tell a GP System when a Patient record is updated
In order to keep the local record up to date in the Synchronisation process, GP Systems have to regularly poll the PDS for "new versions" of their registered ...
Communications Manager API
The Communications Manager API will allow services to send requests into the Communications Manager solution so that messages can be sent to their intended ...
In progress
PDS - search on contact details
Ability to include contact details such as phone numbers and email addresses in PDS searches
PDS FHIR API - new API method to identify changed data
We have a general need to verify that personal data is correct and up to date; at present we poll the PDS FHIR API and/or SMSP to identify if data has been updated ...
My developer account - improved UX
The developer account is based on a product and has UX pain points. The scope of this feature is to refresh it and bring it more into the NHS Digital look & feel to ...
Onboarding - digitise
Make the onboarding process more online and more self-service.
pds-fhir-api - sort out names
Patient names in the PDS FHIR api usage types do not match our other APIs
PDS FHIR API uses the "use value" of "usual" for the official name, however all out other ...
User researcher capability
User research is really important for APIs, but API producer teams typically don't have a dedicated UR - perhaps because they don't see the value, perhaps because ...
Deprecate / retire the Personal Demographics Service - Spine Mini Service Provider API
We are considering deprecating and eventually retiring the Personal Demographics Service - Spine Mini Service Provider (PDS SMSP) API. This is because the newer PDS ...
Client libraries and reference implementations
Provide client libraries and / or reference implementations to make it easier for developers to integrate their software with our APIs.
Removing Test or Legacy products from DOS
The ability for developers or Onboarding leads to remove a product from DOS - this is currently unavailable and many APIs have 'Test' products listed that are ...
In progress
make-onboarding-easier
Healthcare tech overview / beginner's guide
An overview of healthcare tech in the NHS in England, including topics like local systems, national systems, integration, APIs, privacy and security, clinical safety ...
Exemplar API - PDS FHIR API - search & retrieve - production
Make the PDS FHIR API available for production use, including the onboarding process.
Create a building healthcare software guide for the vaccinations domain
Create a non-technical guide to building software that deals with vaccinations within the NHS in England.
GP Connect Prescriptions Management FHIR
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 ...
Include "A008 - Retrieve referral worklist" in e-Referral (eRS) Application Restricted API
This development would help us make more use of the available endpoints for retrieving referrals via UBRN and download their attachments as we will be able to ...
Organisation Data Service (ODS) API - Search by address
Currently, we can search for an organisation by name and by postcode but not by address. Can you add a search by address feature to the ORD & FHIR versions of the API?
PDS FHIR API - verify NHS Number (cross-check trace)
The PDS FHIR API currently supports search (not using NHS Number) and retrieve (using only NHS Number). Either of these can be used to verify an NHS Number is ...
Child Protection - Information Sharing (CP-IS) - additional information
Enhance CP-IS to capture additional information on care events, such as reason for attendance, contact details for the healthcare professional, which specific site, ...
Exemplar API - PDS FHIR API - authentication for healthcare professionals using NHS Identity
Allow the PDS FHIR API to be accessed by healthcare professionals by authenticating with NHS Identity - using a smartcard or more modern alternative.
Capability to transform between FHIR versions
Provide a mechanism to allow (for example) a FHIR V3 resource to be converted to FHIR V4
Change log / release notes / what's new
Add a change log to the developer hub to provide external developers with updates on (a) what's new on the API platform in general and (b) what's new for a given API. ...
Move the Test Data Self Service Portal (TDSSP) to be internet-facing
Currently to generate PDS Test Data on the Test Data Self Service Portal (TDSSP) it requires a HSCN connection. It would make sense for this service to be available ...
Align FHIR versions in PDS FHIR API
The PDS FHIR API (R4) makes direct references to the FHIR ODS (STU3) API. It is not permitted within FHIR to mix versions of FHIR. This should be addressed - ...
PDS FHIR API - update related persons
Ability to update related persons via the PDS FHIR API
Developer forum
Create an open forum where developers can ask questions and answers one another's questions. Curate it.