Global: ^XIP(5.12

This field holds recognized postal codes.  Although this file will only start with US postal codes, it may be expanded in the future to also contain postal codes from other countries.

Field Reference Number: 2

Field Description: ZIP code

Logical Length: 5

Relative Position From/Thru: 02-06

1)= S ^XIP(5.12,"B",$E(X,1,30),DA)=""

2)= K ^XIP(5.12,"B",$E(X,1,30),DA)

This field holds the city represented by this Postal Code.

Field Reference Number: 5

Field Description: City State Name

Logical Length: 28

Relative Position From/Thru: 14-41

1)= S ^XIP(5.12,"C",$E(X,1,30),DA)=""

2)= K ^XIP(5.12,"C",$E(X,1,30),DA)

This field contains a pointer to the County that this Postal Code is within.

1)= S ^XIP(5.12,"AC",$E(X,1,30),DA)=""

2)= K ^XIP(5.12,"AC",$E(X,1,30),DA)

This field contains a pointer to the State File to represent the state associated with this Postal Code.

This is the date that the Postal Code became Inactive.

This is the unique City State Key that has been assigned by the USPS.

Field Reference Number: 3

Field Description: City State Key

Logical Length: 6

Relative Position From/Thru: 07-12

1)= S ^XIP(5.12,"D",$E(X,1,30),DA)=""

2)= K ^XIP(5.12,"D",$E(X,1,30),DA)

1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^XIP(5.12,D0,0)):^(0),1:"") S X=$P(Y(1),U,9),X=X S DIU=X K Y X ^DD(5.12,5,1,2,1.1) S DIH=$G(^XIP(5.12,DIV(0),0)),DIV=X S $P(^(0),U,9)=DIV,DIH=5.12,DIG=8 D ^DICR

1.1)= S X=DIV S Y(1)=$S($D(^XIP(5.12,D0,0)):^(0),1:"") S X=$P(Y(1),U,1),Y(2)=$G(X) S X=DIV,Y=X,X=Y(2),X=X_Y

2)= Q

CREATE VALUE)= ((#.01)_(#5))

DELETE VALUE)= NO EFFECT

FIELD)= UNI

The field value is created by the concatenation of the MAIL CODE(#.01) field and the CITY KEY(#5) that creates a unique key for lookups. The value is stuffed into the UNIQUE KEY(#8).

This key is assigned by USPS.

Field Reference Number: 9

Field Description: Preferred Last Line City State Key

Logical Length: 6

Relative Position From/Thru: 57-62

If this field equals 'UNIQUE CITY KEY' then this city is considered the DEFAULT city.  On the other hand, if this is not equal to 'UNIQUE CITY KEY' then the city is considered an ACCEPTABLE city.

This field contains the USPS's city abbreviation.

Field Reference Number: 6

Field Description: City State Name Abbreviation

Logical Length: 13

Relative Position From/Thru: 42-54

This field is the value when the MAIL CODE(#.01) and the CITY KEY(#6) are concatenated.  The purpose of this field is to create a unique lookup value using the "E" cross-reference.

unique lookup value.  For example:

Case A:

Zip code: 26452

City Name: VALLEY CHAPEL, City Key: X2A444, Unique Key: 26452X2A444

City Name: WESTON, City Key: X29362, Unique Key: 26452X29362

Case B:

City: HAGERSTOWN, City Key: V23622, Zip code: 21740 UKey: 21740V23622

City: HAGERSTOWN, City Key: V23622, Zip code: 21741, UKey: 21741V23622

City: HAGERSTOWN, City Key: V23622, Zip code: 21742, UKey: 21742V23622

City: HAGERSTOWN, City Key: V23622, Zip code: 21746, UKey: 21746V23622

City: HAGERSTOWN, City Key: V23622, Zip code: 21747, UKey: 21747V23622

WRITE AUTHORITY:  ^

1)= S ^XIP(5.12,"E",$E(X,1,30),DA)=""

2)= K ^XIP(5.12,"E",$E(X,1,30),DA)