The eclecticse.slk-581 Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The eclecticse.slk-581 Reference Manual

This is the eclecticse.slk-581 Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 15:02:39 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

EclecticSE SLK-581 Code Library

The SLK-581 is a fourteen character statistical linkage code used by Australian Government departments.

SLK-581 Algorithm

The code is composed of the ordered concatenation of the following four data elements related to a person:

  1. 2nd, 3rd and 5th letters of last name (family name).

  2. 2nd and 3rd letters of first (given) name.

  3. The date of birth as a character string in the form DDMMYYYY.

  4. The sex of the client as:

Additional Notes

Licence

LLGPL


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 eclecticse.slk-581

Author

David K. Trudgett <David.Trudgett@eclecticse.com.au

License

LLGPL

Description

Generate Australian Government SLK-581 codes.

Version

1.0.0

Dependency

cl-ppcre

Source

eclecticse.slk-581.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 eclecticse.slk-581.asd

Location

eclecticse.slk-581.asd

Systems

eclecticse.slk-581 (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 eclecticse.slk-581/package.lisp

Parent

eclecticse.slk-581 (system)

Location

package.lisp

Packages

eclecticse.slk-581


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 eclecticse.slk-581/data-rec.lisp

Dependency

package.lisp (file)

Parent

eclecticse.slk-581 (system)

Location

data-rec.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 eclecticse.slk-581/specials.lisp

Dependency

data-rec.lisp (file)

Parent

eclecticse.slk-581 (system)

Location

specials.lisp

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.5 eclecticse.slk-581/slk-581.lisp

Dependency

specials.lisp (file)

Parent

eclecticse.slk-581 (system)

Location

slk-581.lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 eclecticse.slk-581

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: data-rec->slk-581 DATA-REC

Generate the SLK-581 code for DATA-REC.

Package

eclecticse.slk-581

Source

slk-581.lisp (file)

Function: regex-check-slk-581 SLK-581
Package

eclecticse.slk-581

Source

slk-581.lisp (file)

Function: slk-581 GIVEN-NAME FAMILY-NAME DATE-OF-BIRTH SEX

Return the SLK-581 code for the given data. DATE-OF-BIRTH is a string in YYYY-MM-DD (ISO 8601) format. Sex is one of the following values, which match Australian government
classification: :MALE, :FEMALE, :OTHER, :UNKNOWN, or the strings, ’Male’, ’Female’, ’Other’, ’Unknown’, ’Intersex’, or ’Indeterminate’. Unknown is the same a ’not stated’ or ’inadequately described’.

Package

eclecticse.slk-581

Source

slk-581.lisp (file)

Function: test-slk-581 ()

Run tests against all test data records and report the results.

Package

eclecticse.slk-581

Source

slk-581.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *slk-scanner*

Regular expression to validate structure of an SLK-581 code.

Package

eclecticse.slk-581

Source

specials.lisp (file)

Special Variable: *test-data*

Test data with known correct SLK-581 values.

Package

eclecticse.slk-581

Source

specials.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: cleanse-item ITEM

Trim ITEM and convert to upper case if a string.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: cleanse-name NAME

Remove non-alpha characters from NAME.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: field-val ITEM

Return the value of ITEM, which is a (key value) pair.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: get-dob DATA-REC

Retrieve the date of birth in ddmmyyyy format, from DATA-REC.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: get-first-name DATA-REC

Retrieve the cleansed first name from DATA-REC.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: get-first-name-letters DATA-REC

Retrieve the two letters of the first name which form part of the SLK code.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: get-item WHICH DATA-REC

Retrieve a (key value) pair from the DATA-REC. WHICH is one of – :first-name :surname :gender :dob :slk

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: get-sex-code DATA-REC

Retrieve the SLK sex/gender code for DATA-REC.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: get-surname DATA-REC

Retrieve the cleansed surname from DATA-REC.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: get-surname-letters DATA-REC

Retrieve the three letters of the surname which form part of the SLK code.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: iso-date->ddmmyyyy ISO-DATE

Convert an ISO 8601 date with hyphens into DDMMYYYY.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)

