VIC API ICR (5888)

Name

Value

NUMBER

5888

IA #

5888

DATE CREATED

2012/12/13

CUSTODIAL PACKAGE

REGISTRATION

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

DPTLK

NAME

VIC API

GENERAL DESCRIPTION

Allows patient lookup based on VIC card value.  The
value can be from a legacy VIC or a newer VIC 4.0 card.  The value can be the
data from the swipe (magnetic stripe) input or the scan (barcode) of the card.
Using applications should not attempt to parse the card value but pass into
the API the whole card value and allow the API to parse the values needed.

Example of usage within M code:
R X:DTIME Q:'$T!(X=U)
X ^%ZOSF("EOFF") R X(1):1 X ^%ZOSF("EON")
D RPCVIC^DPTLK(.DFN,X)
I DFN<1 W !,"Patient not in database, use ADT options to load patient" Q

With this example the DFN is now defined to the patient.

STATUS

Active

KEYWORDS

DPTLK
VIC

DURATION

Till Otherwise Agreed

DPTLK

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

RPCVIC

This entry point should be used to obtain a local
VistA system lookup based on the card data being consumed.

VARIABLES

TYPE

VARIABLES DESCRIPTION

RETURN

Input

Pass by reference where the return value should be
returned.  The return value will either be:
DFN = If the patient was successfully found in the local VistA system the
patient's DFN will be returned
-1 = If the patient was not successfully found (i.e. not locally
registered or invalid card input)

DPTX

Input

This should be the entire input from either the
card's magnetic strip or barcode.

SUBSCRIBING PACKAGE

DATE ACTIVATED

2013/11/20