ESR Wrapper API

May 27, 2020
Alex Rudall

Tags: developmenttechnology


SARD and Oxleas NHS Trust have begun work on an API wrapper to improve access to NHS Electronic Staff Record data. The project is funded by NHS Improvement.

At present, ESR data must be accessed either through an existing frontend, or through a daily file downloaded from an FTP server. This leaves quite a high barrier to developing new applications on top of the data, since each NHS Trust must develop a way to import the latest data.

The ESR Wrapper project adds a generic RESTful API that can import the generic update each day and expose it for access. RESTful APIs are the dominant form of web API and allow data to be queried in a secure and scalable way.

The project is a work in progress but when complete should make it easier for NHS trusts to build useful applications on top of centralised ESR data. The project will be released as open source the code so that other NHS trusts can use the software as needed.


The RESTful API is documented with Swagger and designed to conform to the JSON:API specification. The swagger documentation is built from the application’s test suite, and includes example responses and the ability to manually test the API.


Example UI

See here for a simple demo of the kind of interface that can be built on top of the API:


Find this interesting?

You should sign up to our newsletter because it will keep you up to date with Medical HR, technology and what SARD JV are up to. We promise not to send you a load of sales bumf. Newsletters have a typical email open rate of around 15-20%. We aim to keep our open rate above 60%. That means we'll only add you to the list if you really want to be added and work hard to send you interesting stuff.

Subscribe to our mailing list