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.
Update Record API (MVP) - new method to update patient record with structured data
An API that enables the GP Patient record to be updated with structured data. Initially this will be for Encounter, Observation and Medicines for the Pharmacy First ...
In progress
api
Include Python Tutorials for NHS APIs
Include Python tutorials in the Developer Tutorials: https://digital.nhs.uk/developer/guides-and-documentation/tutorials
Under consideration
Clarify the dependencies between APIs - where access to one API requires access to other APIs
From the annual survey feedback, we heard that clarifying dependencies between APIs (where access to one also requires access to others) would be an important ...
Under consideration
Streamline testing for API consumers in INT
Feedback from multiple teams reiterated the need for more aligned/standardised test data packs and examples can be made available for testing.
1. Need for test ...
Under consideration
Add onboarding requirements to API specs
Currently, there are a number of integration requirements that you only discover when you start onboarding. It would be better if these were stated upfront in the ...
Under consideration
Immunisation FHIR API
The creation of a centralised API immunisation events is part of a wider strategic piece to share and record data in real time. This allows health care workers to ...
Make the Patient Care Aggregator API available to third party patient-facing apps
The Patient Care Aggregator API gives access to a patient's secondary care referrals and bookings. At the moment, it is for internal use only - the sole API consumer ...
Under consideration
Female Genital Mutilation (FGM) API - updates - FHIR R4
Provide a version of the Female Genital Mutilation (FGM) API which allows updates and uses the FHIR R4 standard.
GP Connect User Permissions
Specifying a new API which allows the NHS App and other patient facing services to integrate more easily with GP Systems, specifically around user permissions for ...
NHS website content API
Migration of content APIs (Health A-Z, Medicines, Mental Health, Live Well, Common Health Questions, Pregnancy from the NHS.uk developer portal (developer.api.nhs.uk) ...
Create a building healthcare software guide for the terminology domain
Create a non-technical guide to building software that deals with the terminology used within the NHS in England.
In progress
make-learning-easier
Make NHS login onboarding easier
NHS login has been a much requested capability build from NHS digital.
Given it is a new service, we have decided it could be built from day one with a digital ...
Make EPS FHIR API onboarding easier - Dispensing POC
EPS is sometimes described as one of our most difficult APIs to onboard. It has been suggested that we could test if it can be made easier via the Digital Onboarding ...
MESH APIs - services or standards?
We have a number of entries in our API catalogue which are centrally-defined MESH message formats, such as the various Transfer of Care messages - see ...
In progress
PDS FHIR API - search exclusion criteria e.g. death
The ability to exclude certain search criteria from results in PDS e.g. exclude PDS records that have a formal death.
Prescription tracker API to expose EPS data
A new version of the FHIR tracker API to allow medication information to be exposed.
GP Registrations Management Information API
Capture Management Information from Foundation Suppliers in order to diagnose the health of GP Registrations that happen via GP2GP or via the PSS, to improve the ...
Allow PDS Updates in Application-Restricted mode
For a GP system, being able to send PDS Updates in Application-Restricted mode would allow these use cases to be handled nicely:
1. The update of patient demographic ...
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 ...
App store / marketplace (FHIR?)
Create a place where external developers can publish their apps for all to see, for example like Smart on FHIR (https://apps.smarthealthit.org/)
NHS App API - allow a single communication request to send both in-app message and push notification
A common use case of the NHS App API is to send citizens an in-app message, with an associated native push notification alerting the recipient to the existence of ...
NHS App API - provide endpoints based upon HL7 FHIR R4
The current Communication endpoint in the NHS App API is non-FHIR.
Transition to providing only endpoints that are based on HL7 FHIR R4.
Endpoints for creating ...
PDS FHIR API supports Patient/$match operation
PDS FHIR API supports Patient $match operation (http://hl7.org/fhir/R4/patient.html#match) so that it is consistent with other MPIs
API platform in the cloud
Implement "cloud first" policy by hosting the API platform in the cloud, including sandboxes.
Developer-facing analytics
Ability for developers to view analytic data for API traffic from their applications.
Merging developer accounts
Allow merging of developer profiles and company accounts within digital onboarding.
Under consideration
PDS FHIR API - R4 UK Core
At the moment PDS FHIR API seems to be STU3 , this breaks expectations for implementations that want to adopt UKCore R4 FHIR specification.
SDS FHIR API POSTMAN Collection
Can we create a working postman bundle for the API against internet facing development environment? It would help supplier / app developer community a lot for their ...
Under consideration
Deprecate / retire the Query Accredited System Interface (QASI) API
We are considering deprecating and retiring the Query Accredited System Interface (QASI) API, now that the SDS FHIR API has equivalent functionality.
Address Finder (Gazetteer) RESTful API
RESTful JSON API to validate or retrieve UK-based postal addresses.
Enhancement to existing Gazetteer SOAP API: ...
Not planned
api
Exemplar API - PDS FHIR API - update
Enhance the PDS FHIR API to allow patient records to be updated.
API documentation team capabilities
Changes to NHS Digital team structures to ensure teams have the skills they need to produce consistently good quality documentation.
NHS login - account existence check
It would be very helpful if there was an API endpoint for an authorised relying party to check - prior to user authentication - if a given email address or NHS number ...
Under consideration
NHS App API - Elective Waiting List
An API to deliver waiting list data to the NHS App via the Wayfinder aggregator.
This will provide data on the point at which a patient was added to a waiting list.
Police Missing Person Search
There would be significant efficiency benefits to Police having the ability to search a missing persons name against hospital admissions. This would save Police ...
Under consideration
api
COVID Medical Exemptions API
API to allow citizens to get (prove) details of medical exemptions from being vaccinated they have received, such as for COVID-19. For third party apps using NHS ...
Done
NHS App API - support headings in in-app messages
The subset of markdown supported by NHS App in-app messages does not currently include headings.
For lengthier messages, this makes it impossible for recipients ...
Please review page styling
Please look at styling of page/scaling and minimizing the Try API panel
Not planned
platform
My developer account - strong authentication
Improve the authentication on the developer account to make it stronger e.g. 2-factor authentication, possibly selectively (e.g. to access production credentials).
Tech stack for APIs
Define a standard tech stack for APIs, so API producers don't have to figure it out for themselves.
ERD Dispensing - Pharmacy should be able to trigger message - GP just approved
Using FHIR API
ERD can be triggered from pharmacy when its due so GP will received a work flow notification from pharmacy to GP system. Then GP will review the ...
pds fhir api applicationrest
Under consideration
Retire Legitimate Relationship Service - HL7 V3 API
The Legitimate Relationship Service - HL7 v3 API is deprecated and will soon be retired.
Personal seat 'KEYSEAT'
Im a private individual and have recently designed a small multi purpose seat which can be use for many applications, in or out of the bath/shower. I feel this would ...
Not planned
Deprecate / retire the Assessment Discharge and Withdrawal - FHIR
We are considering deprecating and retiring the Assessment Discharge and Withdrawal - FHIR as:
The standard has now officially been retired.
The product does not ...
Exemplar API - PDS FHIR API - application restricted mode - onboarding - MVP
Allow developers to onboard for the PDS FHIR API - with a minimum viable product process which is well-explained but might still be a bit long-winded.
The scope ...
Exemplar API - PDS FHIR API - healthcare worker access - onboarding - MVP
Allow developers to onboard for the PDS FHIR API - with a minimum viable product process which is well-explained but might still be a bit long-winded. The scope would ...
Functionality to indicate what organisation data has changed
When notifcation is received of a changed organisation or site, it would be very useful for the API to somehow indicate to users what element/s of the org/site data ...
Under consideration
PDS Search when using Application Restricted authentication to return more than one result.
When using Application Restricted authentication and performing a patient search using the PDS FHIR API, only one result is ever returned. When using other ...
Deprecate / retire the Gazetteer SOAP API
We are considering deprecating and eventually retiring the Gazetteer SOAP API.
This is in favour of recommending use of the Ordinance Survey OS Places API which ...