com.eldrix.clods.index — com.eldrix/clods 1.1.195

An NHS Organisation Directory Service (ODS) file-based index providing UK organisational search functionality.

all-contact-types clj

(all-contact-types orgs)

Given a sequence of organisations, return all used contact types.

all-organizations clj

(all-organizations reader)

Returns a lazy sequence of all of the organisations. The reader must remain open until the sequence is fully realised.

build-index clj

(build-index nhspd ch out)

Build an index from NHS ODS data streamed on the channel specified.

do-query clj

(do-query searcher q max-hits)

do-raw-query clj

(do-raw-query searcher q max-hits)

(do-raw-query searcher q max-hits sort)

doc->organisation clj

(doc->organisation doc)

Deserialize a Lucene document into an ODS organisation.

fetch-org clj

(fetch-org searcher extension)

(fetch-org searcher root extension)

Returns NHS ODS data for the organisation specified. Parameters:

• searcher : Lucene IndexSearcher
• root : (optional) the identifier root; default '2.16.840.1.113883.2.1.3.2.4.18.48'
• extension : organisation code; eg. '7A4BV'.

hl7-oid-health-and-social-care-organisation-identifier clj

The default organisation root is the HL7 OID representing a HealthAndSocialCareOrganisationIdentifier

index-version clj

install-index clj

(install-index nhspd {:keys [organisations code-systems]} out)

Install an index into the directory 'out' using the data provided.

make-metadata-document clj

(make-metadata-document k m)

Create a Lucene document to store arbitrary data using the key specified.

make-org-id clj

(make-org-id org)

make-organisation-doc clj

(make-organisation-doc nhspd org)

Turn an organisation into a Lucene document. At the moment, we use postcode to derive WGS84 coordinates (lat/lon) for an organisation. In the future, when ODS contains UPRNs for organisations, we could use UPRN to derive geographical coordinates.

make-search-query clj

(make-search-query {:keys [s n address fuzzy only-active? from-location roles
                           _limit]
                    :or {fuzzy 0 only-active? true}})

Create a search query for an organisation. Parameters:

• :s : search for name or address of organisation
• :n : search for name of organisation
• :address : search within address of organisation
• :fuzzy : fuzziness factor (0-2)
• :only-active? : only include active organisations (default, true)
• :roles : a string or vector of roles
• :from-location : a map containing:
  • :lat : latitude (WGS84)
  • :lon : longitude (WGS84)
  • :range : range in metres (optional)
• limit : limit on number of search results

open-index-reader clj

(open-index-reader filename)

open-index-writer clj

(open-index-writer filename)

q-active clj

(q-active)

A query to limit to active organisations

q-address clj

(q-address s)

(q-address s fuzzy)

q-and clj

(q-and queries)

q-location clj

(q-location [lat lon] distance)

(q-location lat lon distance)

Creates a query for an organisation within 'distance' metres of the location specified.

q-name clj

(q-name s)

(q-name s fuzzy)

q-or clj

(q-or queries)

q-orgId clj

(q-orgId extension)

(q-orgId root extension)

Make a query for the identifier specified.

• root : (optional) root OID
• extension : organisation extension (code).

q-roles clj

(q-roles roles)

Query for the role(s) specified.

read-metadata clj

(read-metadata searcher k)

search clj

(search searcher
        {:keys [_s _n _only-active? _roles from-location limit]
         :or {limit 1000}
         :as q})

Search for an organisation. Parameters:

• searcher : Lucene IndexSearcher
• q : a map containing your query terms.

See make-search-query for the query terms.

Warning: the results are lazily evaluated, so use doall if you plan on closing the IndexReader before processing the results.

sort-by-distance clj

(sort-by-distance [lat lon])

(sort-by-distance lat lon)

Creates an Apache Lucene 'Sort' based on distance from the location given.

tokenize clj

(tokenize analyzer field-name s)

Tokenize the string 's' according the 'analyzer' and field specified.

write-batch! clj

(write-batch! writer nhspd orgs)

write-metadata clj

(write-metadata writer k m)