Function: trim STRING

Remove spaces from start and end of STRING.

Package

eclecticse.slk-581

Source

data-rec.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   E   F   L  
Index Entry  Section

E
eclecticse.slk-581.asd: The eclecticse<dot>slk-581<dot>asd file
eclecticse.slk-581/data-rec.lisp: The eclecticse<dot>slk-581/data-rec<dot>lisp file
eclecticse.slk-581/package.lisp: The eclecticse<dot>slk-581/package<dot>lisp file
eclecticse.slk-581/slk-581.lisp: The eclecticse<dot>slk-581/slk-581<dot>lisp file
eclecticse.slk-581/specials.lisp: The eclecticse<dot>slk-581/specials<dot>lisp file

F
File, Lisp, eclecticse.slk-581.asd: The eclecticse<dot>slk-581<dot>asd file
File, Lisp, eclecticse.slk-581/data-rec.lisp: The eclecticse<dot>slk-581/data-rec<dot>lisp file
File, Lisp, eclecticse.slk-581/package.lisp: The eclecticse<dot>slk-581/package<dot>lisp file
File, Lisp, eclecticse.slk-581/slk-581.lisp: The eclecticse<dot>slk-581/slk-581<dot>lisp file
File, Lisp, eclecticse.slk-581/specials.lisp: The eclecticse<dot>slk-581/specials<dot>lisp file

L
Lisp File, eclecticse.slk-581.asd: The eclecticse<dot>slk-581<dot>asd file
Lisp File, eclecticse.slk-581/data-rec.lisp: The eclecticse<dot>slk-581/data-rec<dot>lisp file
Lisp File, eclecticse.slk-581/package.lisp: The eclecticse<dot>slk-581/package<dot>lisp file
Lisp File, eclecticse.slk-581/slk-581.lisp: The eclecticse<dot>slk-581/slk-581<dot>lisp file
Lisp File, eclecticse.slk-581/specials.lisp: The eclecticse<dot>slk-581/specials<dot>lisp file

Jump to:   E   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   D   F   G   I   R   S   T  
Index Entry  Section

C
cleanse-item: Internal functions
cleanse-name: Internal functions

D
data-rec->slk-581: Exported functions

F
field-val: Internal functions
Function, cleanse-item: Internal functions
Function, cleanse-name: Internal functions
Function, data-rec->slk-581: Exported functions
Function, field-val: Internal functions
Function, get-dob: Internal functions
Function, get-first-name: Internal functions
Function, get-first-name-letters: Internal functions
Function, get-item: Internal functions
Function, get-sex-code: Internal functions
Function, get-surname: Internal functions
Function, get-surname-letters: Internal functions
Function, iso-date->ddmmyyyy: Internal functions
Function, regex-check-slk-581: Exported functions
Function, slk-581: Exported functions
Function, test-slk-581: Exported functions
Function, trim: Internal functions

G
get-dob: Internal functions
get-first-name: Internal functions
get-first-name-letters: Internal functions
get-item: Internal functions
get-sex-code: Internal functions
get-surname: Internal functions
get-surname-letters: Internal functions

I
iso-date->ddmmyyyy: Internal functions

R
regex-check-slk-581: Exported functions

S
slk-581: Exported functions

T
test-slk-581: Exported functions
trim: Internal functions

Jump to:   C   D   F   G   I   R   S   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*slk-scanner*: Internal special variables
*test-data*: Internal special variables

S
Special Variable, *slk-scanner*: Internal special variables
Special Variable, *test-data*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   E   P   S  
Index Entry  Section

E
eclecticse.slk-581: The eclecticse<dot>slk-581 system
eclecticse.slk-581: The eclecticse<dot>slk-581 package

P
Package, eclecticse.slk-581: The eclecticse<dot>slk-581 package

S
System, eclecticse.slk-581: The eclecticse<dot>slk-581 system

Jump to:   E   P   S