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.
Smartcard authentication internet-facing
Make it possible to authenticate with a smartcard using NHS Identity on the internet i.e. without needing an HSCN connection.
PDS FHIR API - application-restricted / smartcardless access
Enhance the PDS FHIR API so it can be accessed without an authenticated end user present (i.e. without the need for a smartcard) - similar to the way PDS Spine Mini ...
Method to retrieve all ERS worklists without smartcard requirement
Could we have a method to download all Appointment Slot Issues and Awaiting Bookings that does not require smartcard access. It would not be restricted to department ...
NHS App API - Patient Appointments
Allow Hospital Patient appointments to be sent to NHS App. Most hospitals have extensive support for appointment messages (in HL7v2) these can easily be transformed ...
Application registration - self-service
Ability for developers to register applications on the API platform and get their credentials - self-service (although manual approval will be required for production ...
Electronic Prescription Service (EPS) FHIR API - dispensing
Ability to access EPS as a dispenser, including getting prescriptions and updating prescription status.
PDS FHIR API - patient access using NHS login
Allow the PDS FHIR API to be accessed by patients. This would require the citizen to have an NHS login account (so they are strongly authenticated) and allow them to ...
Summary Care Record (SCR) FHIR API - primary care
FHIR-conformant API for creating, adding to, or accessing a patient's Summary Care Record. The first version of this will be for primary care use.
PDS FHIR API - birth registration / NHS number allocation
Ability to register a birth using the PDS FHIR API.
Summary Care Record (SCR) FHIR API - other use cases
The first version of our SCR FHIR API is for primary care. If you are interested in other use cases, please let us know your use case by adding a comment to this feature.
Data publications as API feeds
A number of NHS Digital publications are made as CSV, Excel and Power BI dashboards. An examples of the types of publications in question: ...
Allow the EPS Prescription data 'status' API to be accessed for citizen facing services
Prescription State
AWAITING_RELEASE_READY = '0000'
TO_BE_DISPENSED = '0001'
WITH_DISPENSER = '0002'
WITH_DISPENSER_ACTIVE = '0003'
EXPIRED = ...
PDS FHIR API - Including system effective dates
As a trust with local demographic records which are not synchronised with PDS
I want to be able to see the system effective date of attributes in the PDS record
So ...
Ability to update nominated pharmacy element in application restricted access mode
For the PDS FHIR API, ability to update nominated pharmacy element in application restricted access mode. Being a fully online pharmacy 24/7 & having a large number ...
Spine Directory Service (SDS) FHIR API
FHIR-compliant API for accessing the Spine Directory Service (SDS), for example to retrieve details of endpoints for messaging other healthcare systems.
Authorisation - NHS Identity - separate authentication and authorisation model
Currently, the only way to complete authorisation for a user-restricted API is using "combined authentication and authorisation" - authentication with NHS Identity ...
Open ID Connect (OIDC) support on the OAuth server
Currently we use OAuth 2.0 to authorise external software to access APIs for healthcare workers. There is no standard way for external software to get the end user's ...
PDS FHIR API - current data only / business effective dates
A number of data fields in the PDS FHIR API include a "period" during which the data is effective (in HL7 V3 these were referred to as "business effective dates"). ...
Testing - standardised patient data across APIs
When testing integration across multiple APIs, it would be really helpful to have standardised test patients (NHS numbers) across the APIs.
Onboarding - process re-engineering
Identify process pain points in the onboarding process and re-engineer the process to remove those pain points.
API platform internet-facing
Make our API platform available on the internet, rather than being only available on the HSCN network.
Self-service signed JWT public key set up
Currently, to set up a public key for signed JWT auth, API consumers need to email API management and ask them to do it. This feature would make it self service, just ...
Healthcare Professionals API
Healthcare professional information in England can currently be obtained from a number of different sources such as sds ldap API, publicly available csv file and ...
Eyecare e-Referral Service API standard
An API standard for eyecare referrals. This API standard supports auto-population of digital referral platforms used when referring patients to NHS services from a ...
Create a building healthcare software guide for the demographics domain
Create a non-technical guide to building software that deals with the demographics within the NHS in England.
Organisation Data Service (ODS) API
Improved, easier-to-use API for accessing organisation data in ODS via the API platform. Possibly FHIR-compliant.
PDS FHIR API - Expose person ethnicity
Person data on Spine includes ethnicity. This is not available through PDS FHIR API (or the PDS HL7 v3 API). It is sensitive data and so may be excluded for IG ...
Performance testing capability
Provide something to help API consumers do performance testing. This might be a hosted service or a set of ready-to-go stubs.
Expose APIs as a GraphQL gateway
It would be amazing if you could query a tree of data, then have role based access control to limit what data is returned based on your identity. This means data can ...
Patient Letter to NHS App
Ability to push a patient letter into NHS App as alternative to sending out via post
FP10MDA prescriptions via EPS
FP10MDA is a prescription form used in England for schedule 2 controlled drugs supplied in instalments.
Electronic Prescription Service (EPS) FHIR API - prescribing
Ability to access EPS as a prescriber, including creating prescriptions and cancelling prescriptions.
Other Spine (Flags, record or other) information exists indicator in PDS API
An addition to the PDS API that indicates if (spine) flags (or other spine information) exists for the current patient. This would allow an organisation to know if ...
Self-service API deployments
Currently, all API deployments have to be done by the API Management central team. This change would allow API producer teams to do their own API deployments at a ...
Immunisation History API (COVID and more)
API to allow citizens to get (prove) details of immunisations they have received, such as for COVID-19. For third party apps using NHS login to prove the citizen's ...
Digitise the e-Referral Service (eRS) FHIR API onboarding experience
Bring a digitised journey to the eRS FHIR API onboarding https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir
Self-service testing
Ability to access test environments without needing our help.
Training courses / hackathons
Organise formal training courses and / or hackathons for developers to learn how to use our APIs.
Non-NHS Digital API producer teams
Make the API platform available to non-NHS Digital API producer teams. It's not clear what specific use cases this might be for.
API to convert ASID to ODS code
An API that, given an ASID, provides the corresponding ODS code.
Accessibility - WCAG WAI conformance check
The site is already built largely using WCAG WAI-conformant page templates within the NHS Digital website, but to be sure we need to test conformance and fix any issues.
Single Directory of Service API
Consolidate the numerous directory of service API's into a single service. At present we have DoS for specific areas such as UEC, EPS, eRS, etc.
PDS FHIR API - patient registration / NHS number allocation
Ability to register a new patient (not a birth) in PDS through the PDS FHIR API.
Role based access control (RBAC) for APIs
Currently, national APIs such as PDS rely on the calling system to implement role-based access controls (RBAC). This in turn increases the assurance burden on ...
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 ...
Create a building healthcare software guide for the care records domain
Create a non-technical guide to building software that deals with the care records within the NHS in England.
Under consideration
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 ...