Liking cljdoc? Tell your friends :D

com.eldrix.odsweekly.core

ods-weekly is an NHS dataset that supplements the standard ODS dataset. It principally links GP surgeries with general practitioners, with additional tables to support the mapping of GP identifiers to GMC reference numbers.

ods-weekly is an NHS dataset that supplements the standard ODS dataset.
It principally links GP surgeries with general practitioners, with additional
tables to support the mapping of GP identifiers to GMC reference numbers.
raw docstring

close-indexclj

(close-index conn)
source

create-indexclj

(create-index & {:keys [db dir api-key cache-dir] :or {dir ""}})

Create an index with the latest distribution downloaded from TRUD. Parameters:

  • dir : directory in which to create automatically named index
  • db : specific path for index creation, if no 'dir' specified.
  • api-key : TRUD api-key
  • cache-dir : TRUD cache directory

Returns information about the release, including keys:

  • :indexFilename : filename of the newly created index

By default, a new index will be created based on the release-date within the directory dir. If db is specified, the index will be created directly there instead. If dir is omitted, the current directory will be used.

Create an index with the latest distribution downloaded from TRUD.
Parameters:
- dir       : directory in which to create automatically named index
- db        : specific path for index creation, if no 'dir' specified.
- api-key   : TRUD api-key
- cache-dir : TRUD cache directory

Returns information about the release, including keys:
- :indexFilename : filename of the newly created index

By default, a new index will be created based on the release-date within the
directory `dir`. If `db` is specified, the index will be created directly
there instead. If `dir` is omitted, the current directory will be used.
sourceraw docstring

downloadclj

(download {:keys [_db _dir api-key cache-dir] :as params})

Downloads the latest release to create a file-based database. A function designed to used as an exec-fn from deps.edn. Parameters:

  • :db - specific name for file-based database
  • :dir - directory in which a file-based database should be created
  • :api-key - filename of file containing TRUD API key
  • :cache-dir - directory for TRUD cache.

The only mandatory parameter is api-key. If ':db' and ':dir' are omitted, the current directory will be used. If ':cache-dir' is omitted, a system 'tmp' directory will be used.

Downloads the latest release to create a file-based database.
A function designed to used as an exec-fn from deps.edn.
Parameters:
- :db        - specific name for file-based database
- :dir       - directory in which a file-based database should be created
- :api-key   - filename of file containing TRUD API key
- :cache-dir - directory for TRUD cache.

The only mandatory parameter is api-key.
If ':db' and ':dir' are omitted, the current directory will be used.
If ':cache-dir' is omitted, a system 'tmp' directory will be used.
sourceraw docstring

get-by-nameclj

(get-by-name conn s)
source

get-organisation-by-codeclj

(get-organisation-by-code conn organisation-code)

Return data on the 'organisation' specified.

Return data on the 'organisation' specified. 
sourceraw docstring

gp-by-gmc-numberclj

(gp-by-gmc-number conn gmc-number)

Return a sequence of GNC records for the GP with the given GMC number. The NHS Prescription Service use a number called the Doctor’s Index Number or DIN (allocated by the Health and Social Care Information Centre when a doctor first applies to practice in the UK), to derive a GP's first GNC code; this is prefixed with a ‘G’ and suffixed with a check digit. Thereafter however, if a GP begins to work at further practices (i.e. is working within more than one simultaneously), the NHS Prescription Service allocate further codes not based on the DIN. A GP can therefore have multiple GNC codes, one for each practice they work at simultaneously. If a GP completely leaves a practice before joining a new one, and there is no overlap, then the current code will be retained and just the links within the data updated.

Return a sequence of GNC records for the GP with the given GMC number.
The NHS Prescription Service use a number called the Doctor’s Index Number or
DIN (allocated by the Health and Social Care Information Centre when a doctor
first applies to practice in the UK), to derive a GP's first GNC code; this
is prefixed with a ‘G’ and suffixed with a check digit. Thereafter however, if
a GP begins to work at further practices (i.e. is working within more than one
simultaneously), the NHS Prescription Service allocate further codes not based
on the DIN. A GP can therefore have multiple GNC codes, one for each practice
they work at simultaneously. If a GP completely leaves a practice before
joining a new one, and there is no overlap, then the current code will be
retained and just the links within the data updated.
sourceraw docstring

latest-releaseclj

(latest-release api-key)

Returns data about the latest release of the ODS weekly TRUD item.

Returns data about the latest release of the ODS weekly TRUD item.
sourceraw docstring

metadataclj

(metadata dir)

Returns the metadata from the index specified.

Returns the metadata from the index specified.
sourceraw docstring

n27-field-formatclj

The standard ODS 27-field format headings

The standard ODS 27-field format headings
sourceraw docstring

open-indexclj

(open-index db)

Open an index. Parameters:

  • :db - path to ods-weekly index The index must have been initialised and of the correct index version.
Open an index.
Parameters:
- :db   - path to ods-weekly index
The index must have been initialised and of the correct index version.
sourceraw docstring

statusclj

(status {:keys [db]})

Return the status of a specific ods-weekly index. A function designed to used as an exec-fn from deps.edn. Parameters:

  • :db - path to index.
Return the status of a specific ods-weekly index.
A function designed to used as an exec-fn from deps.edn.
Parameters:
- :db - path to index.
sourceraw docstring

surgery-gpsclj

(surgery-gps conn surgery-identifier)

Returns a sequence of general practitioners in the surgery specified.

Returns a sequence of general practitioners in the surgery specified.
sourceraw docstring

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

× close