DBIA3457 ICR (3457)

Name

Value

NUMBER

3457

IA #

3457

DATE CREATED

2001/09/18

CUSTODIAL PACKAGE

REGISTRATION

CUSTODIAL ISC

Albany

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

DGNTAPI

NAME

DBIA3457

GENERAL DESCRIPTION

The purpose of this API is to facilitate the retrieval
of veterans' Nose/Throat Radium (NTR) Treatment information from the NOSE AND
THROAT RADIUM HISTORY (#28.11) file.  The primary mechanism is within the
Registration package.

STATUS

Active

DURATION

Till Otherwise Agreed

DGNTAPI

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$GETCUR(DFN,TARGET_ROOT)

The $$GETCUR^DGNTAPI(DFN,TARGET_ROOT) entry point
will be used to obtain a patient's primary/current record from the NOSE AND
THROAT RADIUM HISTORY (#28.11) file and place it in the local target array,
TARGET_ROOT, passed as a closed root reference.

Example of use:
--------------
I $$GETCUR^DGNTAPI(DFN,"DGNT") D
. W !,"DGNT array now contains patient's primary NTR record."

VARIABLES

TYPE

VARIABLES DESCRIPTION

DFN

Input

IEN of patient in the PATIENT File (#2)

$$GETCUR

Output

IEN of primary entry in NOSE AND THROAT RADIUM
HISTORY File (#28.11)

"0"- If no NTR history entry is found for the patient.

TARGET_ROOT

Both

Input: (Optional) Target Array name that should be
passed as a closed root reference.  If the parameter is not passed, then the
default TARGET_ROOT is set equal to "DGNTAPI".

Output: The output array is in the format of TARGET_ROOT(subscript) with
subscript being derived from the following table:

subscript  field name           field val
---------  --------------       ---------
"DFN"      Patient              internal "IND"      NTR Indicator
int^ext "STAT"     Screening Status     int^ext "NTR"      NTR Treatment
int^ext "AVI"      Aviator Pre 1/31/55  int^ext "SUB"      Submarin Pre 1/1/65
int^ext "EDT"      Date/Time NTR Enter  internal "EUSR"     NTR Entered By
internal "PRIM"     NTR Primary Entry    internal "SUPER"    Date/Time
Supersede  internal "VER"      Verification Method  int^ext "VDT"
Date/Time Verified   internal "VUSR"     Verified By          internal "VSIT"
Site Verifying Doc   internal "HNC"      Head/Neck CA DX      int^ext "HDT"
Date/Time DX Verif   internal "HUSR"     DX Verified By       internal
"HSIT"     Site Verifying DX    internal