Print Page as PDF
ADDITIONAL APIS FOR NDF ICR (2574)

ADDITIONAL APIS FOR NDF    ICR (2574)

Name Value
NUMBER 2574
IA # 2574
DATE CREATED 1998/09/23
CUSTODIAL PACKAGE NATIONAL DRUG FILE
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PSNAPIS
NAME ADDITIONAL APIS FOR NDF
GENERAL DESCRIPTION
This DBIA describes additional Application Programmer
Interfaces (APIs) for the National Drug File.  APIs described here are in
addition to those described in DBIA # 2531.
STATUS Active
DURATION Till Otherwise Agreed
ID PSNAPIS
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
TTOG
S X=$$TTOG^PSNAPIS(TRADE,.LIST) where TRADE is a free
text trade name and LIST is an array defined by the calling application
returns
LIST(IEN)=IEN^GENERIC NAME where IEN is the internal entry number in File
#50.6 and GENERIC NAME is the .01 field of that file for every entry which has
the given trade name.  Also returns X as the number of entries in LIST.

CLIST
S X=$$CLIST^PSNAPIS(DA,.LIST) where DA is an internal
entry number in File #50.6 and LIST is an array defined by the calling
application returns LIST(IEN)=IEN^CLASS where IEN is the internal entry number
in File #50.605 and CLASS is the 5 character class code for every class
associated with that entry in File #50.6.  Also returns X as the number of
entries in LIST.

TGTOG
S X=$$TGTOG^PSNAPIS(NAME) where NAME is a free text
entry returns X=IEN from the VA GENERIC file (#50.6) if NAME is either a valid
Name from the VA GENERIC file (#50.6) or if NAME is a valid Trade Name from
the NDC/UPN file (#50.67).  Returns X=0 otherwise.
TGTOG2
S X=$$TGTOG2^PSNAPIS(NAME,.LIST) returns
LIST(IEN)=IEN^GENERIC NAME where IEN is the internal entry number in File
#50.6 and GENERIC NAME is the .01 field of that entry for all entries for
which NAME is a partial or exact match to either the trade name or the generic
name.  Also returns X as the number of entries in LIST.

CIRN2
S X=$$CIRN2^PSNAPIS(P1,P3,.LIST) where P1 and P3 are
the first and third pieces of the ND node in File #50 and LIST is an array
defined by the calling application returns LIST(J)=NDC where J is a simple
index and NDC is a twelve character National Drug Code (NDC) for all NDCs
associated with the product specified by P1 and P3.  Also returns X as the
number of entries in LIST.

CLASS2
S X=$$CLASS2^PSNAPIS(IEN) where IEN is an internal
entry number in File #50.605 returns X as the first two pieces of the zero
node in that entry.

FORMI
S X=$$FORMI^PSNAPIS(P1,P3) where P1 and P3 are the
first and third pieces of the "ND" node in File #50 for a selected entry
returns X=1 if the item is on the National Formulary, X=0 otherwise.

FORMR
S X=$$FORMR^PSNAPIS(P1,P3) where P1 and P3 are the
first and third pieces of the "ND" node in File #50 for a selected entry
returns X=1 if there are restrictions placed on the item, X=0 otherwise.

CMOP
S X=$$CMOP^PSNAPIS(CODE) where code is a five
character CMOP identifier (e. g. A0105) returns X equal the corresponding
product name if CODE is a valid identifier, null otherwise.

FORMRX
S X=$$FORMRX^PSNAPIS(DA,K,.LIST) where DA and K are
the first and third pieces of the ND node in File #50 for the chosen drug
returns X=1 if there are formulary restrictions, 0 if there are not.  Also, if
there are restrictions, returns LIST as the word-processing field describing
these restrictions.

$$DDIEX(VAR1,VAR2)
VARIABLES TYPE VARIABLES DESCRIPTION
VAR1 Input
piece one of the "ND" node of ^PSDRUG file 50
NATIONAL DRUG FILE ENTRY field 20
VAR2 Input
piece three of the "ND" node of ^PSDRUG file 50
PSNDF VA PRODUCT NAME ENTRY field 22
$$DDIEX Output

1 indicates that a drug has been exempted from drug-drug interaction order
checking.

0 indicates that a drug is not exempted from drug-drug interaction order
checking.