NPIUSED ICR (6888)

Name

Value

NUMBER

6888

IA #

6888

DATE CREATED

2018/03/13

CUSTODIAL PACKAGE

KERNEL

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XUSNPI1

NAME

NPIUSED

STATUS

Active

KEYWORDS

NPI

DURATION

Till Otherwise Agreed

XUSNPI1

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$NPIUSED(XUSNPI,XUSQID,XUSQIL,XUSRSLT,XUSIEN)

Extrinsic function used to return an error or warning
if an NPI is in use.

This API is meant to be called from code where a new NPI is being added to a
provider. It evaluates whether the NPI is currently or previously used by any
entity on files 200 (NEW PERSON), 4 (INSTITUTION) or 355.93 (IB NON/OTHER VA
BILLING PROVIDER). If it returns an error, the NPI should not be assigned to
the provider. If it returns a warning, the warning should be displayed to the
end user, but they should be allowed to add the NPI to the new provider.

VARIABLES	TYPE	VARIABLES DESCRIPTION
XUSNPI	Input	The NPI being checked. Required. No Default.
XUSQID	Input	The Qualified Identifier for the NPI. Required. No Default. (ex. "Individual_ID")
XUSQIL	Input	The delimited list of entities already using that NPI. This it the output from $$QI^XUSNPI in the format Qualified_Identifier^IEN^Effective_date/time^Active/I nactive; Required. No Default.
XUSRSLT	Output	An array containing either an error or warning message (if any).
XUSIEN	Input	Only set if this routine is being called from the input transform of the NPI field on files 4, 200 or 355.93. Set to the IEN of the entity being edited. This input parameter should ONLY be set if the routine is being called from an input transform!!! It suppresses return of the error or warning message! No Default.
$$NPIUSED	Output	No Error - If the NPI is not being used, or if the API is called from the input transform and the NPI was previously used by the current user, the API returns: '0' Error - If an error was found. XUSRSLT will contain the error message, and the API returns: '1' Warning - If the current file is NEW PERSON (#200) or IB NON/OTHER VA BILLING PROVIDER (#355.93), and if a provider on the other file has the NPI, a warning message is returned in XUSRSLT. (A provider can be both a VA and a non-VA provider at the same time). The API returns: '2'

SUBSCRIBING PACKAGE

DATE ACTIVATED

2018/03/14