Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

$$NPI^XUSNPI(): Get NPI from Files #200, #4, or #355.93

Reference Type: Controlled Subscription, Category: National Provider Identifier (NPI), ICR#: 4532

Description

The $$NPI^XUSNPI extrinsic function retrieves the National Provider Identifier (NPI) and related utilities from any of the following files:

NOTE: This API was released with Kernel Patch XU*8.0*410.

Format

  $$NPI^XUSNPI(xusqi,xusien[,xusdate])

Input Parameters

xusqi:

(required) The Qualified Identifier for the NPI. For example:

    Individual_ID, Organization_ID, or Non_VA_Provider_ID

No default.
xusien:

(required) The Internal Entry Number (IEN) from any of the following files:

  • NEW PERSON (#200)

  • INSTITUTION (#4)

  • IB NON/OTHER VA BILLING PROVIDER (#355.93)

No default.
xusdate:

(optional) A date of interest. Defaults to "Today".

Output

returns:

Returns any of the following strings:

  • NPI^EffectiveDate^Status—If National Provider Identifier (NPI) exists.

  • 0—If NPI does not exist.

  • -1^ErrorMessage—If invalid xusqi or xusien input parameters.

Example 1

The following example uses the following file data:

>W $$NPI^XUSNPI("Individual_ID",82)
9876543213^3061108.123651^Active

Example 2

The following example uses the following file data:

>W $$NPI^XUSNPI("Organization_ID",1)
1111111112^3070122^Active

Example 3

The following example uses the following file data:

>W $$NPI^XUSNPI("Non_VA_Provider_ID ",1)
2222222228 ^3070122^Active