Print Page as PDF
DBIA1911 ICR (1911)

DBIA1911    ICR (1911)

Name Value
NUMBER 1911
IA # 1911
DATE CREATED 1997/01/24
CUSTODIAL PACKAGE TEXT INTEGRATION UTILITIES
CUSTODIAL ISC Salt Lake City
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE TIUPNAPI
NAME DBIA1911
GENERAL DESCRIPTION 
This API may be called by an application on the VistA
server to create a TIU Document with the following constraints and optional
properties:

Return variable (must pass by reference):

TIUIFN (pass by ref) = New note IFN in file 8925,
= -1 or variations if error.

Required Input parameters:

DFN                  = Patient IFN in file #2
TIUAUTH              = Author IFN in file #200
TIURDT               = Date/time of note in FM format
TIUTITLE             = Title IFN in file 8925.1

Required global "input" variable:

^TMP("TIUP",$J)      = Array root for text in format compatible
with FM Word-processing fields. e.g.,
^TMP("TIUP",$J,0)=^^1^1^2961216^
^TMP("TIUP",$J,1,0)=Testing the TIUPNAPI.

Optional Input variables:

TIULOC              = Patient Location IFN in file #44
TIUES               = 1 if TIU should prompt/process E-SIG
TIUPRT              = 1 if TIU should prompt user to print note
TIUESBY             = Signer IFN in file #200:  Calling App is
responsible for Electronic Signature
TIUASKVS            = BOOLEAN flag indicating whether to ask for visit
TIUADEL             = BOOLEAN flag for automatic delete instead of
leaving UNSIGNED document if TIUESBY>0 and
signature fails.  See NOTE on TIUADEL, below.

NOTE: The following change was made in patch TIU*1*184 in response to a
patient safety issue where SIGNED notes were sometimes created without a valid
expected cosigner being specified for users requiring cosignature.

If the API is called non-interactively for a user requiring cosignature with
the intention that the API create a SIGNED document (TIUESBY>0), then the
signature will now FAIL.  Generally signature failure leaves the document
unsigned.  However, if TIUADEL=1, signature failure deletes the document.

** Therefore we do not recommend the use of TIUADEL in this particular
situation (non-interactive, user requires cosignature, TIUESBY>0). **
STATUS Active
DURATION Till Otherwise Agreed
ID TIUPNAPI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
NEW 
To file a TIU Document from a VistA M-application,
call:

NEW^TIUPNAPI(TIUIFN,DFN,TIUAUTH,TIURDT,TIUTITLE,TIULOC,
TIUES,TIUPRT,TIUESBY,TIUASKVS,TIUADEL)

NOTE: per VistA SAC, all input parameters passed by reference in the formal
list should be namespaced for the calling application.
VARIABLES TYPE VARIABLES DESCRIPTION
TIUIFN Output 
Passed by Reference.

If the call to NEW^TIUPNAPI is successful, the internal entry number in file
8925 will be returned.

If the call is unsuccessful, the return variable will be set to -1 or a
variation.
DFN Input 
Pass by value. Required.

This is the Internal Entry Number of the patient in the PATIENT File (#2).
TIUAUTH Input 
Pass by value. Required.

This is the internal entry number of the AUTHOR of the note in the NEW PERSON
File (#200).
TIURDT Input 
Pass by value. Required.

Reference Date/time of document in internal FM format.
TMP Input 
The temporary global array ^TMP("TIUP",$J) MUST be
loaded with the word- processing data to be filed with the note, prior to
calling the API, using the following subscripting scheme:

^TMP("TIUP",$J,0)="^^<# lines>^<# lines>^
<today's date (int FM)>^                        ^TMP("TIUP",$J,1,0)="<first
line of text>"        ^TMP("TIUP",$J,2,0)="<second line of text>"
^TMP("TIUP",$J,3,0)="<third line of text>"        ^TMP("TIUP",$J,n,0)="<nth
line of text>"
TIULOC Input 
Pass by value. Optional.

This is the Internal Entry Number of the LOCATION in the HOSPITAL LOCATION
File (#44).
TIUES Input 
Pass by Value. Optional.

BOOLEAN flag. Pass as 1 if you want TIU to prompt for Electronic Signature.
TIUPRT Input 
Pass by Value. Optional.

BOOLEAN flag. Pass as 1 if you want TIU to prompt for printing on completion.
TIUESBY Input 
Pass by Value. Optional.

Pass IEN of the person whose electronic signature is to be applied to the
document. ONLY pass this if the calling application has already prompted
for/validated the user's electronic signature.
TIUASKVS Input 
Pass by Value. Optional.

BOOLEAN flag. Pass as 1 if you want TIU to prompt for selection of a visit
with which the document is to be associated.
TIUADEL Input 
Optional.

BOOLEAN flag.  Pass as a 1 if TIUESBY>0 and calling application wants to have
the newly created document automatically deleted if the electronic signature
fails for any reason. If TIUADEL is not set, the document is left UNSIGNED.

If TIUESBY>0 and the API is called non-interactively for users who require
cosignature, we do NOT recommend the use of TIUADEL.  See general description
of API.
TIUTITLE
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC SUBSCRIBING DETAILS
ADVERSE REACTION TRACKING Salt Lake City
MENTAL HEALTH Dallas 
The Addiction Severity Index (ASI) module of Mental
Health uses this call to file ASI notes.
LAB SERVICE
OUTPATIENT PHARMACY
IMAGING
DIETETICS 
added 12/10/2007