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.
Private Beta sign up: ...
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 ...
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 ...
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.
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 ...
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 ...
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.
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 ...
Onboarding - process re-engineering
Identify process pain points in the onboarding process and re-engineer the process to remove those pain points.
Create a building healthcare software guide for patient-facing applications
Create a non-technical guide to building software that deals with patient-facing applications within the NHS in England.
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.
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 ...
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.
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 ...
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 ...
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, ...
Re-usable auth components
Provide auth components that API producer teams can easily plug into their APIs.
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 ...
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 ...
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 ...
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.
Developer guide exemplar - PDS
An online guide containing best practice guidance for developing software that uses the PDS APIs.
Status monitoring
Ability for developers to monitor the status for the platform and APIs
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 ...
API producer analytics
Ability for API producer teams to see analytics on the use of their API.
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.
FHIR policy update
Our FHIR policy hasn't been looked at in a while. The scope of this feature is to revisit it and refresh it, maybe adding further details.
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).
API documentation team capabilities
Changes to NHS Digital team structures to ensure teams have the skills they need to produce consistently good quality documentation.
Tech stack for APIs
Define a standard tech stack for APIs, so API producers don't have to figure it out for themselves.
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#
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 - 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.
Vision and roadmap - published
Publish our vision and roadmap so developers can see it and contribute to it.
API catalogue - tags, filters and searching
Improve the API catalogue so that APIs are tagged and users can filter by things like domain (demographics, medication etc), technology (REST, FHIR, HL7 V3 etc), type ...
Search engine optimisation
Ensure that our API documentation can be found by external and internal search engines.
API catalogue - include all existing APIs
Make sure the API catalogue page (https://digital.nhs.uk/developer/api-catalogue) has all existing APIs listed in it.
API producer team support channels
Provide support channels for API producer teams to get help and support from the API Management team.
API templates
Provide a template repo for API producer teams to create a new API quickly and easily.
API producer guidance
Provide guidance for API producer teams on how to come onboard, how the tech works, how to do documentation, what path-to-live environments are available etc.
Feedback widgets and polls
Allow developers to give feedback via widgets and polls on the developer portal.
Developer portal - improve information architecture
There are numerous dead-ends on the NHS Digital website, for example if I find a service in the "services" area, it doesn't always link through to the relevant API ...