Print Page as PDF
TIU APIS FOR VPR ICR (6077)

TIU APIS FOR VPR    ICR (6077)

Name Value
NUMBER 6077
IA # 6077
DATE CREATED 2014/07/16
CUSTODIAL PACKAGE TEXT INTEGRATION UTILITIES
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE TIUVPR
NAME TIU APIS FOR VPR
GENERAL DESCRIPTION 
TIUVPR provides generic api's to allow the Virtual
Patient Record (VPR) to retrieve all of a patient's documents, regardless of
status or class.  Class and authorization filters will be applied by the
Health Management Platform (HMP) as documents are requested by the current
user.
STATUS Active
KEYWORDS TIUVPR
DURATION Till Otherwise Agreed
ID TIUVPR
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
GET(.TIUY,DFN,TYPE,EARLY,LATE) 
Returns all documents for the patient in the
requested class, subscripted by sequence number

***Warning on Component GET ***

For Component GET users are warned that documents whose dates are outside of
the date range are not listed even if they have addenda within the date range.
VARIABLES TYPE VARIABLES DESCRIPTION
TIUY Output 
Name of result array, as a closed reference Returns
@TIUY@(#)=DA and @TIUY@("COUNT")=total#
DFN Input 
Patient file #2 ien
TYPE Input 
Document Class #8925.1 ien
EARLY Input 
Date.time to begin search [optional]
LATE Input 
Date.time to end search [optional]
LIST(.TIUY,DFN,TYPE,EARLY,LATE,STATUS) 
Returns all documents for the patient [in the
requested class], subscripted by Document #8925 ien
VARIABLES TYPE VARIABLES DESCRIPTION
TIUY Output 
Passed by reference, to return result array name
Returns @TIUY@(DA)="" and @TIUY@("COUNT")=total#
DFN Input 
Patient file #2 ien
TYPE Input 
Code indicating the type of documents to return:
PN,CR,C,W,A,D,DS,SR,CP,LR, or ALL [default] (Document Class #8925.1 ien also
accepted)
EARLY Input 
Date.time to begin search [optional]
LATE Input 
Date.time to end search [optional]
STATUS Input 
TIU Status #8925.6 Name [optional, default=COMPLETED]
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
VIRTUAL PATIENT RECORD
HEALTH MANAGEMENT PLATFORM 
HMP routine HMPDJ0 calls the GET^TIUVPR API to retrieve
all the documents for a specified patient in the requested class.

HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP.
HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps
for the sites to shut down the application.

If HMP is reactivated in the future, the HMP project team should review the
access provided by this ICR with the custodial application before reactivating
HMP's subscription to this ICR. See VistA Document Library for list of retired
HMP ICRs.
DATE ACTIVATED 2014/09/24