File Coverage

blib/lib/Parse/SAMGov/Exclusion.pm

Criterion	Covered	Total	%
statement	113	116	97.4
branch	32	48	66.6
condition			n/a
subroutine	17	17	100.0
pod	0	3	0.0
total	162	184	88.0

package Parse::SAMGov::Exclusion;
$Parse::SAMGov::Exclusion::VERSION = '0.202';
use strict;
use warnings;
use 5.010;
use Carp;
use Data::Dumper;
use DateTime;
use DateTime::Format::Strptime;
use Parse::SAMGov::Mo;
use Parse::SAMGov::Exclusion::Name;
use Parse::SAMGov::Entity::Address;

#ABSTRACT: defines the SAM Exclusions object

use overload fallback => 1,
    '""' => sub {
        my $self = $_[0];
        my $str = '';
        $str .= $self->classification . ': ' . $self->name;
        $str .= "\nAddress: " . $self->address if $self->address;
        $str .= "\nUEI: " . $self->UEI if $self->UEI;
        $str .= "\nDUNS: " . $self->DUNS if $self->DUNS;
        $str .= "\nCAGE: " . $self->CAGE if $self->CAGE;
        $str .= "\nSAM no.: " . $self->SAM_number if $self->SAM_number;
        $str .= "\nNational Provider Identifier: " . $self->NPI if $self->NPI;
        $str .= "\nCreation Date: " . $self->creation_date->ymd('-') if $self->creation_date;
        $str .= "\nActive Date: " . $self->active_date->ymd('-') if $self->active_date;
        if ($self->termination_date->year() == 2200) {
            $str .= "\nTermination Date: Indefinite";
        } else {
            $str .= "\nTermination Date: " . $self->termination_date->ymd('-') if $self->termination_date;
        }
        $str .= "\nCross Reference: " . $self->crossref if $self->crossref;
        $str .= "\nRecord status: " . $self->record_status if $self->record_status;
        $str .= "\nExclusion Program: " . $self->xprogram if $self->xprogram;
        $str .= "\nExclusion Agency: " . $self->xagency if $self->xagency;
        $str .= "\nExclusion Type: " . $self->xtype if $self->xtype;
        $str .= "\nExclusion Type(Cause & Treatment Code): " . $self->CT_code if $self->CT_code;
        $str .= "\nAdditional Comments: " . $self->comments if $self->comments;
        $str .= "\nD&B Open Data Flag: " . $self->dnb_open_data if defined $self->dnb_open_data;
        return $str;
    };


has classification => ();


has name => default => sub {
    return Parse::SAMGov::Exclusion::Name->new;
};


has address => default => sub {
    return Parse::SAMGov::Entity::Address->new;
};


has 'DUNS';
has 'dnb_open_data';
has 'UEI';


has 'xprogram';


has 'xagency';


has 'CT_code';


has 'xtype';


has 'comments';

sub _parse_date {
    if (@_) {
        my $d = shift;
        $d = '12/31/2200' if $d =~ /indefinite/i;
        state $Strp =
          DateTime::Format::Strptime->new(pattern   => '%m/%d/%Y',
                                          time_zone => 'America/New_York',);
        return $Strp->parse_datetime($d);
    }
    return;
}


has creation_date => (coerce => sub { _parse_date $_[0] });


has active_date => (coerce => sub { _parse_date $_[0] });


has termination_date => (coerce => sub { _parse_date $_[0] });


has 'record_status';


has 'crossref';


has 'SAM_number';


has 'CAGE';


has 'NPI';

sub _trim {
    # from Mojo::Util::trim
    my $s = shift;
    $s =~ s/^\s+//g;
    $s =~ s/\s+$//g;
    return $s;
}

sub load {
    my $self = shift;
    my $ncols = scalar(@_);
    return $self->load_v2(@_) if $ncols eq 31;
    return $self->load_v1(@_) if $ncols eq 28;
    carp "Unknown version of data file found with $ncols columns";
    return undef;
}

sub load_v1 {
    my $self = shift;
    return unless scalar(@_) == 28;
    $self->classification(_trim(shift));
    my $name = Parse::SAMGov::Exclusion::Name->new(
        entity => _trim(shift),
        prefix => _trim(shift),
        first => _trim(shift),
        middle => _trim(shift),
        last => _trim(shift),
        suffix => _trim(shift),
    );
    $self->name($name);
    my $addr = Parse::SAMGov::Entity::Address->new(
        # the order of shifting matters
        address => _trim(join(' ', shift, shift, shift, shift)),
        city => _trim(shift),
        state => _trim(shift),
        country => _trim(shift),
        zip => _trim(shift),
    );
    $self->address($addr);
    $self->DUNS(_trim(shift));
    $self->xprogram(_trim(shift));
    $self->xagency(_trim(shift));
    $self->CT_code(_trim(shift));
    $self->xtype(_trim(shift));
    $self->comments(_trim(shift));
    $self->active_date(shift);
    $self->termination_date(shift);
    $self->record_status(_trim(shift));
    $self->crossref(_trim(shift));
    $self->SAM_number(_trim (shift));
    $self->CAGE(_trim(shift));
    $self->NPI(_trim(shift));
    return 1;
}

