FHIR-NRL-API

An API for storing and retrieving pointers to records and documents from the National Record Locator (NRL).

NRL API

Implementation Guide for creating the NRL API
Visit the APIs »

Table of Contents

• Quick start
• Contributing
• Versioning
• Copyright and license

Quick Start

Option 1:

• View the latest release

Option 2 (running documentation locally):

• Clone the repo: git clone https://github.com/nhsconnect/FHIR-NRLS-API
• Install Ruby
• Install Jekyll and Bundler:
  • $ gem install jekyll bundler
  • $ jekyll -v (Note: if this doesn't work, try rebooting)
• Delete the Gemfile.lock file in the project root.
• Execute Jekyll locally against the project:
  • $ bundle
  • $ bundle lock --add-platform ruby
  • $ bundle lock --add-platform x86-mingw32
  • $ bundle lock --add-platform x64-mingw32
  • $ bundle exec jekyll serve
• Browse to localhost:4006

Learn more about using Jekyll by reading its documentation.

Contributing

Notice a defect or have a feature request? Check the existing issues first. If your problem or idea is not addressed yet, feel free to open a new issue.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, the NRL API is maintained under the Semantic Versioning guidelines.

See the JIRA releases or release notes page for version changelogs.

Copyright and License

Copyright 2011-2020:

• NHS Digital Code released under the MIT License.
• Documentation released under Creative Commons License.