Liking cljdoc? Tell your friends :D

com.eldrix.clods.core


active-successorsclj

(active-successors ods org)

Returns the active successor(s) of the given organisation, or the given organisation if it is still active

Returns the active successor(s) of the given organisation, or the given
organisation if it is still active
sourceraw docstring

all-predecessorsclj

(all-predecessors ods org)

Returns the names of all of the predecessor names of the specified organisation

Returns the names of all of the predecessor names of the specified
organisation
sourceraw docstring

downloadclj

(download params)

Download the latest ODS release. Returns a map containing data including codesystems, codes and the organisations. See com.eldrix.clods.download/download.

Download the latest ODS release.
Returns a map containing data including codesystems, codes and the
organisations.
See `com.eldrix.clods.download/download`.
sourceraw docstring

get-relationshipclj

(get-relationship ods rel-code)

Return the relationship associated with code specified, e.g. "RE6"

Return the relationship associated with code specified, e.g. "RE6"
sourceraw docstring

get-roleclj

(get-role ods role-code)

Return the role associated with code specified, e.g. "RO72".

Return the role associated with code specified, e.g. "RO72".
sourceraw docstring

installclj

(install dir nhspd api-key cache-dir)

Download and install the latest ODS release using the defined NHSPD service. Parameters:

  • dir : directory in which to build ODS service
  • nhspd : an NHS postcode directory service
  • api-key : TRUD api key
  • cache-dir : TRUD cache directory.
Download and install the latest ODS release using the defined NHSPD service.
Parameters:
- dir       : directory in which to build ODS service
- nhspd     : an NHS postcode directory service
- api-key   : TRUD api key
- cache-dir : TRUD cache directory.
sourceraw docstring

merge-coords-from-postcodeclj

(merge-coords-from-postcode nhspd {:keys [postcode] :as loc})

Merge lat/lon information using value of :postcode, if supplied. Any existing coordinates will not be overwritten by coordinates derived from the postal code.

Merge lat/lon information using value of :postcode, if supplied.
Any existing coordinates will *not* be overwritten by coordinates derived
from the postal code.
sourceraw docstring

namespace-ods-organisationclj

source

namespace-ods-siteclj

source

normalize-idclj

(normalize-id id)

Normalizes an ODS identifier oid/extension to a URI/value with the URI prefix of 'urn:uri:'

Normalizes an ODS identifier oid/extension to a URI/value with the URI
prefix of 'urn:uri:'
sourceraw docstring

normalize-orgclj

(normalize-org org)

Normalizes an organisation, turning legacy ODS OID/extension identifiers into namespaced URI/value identifiers

Normalizes an organisation, turning legacy ODS OID/extension identifiers into
namespaced URI/value identifiers
sourceraw docstring

normalize-targetsclj

(normalize-targets v)

Normalizes the target key (containing :root and :extension keys) to turn root/extension into `system/value' where system is a URI

Normalizes the `target` key (containing `:root` and `:extension` keys) to
turn `root/extension` into `system/value' where system is a URI
sourceraw docstring

ODScljprotocol

all-organizationsclj

(all-organizations this)

Returns a lazy sequence of all organisations

Returns a lazy sequence of all organisations

code-systemsclj

(code-systems this)

Return all ODS codesystems

Return all ODS codesystems

fetch-orgclj

(fetch-org this root extension)

Fetch an organisation by identifier

Fetch an organisation by identifier

fetch-postcodeclj

(fetch-postcode this pc)

Return NHSPD data about the specified postcode.

Return NHSPD data about the specified postcode.

fetch-wgs84clj

(fetch-wgs84 this pc)

Returns WGS84 lat/long coordinates about the postcode.

Returns WGS84 lat/long coordinates about the postcode.

search-orgclj

(search-org this params)

Search for an organisation using the parameters specified.

Search for an organisation using the parameters specified.
source

open-indexclj

(open-index ods-dir nhspd-dir)
source

org-identifiersclj

(org-identifiers org)

Returns a normalised list of organisation identifiers. The first will be the 'best' identifier to use for official use. This turns a single ODS orgId (oid/extension) into a list of uri/values.

Returns a normalised list of organisation identifiers.
The first will be the 'best' identifier to use for official use.
This turns a single ODS orgId (oid/extension) into a list of uri/values.
sourceraw docstring

org-part-ofclj

(org-part-of org)

Returns a best-match of what we consider an organisation 'part-of'. Returns a tuple of root extension.

Returns a best-match of what we consider an organisation 'part-of'.
Returns a tuple of root extension.
sourceraw docstring

orgRecordClass->namespaceclj

source

part-of-relationshipsclj

A priority list of what relationship to use in order to determine the more abstract 'part-of' relationship.

A priority list of what relationship to use in order to
determine the more abstract 'part-of' relationship.
sourceraw docstring

(search searcher nhspd params)

Search for an organisation Parameters :

  • searcher : A Lucene IndexSearcher
  • nhspd : NHS postcode directory service
  • params : Search parameters; a map containing: |- :s : search for name or address of organisation |- :n : search for name of organisation |- :address : search within address |- :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: | |- :postcode : UK postal code, or | |- :lat : latitude (WGS84) | |- :lon : longitude (WGS84), and | |- :range : range in metres (optional) |- :limit : limit on number of search results.
Search for an organisation
Parameters :
- searcher : A Lucene IndexSearcher
- nhspd    : NHS postcode directory service
- params   : Search parameters; a map containing:
  |- :s             : search for name or address of organisation
  |- :n             : search for name of organisation
  |- :address       : search within address
  |- :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:
  |  |- :postcode : UK postal code, or
  |  |- :lat      : latitude (WGS84)
  |  |- :lon      : longitude (WGS84), and
  |  |- :range    : range in metres (optional)
  |- :limit      : limit on number of search results.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close