# ACTIVESTATE TEAPOT-PKG BEGIN TM -*- tcl -*-
# -- Tcl Module

# @@ Meta Begin
# Package valtype::usnpi 1
# Meta as::build::date 2015-05-25
# Meta as::origin      http://sourceforge.net/projects/tcllib
# Meta category        Validation types
# Meta description     Validation for USNPI
# Meta license         BSD
# Meta platform        tcl
# Meta require         {Tcl 8.5}
# Meta require         snit
# Meta require         valtype::common
# Meta require         valtype::luhn
# Meta subject         {National Provider Identifier} US-NPI Checking isA
# Meta subject         {Value checking} medicare {Type checking} Testing
# Meta subject         NPI Validation
# Meta summary         valtype::usnpi
# @@ Meta End


# ACTIVESTATE TEAPOT-PKG BEGIN REQUIREMENTS

package require Tcl 8.5
package require snit
package require valtype::common
package require valtype::luhn

# ACTIVESTATE TEAPOT-PKG END REQUIREMENTS

# ACTIVESTATE TEAPOT-PKG BEGIN DECLARE

package provide valtype::usnpi 1

# ACTIVESTATE TEAPOT-PKG END DECLARE
# ACTIVESTATE TEAPOT-PKG END TM
# # ## ### ##### ######## ############# ######################
## US NPI (National Provider Identifier) for Medicare services.
## Reference
##	http://en.wikipedia.org/wiki/National_Provider_Identifier
## Short notes
##	10-digit number. No embedded information.
##	Passes Luhn test when prefixed with '80480'.

# # ## ### ##### ######## ############# ######################

# The code below implements the interface of a snit validation type,
# making it directly usable with snit's -type option in option
# specifications.

# # ## ### ##### ######## ############# ######################
## Requisites

package require Tcl 8.5
package require snit
package require valtype::luhn
package require valtype::common

# # ## ### ##### ######## ############# ######################
## Implementation

namespace eval ::valtype::usnpi {
    namespace import ::valtype::common::*
}

snit::type ::valtype::usnpi {
    #-------------------------------------------------------------------
    # Type Methods

    typemethod validate {value} {
	if {[string length $value] != 10} {
	    badlength US-NPI 10 "US-NPI number"
	}
	valtype::luhn validate 80480$value US-NPI
	return $value
    }

    typemethod checkdigit {value} {
	if {[string length $value] != 9} {
	    badlength US-NPI 9 "US-NPI number (without checkdigit)"
	}
	return [valtype::luhn checkdigit 80480$value US-NPI]
    }

    #-------------------------------------------------------------------
    # Constructor

    # None needed; no options

    #-------------------------------------------------------------------
    # Public Methods

    method validate {value} {
        $type validate $value
    }
}

# # ## ### ##### ######## ############# ######################
## Ready

package provide valtype::usnpi 1