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.
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 ...
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.
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.
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 ...
Tile layout for the API catalogue
The API catalogue (https://digital.nhs.uk/developer/api-catalogue) is a big long alphabetical list. The old Health Developer Network had a nicer tile layout (see ...
Not planned
Visitors and Migrants FHIR API
We are considering deprecating and eventually retiring the Visitor and Migrant FHIR API as this was never built and has not been applied to any product in the ...
Done
api
Sample code for encode and sign a jwt with rsa512 in c#
please provide a sample code for encode and sign a jwt with rsa512 in c#
Retire General Practice Extraction Service - HL7 V3 API
The General Practice Extraction Service - HL7 V3 API is obsolete and unused and we are considering retiring it. It has been replaced by the General Practice ...
Retire Outpatients HL7 V3 API
The Outpatients HL7 V3 API is obsolete and unused and we are considering retiring it.
Retire Discharge HL7 V3 API
The Discharge HL7 V3 API is obsolete and unused and we are considering retiring it.
Retire Emergency Department HL7 V3 API
The Emergency Department HL7 V3 API is obsolete and unused and we are considering retiring it.
Retire Ambulance Messaging HL7 V3 API
The Ambulance Messaging HL7 V3 API is obsolete and unused and we are considering retiring it.
NHS App API - allow push notification content to include the message sender name
The NHS App API offers an endpoint that allows the sending of an in-app message with an associated push notification. ...
NHS App - include EPS Medications (EPS FHIR RESTful API)
The NHS Digital EPS Service acts as a prescription tracker and has real time information on both prescriptions and fulfilment of these prescription orders ...
PDS FHIR API - exit information
Include Exit information in the retrieve so that we can identify who has left the NHS. This is included in the HL7 v3 MIM and required to complete migration
PDS FHIR API - synchronous responses
Enable the PDS FHIR API to perform updates synchronously, as an alternative to the existing asynchronous/polling design.
We are interested in what use cases are ...
Done
pds-fhir-api
NHS App API
An API that allows healthcare providers to engage with NHS App users. The first use case is sending in-app messages and notifications to patients via the NHS App.
COVID-19 risk stratification API
Not planned
api
API platform - enhanced service levels
Currently the API platform is a "bronze" service - it is available 24x7 but only supported during office hours, so out of-hours incidents might not be resolved until ...
Consistent endpoint discovery
A consistent method for discovering endpoints across all our API technologies - MESH, SSP etc
Help and support - process / training / culture
Work to instil a greater sense of a developer-centric support ethic within delivery teams.
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.
Help and support - email
Email address for developers to contact the API Management team for help and support.
Help and support - self-service guidance
On the help and support page, include details of how developers can help themselves, for example links to tutorials.
API design guide and process for API producer teams
A design guide for our API producer teams, backed up by a design review process, that will help ensure consistency across APIs.