https://github.com/nhsdigital/ndr_lookup
National Disease Registers reference data lookup gem
https://github.com/nhsdigital/ndr_lookup
Last synced: about 1 year ago
JSON representation
National Disease Registers reference data lookup gem
- Host: GitHub
- URL: https://github.com/nhsdigital/ndr_lookup
- Owner: NHSDigital
- License: mit
- Created: 2019-05-13T08:27:36.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2025-03-12T12:08:45.000Z (over 1 year ago)
- Last Synced: 2025-03-12T13:22:42.862Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 53.7 KB
- Stars: 0
- Watchers: 13
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# NdrLookup [](https://github.com/NHSDigital/ndr_lookup/actions?query=workflow%3Atest)
This is the NHS Digital (NHSD) National Disease Registers (NDR) Lookup ruby gem,
providing:
1. an ArcGIS LocatorHub API client
2. NHS Digital Organisation Data Service API Client
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'ndr_lookup'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install ndr_lookup
## Usage
### ArcGIS LocatorHub API Client
`NdrLookup::LocatorHub::Client` is a client to access the LocatorHub API to rectify given addresses.
The client isn't included by default, so add the following to your code:
```ruby
require 'ndr_lookup/locator_hub/client'
```
It requires some manual setup:
Configuration | Description
--- | ---
`domain` | A string of the authenicating domain name.
`username` | A string of the authenticating username.
`password` | A string of the authenticating password.
Within a Rails application, you should do this in an initializer, preferably using encrypted credentials, e.g.:
```ruby
# This file configures NdrLookup.
Rails.application.config.to_prepare do
NdrLookup::LocatorHub::Client.domain = Rails.application.credentials.production[:locator_hub_api][:domain]
NdrLookup::LocatorHub::Client.username = Rails.application.credentials.production[:locator_hub_api][:username]
NdrLookup::LocatorHub::Client.password = Rails.application.credentials.production[:locator_hub_api][:password]
end
```
### NHS Digital Organisation Data Service API Client
NdrLookup::NhsdOds::Client is a client to access the NHS Digital ODS API search and sync endpoints.
Sync will return a JSON format payload for all organisations that have been updated since the specified date:
```ruby
require 'ndr_lookup/nhsd_ods/client'
organisation_ids = NdrLookup::NhsdOds::Client.sync(Date.new(2019, 6, 14))
```
*NOTE* that the client isn't included by default, so you have to require it specifically.
Search will allow you to search based on parameters specified by ODS
https://digital.nhs.uk/services/organisation-data-service/guidance-for-developers/search-endpoint#parameters
For example:
```ruby
require 'ndr_lookup/nhsd_ods/client'
results = NdrLookup::NhsdOds::Client.search(Name: 'NHS Digital')
```
NdrLookup::NhsdOds::Organisation will enable you to access the NHS Digital ODS API to find a specific organisation.
Lookup will return an Organisation object with model like behaviours:
```ruby
require 'ndr_lookup/nhsd_ods/organisation'
organisation = NdrLookup::NhsdOds::Organisation.find('X26')
```
NdrLookup::NhsdOds::CodeSystems will enable you to access the NHS Digital ODS API to find the meta data information included in the payload records returned via the endpoints. CodeSystems currently includes roles, relationships and record classes.
```ruby
require 'ndr_lookup/nhsd_ods/code_systems'
role = NdrLookup::NhsdOds::Role.find('RO197')
first_relationship = NdrLookup::NhsdOds::Rel.first
all_record_classes = NdrLookup::NhsdOds::Recordclass.all
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/NHSDigital/ndr_lookup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the NdrLookup project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/NHSDigital/ndr_lookup/blob/master/CODE_OF_CONDUCT.md).