sub load_v2 {
    my $self = shift;
    return unless scalar(@_) == 31;
    $self->classification(_trim(shift));
    my $name = Parse::SAMGov::Exclusion::Name->new(
        entity => _trim(shift),
        prefix => _trim(shift),
        first => _trim(shift),
        middle => _trim(shift),
        last => _trim(shift),
        suffix => _trim(shift),
    );
    $self->name($name);
    my $addr = Parse::SAMGov::Entity::Address->new(
        # the order of shifting matters
        address => _trim(join(' ', shift, shift, shift, shift)),
        city => _trim(shift),
        state => _trim(shift),
        country => _trim(shift),
        zip => _trim(shift),
    );
    $self->address($addr);
    $self->dnb_open_data(shift);# D&B Open Data Flag
    $self->DUNS(_trim(shift));
    $self->UEI(_trim(shift));
    $self->xprogram(_trim(shift));
    $self->xagency(_trim(shift));
    $self->CT_code(_trim(shift));
    $self->xtype(_trim(shift));
    $self->comments(_trim(shift));
    $self->active_date(shift);
    $self->termination_date(shift);
    $self->record_status(_trim(shift));
    $self->crossref(_trim(shift));
    $self->SAM_number(_trim (shift));
    $self->CAGE(_trim(shift));
    $self->NPI(_trim(shift));
    $self->creation_date(shift);
    return 1;
}

1;

=pod

=encoding UTF-8

=head1 NAME

Parse::SAMGov::Exclusion - defines the SAM Exclusions object

=head1 VERSION

version 0.202

=head1 SYNOPSIS

    my $exclusion = Parse::SAMGov::Exclusion->new;
    $exclusion->classification("firm");
    $exclusion->DUNS('123456789');
    $exclusion->CAGE('7ABZ1');

    ...

=head1 METHODS

=head2 new

This method creates a new Exclusion object.

=head2 classification

Identifies the exclusion Classification Type as either a Firm, Individual,
Special Entity Designation, or Vessel. The maximum length of this field is 50
characters.

=head2 name

This sets/gets an object of L<Parse::SAMGov::Exclusion::Name> which can hold
either the entity name being excluded or the individual name being excluded.

=head2 address

This sets/gets an object of L<Parse::SAMGov::Entity::Address> which holds the
primary address of the entity or individual being excluded. It includes the
city, two character abbreviation of state/province, three character abbreviation
of country and a 10 character zip/postal code.

=head2 DUNS

This holds the unique identifier of the excluded entity, currently the Data
Universal Numbering System (DUNS) number. Exclusion records with a
classification type of Firm must have a DUNS number. It may be found in
exclusion records of other classification types if the individual, special
entity or vessel has a DUNS number. This has a maximum length of 9 characters.

=head2 dnb_open_data

This flag denotes whether this is a D&B Open Data or not. V2 only.

=head2 UEI

This holds the SAM Unique Entity Identifier (UEI) and is 12 characters long. This number is only valid for V2 files on or after 2022.

=head2 xprogram

Exclusion Program identifies if the exclusion is Reciprocal, Nonreciprocal or Procurement.
For any exclusion record created on or after August 25, 1995, the value will
always be Reciprocal.

=head2 agency

Exclusion Agency identifies the agency which created the exclusion.

=head2 CT_code

This identifies the legacy Excluded Parties List System (EPLS) Cause & Treatment
(CT) Code associated with the exclusion. CT Codes were replayed by the Exclusion
Type in SAM. Exclusions created after August 2012 will not have CT Codes. They
will only have Exclusion Types.

=head2 xtype

This identifies the Exclusion Type for the record replacing the CT Code.
Exclusion Type is a simplified, easier to understand way to identify why the
entity is being excluded.

=head2 comments

This field provides the agency creating the exclusion space to enter additional
information as necessary. The maximum length allowed is 4000 characters.

=head2 creation_date

This field identifies the date the exclusion was created in SAM. It returns a DateTime
object. It accepts an input of the format MM/DD/YYYY, and converts it to a
DateTime object with the timezone used as America/New_York.

=head2 active_date

This field identifies the date the exclusion went active. It returns a DateTime
object. It accepts an input of the format MM/DD/YYYY, and converts it to a
DateTime object with the timezone used as America/New_York.

=head2 termination_date

This field identifies the date the exclusion will be terminated. The date
'12/31/2200' is denoted as indefinite exclusion for now. This field also returns
a DateTime object.

=head2 record_status

This identifies the record as begin Active or Inactive. This can be blank if the
record is active.

=head2 crossref

Identifies other names/aliases with which the entity being excluded has been
identified. For example, companies who do business under other names may have
those other names listed here.

=head2 SAM_number

The internal number used by SAM to identify exclusion records. Since only Firm
exclusion records are required to have a DUNS number, SAM needed a way to
uniquely track exclusion records of other classification types.

=head2 CAGE

The CAGE code associated with the excluded entity. Mostly found on Firm
exclusion records, but could be in other types if the Individual, Special
Entity, or Vessel has a CAGE code.

=head2 NPI

The National Provider Identifier (NPI) associated with the exclusion. Healthcare
providers acquire their unique 10-digit NPIs from the Centers for Medicare &
Medicaid Services (CMS) at the Department of Health & Human Services (HHS) to
identify themselves in a standard way throughout their industry.

=head1 AUTHOR

Vikas N Kumar <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2023 by Selective Intellect LLC.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut

__END__
### COPYRIGHT: Selective Intellect LLC.
### AUTHOR: Vikas N Kumar <[e-mail]>