Home - nhsconnect/nrls-reference-implementation GitHub Wiki

Welcome to the NRL Reference Implementation Wiki. This wiki details the structure of the reference implementation along with how to build, deploy, test and integrate this tool with your system.

The NRL (National Record Locator) service reference repository contains four main components:

1. Demo front end
2. Demo back end
3. NRL Stub API
4. Data Store

The four areas allow for a complete demonstration of the NRL end-to-end.

The menu on the right will aid in navigating this Wiki.

Installation & Requirements

Installation instructions and details of the minimum requirements can be found in the repository README.

The front end

The front end as you can imagine is a visual tool that is designed to help those that will or want to integrate with the NRL understand what it is, what it does and how it can feature within their work flow – initially health care professional.

The back end

The back end is mostly there to support the front end in terms of data retrieval and creation. There is also a command line module within the back end that will allow techies to bypass the front end to send requests to the NRL stub.

The NRL Stub

The NRL Stub as you can guess is an API designed to mimic the NRL API and to a lesser degree mimic some of the security aspects of the SPINE, at a basic level to test for required data and that the data matches the requests.

The data store

The data store simply stores the data for both the back end API and the NRL Stub API. The data store can be any type of persistent data layer but in this application it is a MongoDB data store. The back end API and the NRL Stub API can have their own data stores but for this demonstration they use the same store.