Print Page as PDF
VIC API ICR (5888)

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
ID DPTLK
COMPONENT/ENTRY POINT
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
CREATOR ZEIGLER,EDWARD L
DBA Comments
11/20/13-MM:  Activated ICR #5888.  DG*5.3*857 released on
8/22/13 provided the RPCVIC API in DPTLK for use with the new VIC cards.
LR*5.2*435, VPS*1.0*2 and PSB*3*70 will be using the new RPC.

1/27/14-MM:  Added GEN. MED. REC. - VITALS as a subscriber to ICR #5888 for
GMRV*5*29. The vendor of the Pyxis Nurse Data Collection application
discovered the inability to use the VHIC 4.0 bar code during testing and
identified the 'GMV PT Select' RPC, which relies on the old API, as the
source.

The new VHIC 4.0 does not contain the patient's SSN within the bar code.
Instead it contains an identifier that is mapped to the patient in the Master
Veteran Index. To support using the bar code on the new Veterans Health
Identification Card (VHIC) 4.0, the VHIC team updated the API used to look-up
patients. However, each application that looks up patients needs to subsrcibe
to the new API.

4/4/14-MM:  Ed requested future subscribers to this ICR should would with
Identity Management team.
DATE ACTIVATED 2013/11/20
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2013/11/20 11:42 APPROVED ZEIGLER,ED ZEIGLER,ED
2014/01/27 10:53 SUBSCRIBER ADDED MCNEILE,KEN ZEIGLER,ED
Generated from JAN 24, 2019@ IA Listing Descriptions