1valtype::usnpi(n) Validation types valtype::usnpi(n)
2______________________________________________________________________________
6
8 valtype::usnpi - Validation for USNPI
9
11 package require Tcl 8.5
12 package require snit 2
14 package require valtype::common
16 package require valtype::luhn
18 package require valtype::usnpi ?1?
20 valtype::usnpi validate value
22 valtype::usnpi checkdigit value
24______________________________________________________________________________
26
28 This package implements a snit validation type for an USNPI.
29 A validation type is an object that can be used to validate Tcl values
31 of a particular kind. For example, snit::integer, a validation type
32 defined by the snit package is used to validate that a Tcl value is an
33 integer.
34 Every validation type has a validate method which is used to do the
36 validation. This method must take a single argument, the value to be
37 validated; further, it must do nothing if the value is valid, but throw
38 an error if the value is invalid:
39 valtype::usnpi validate .... ;# Does nothing
42 valtype::usnpi validate .... ;# Throws an error (bad US National Provider Identifier (US-NPI) number).
43 The validate method will always return the validated value on success,
46 and throw the -errorcode INVALID on error, possibly with additional el‐
47 ements which provide more details about the problem.
48
50 The API provided by this package satisfies the specification of snit
51 validation types found in the documentation of Snit's Not Incr Tcl.
52 valtype::usnpi validate value
54 This method validates the value and returns it, possibly in a
55 canonical form, if it passes. If the value does not pass the
56 validation an error is thrown.
57 valtype::usnpi checkdigit value
59 This method computes a check digit for the value. Before doing
60 so it is validated, except for a checkdigit. If the value does
61 not pass the validation no check digit is calculated and an er‐
62 ror is thrown instead.
63
65 As said in the package description, the errors thrown by the commands
66 of this package in response to input validation failures use the -er‐
67 rorcode INVALID to distinguish themselves from package internal errors.
68 To provide more detailed information about why the validation failed
70 the -errorCode goes actually beyond that. First, it will contain a
71 code detailing the type itself. Here this is USNPI. This is then fol‐
72 lowed by values detailing the reason for the failure. The full set of
73 -errorCodes which can be thrown by this package are:
74 INVALID USNPI CHARACTER
76 The input value contained one or more bad characters, i.e. char‐
77 acters which must not occur in the input for it to be an USNPI.
78 INVALID USNPI CHECK-DIGIT
80 The check digit of the input value is wrong. This usually sig‐
81 nals a data-entry error, with digits transposed, forgotten, etc.
82 Of course, th input may be an outright fake too.
83 INVALID USNPI LENGTH
85 The input value is of the wrong length to be an USNPI.
86
88 This document, and the package it describes, will undoubtedly contain
89 bugs and other problems. Please report such in the category valtype of
90 the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please
91 also report any ideas for enhancements you may have for either package
92 and/or documentation.
93 When proposing code changes, please provide unified diffs, i.e the out‐
95 put of diff -u.
96 Note further that attachments are strongly preferred over inlined
98 patches. Attachments can be made by going to the Edit form of the
99 ticket immediately after its creation, and then using the left-most
100 button in the secondary navigation bar.
101
103 Checking, NPI, National Provider Identifier, Testing, Type checking,
104 US-NPI, Validation, Value checking, isA, medicare
105
107 Validation, Type checking
108
110 Copyright (c) 2011 Andreas Kupries <andreas_kupries@users.sourceforge.net>
111tcllib 1 valtype::usnpi(n)