Print Page as PDF
DGPF ASSIGNMENT LINK TIU PN ICR (4383)

DGPF ASSIGNMENT LINK TIU PN    ICR (4383)

Name Value
NUMBER 4383
IA # 4383
DATE CREATED 2004/03/29
CUSTODIAL PACKAGE REGISTRATION
CUSTODIAL ISC Albany
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DGPFAPI1
NAME DGPF ASSIGNMENT LINK TIU PN
GENERAL DESCRIPTION
The purpose of this API is to facilitate the retrieval
of specific data for an active or inactive Patient Record Flag Assignment to
determine whether a TIU Progress Note has been entered for each assignment
history record.  If the request is not from the Owner Site of the Assignment,
no data is returned.
STATUS Active
DURATION Till Otherwise Agreed
ID DGPFAPI1
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$GETHTIU(DFN,DGTITLE,TARGET_ROOT)
This function entry point is used to search for and
retrieve specific data for a patients (active or inactive) Patient Record Flag
Assignment.  The TIU Progress Note Title IEN will be used to search for the
patient assignment that is linked by the associated Patient Record Flag to
that TIU Progress Note Title.  If the request is not from the Owner Site of
the Assignment, no data is returned.  All Patient Record Flag data will be
returned in a user named closed root array (local or global) that will contain
multiple subscripts.  This array is referred to as "TARGET_ROOT" in this text.

Note that the TARGET_ROOT will be initialized (killed) before being used.

MUMPS code example of use:
--------------------------
I $$GETHTIU^DGPFAPI1(DFN,DGTITLE,"DGPFHTIU") D . W !,"DGPFHTIU array contains
PRF Assignment History data for this patient."

VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
[Required]
IEN of patient in the PATIENT File (#2)

DGTITLE Input
[Required]
Pointer to the TIU DOCUMENT (#8925.1) file.
This pointer represents the TIU Progress Note
Title that could be associated with a National
or Local Patient Record Flag.  The IEN is
stored in (Field #.07) of the PRF LOCAL FLAG
(#26.11) or the PRF NATIONAL FLAG (#26.15)
file.  The patient Assignment can then be
found by using the Flag name pointer that is
setup in each (#26.13) record.

$$GETHTIU Output

"0" = Failure = "0^Error Message of what failed"
(2 piece string (^)-delimited)
"1" = Successful

TARGET_ROOT Both
[Optional]
Input: Target array name that should be passed
as a closed root reference, local or
global.  If the parameter is not passed,
then the default name of the TARGET_ROOT
is set equal to "DGPFHTIU".

Output: A multiple subscripted array format
is returned.

TARGET_ROOT(subscript) = field value
where:
subscript = a subscript being derived from
the following table below:
field value = Internal value^External value
2 piece string (^)-delimited
i.e. - "int^ext"
field#/file# = global location of data value


subscript    field name        field #/file #
-----------  -------------     ---------------
"ASSIGNIEN"  Assignment IEN   (.001)/(#26.13)
The field value contains the
pointer to the Patient Record Flag
Assignment file (#26.13) record.
PIECE 1=IEN of (#26.13) file
PIECE 2=Name of Patient assigned to flag

"FLAG"       Flag Name         (.02)/(#26.13)
The field value contains the
Patient Record Flag name that is
assigned to the patient.
PIECE 1=IEN variable pointer to the
(#26.11) or (#26.15) file
PIECE 2=Name of Flag

"HISTORY"    History Record(s)   Multiple Nodes
This subscript level will
contain a unique node for each
PRF Assignment History record
created for the Assignment.

The multiple subscript node format is as
follows:

TARGET_ROOT("HISTORY")=nn
where:
nn = total number of History Records
returned

TARGET_ROOT("HISTORY",nn,"Subscript")=int^ext
where:
nn = unique number for each History rec.
"Subscript" = history field name
Subscript names: "ACTION"
"APPRVBY"
"DATETIME"
"HISTIEN"
"ORIG FAC"
"TIUIEN"

TARGET_ROOT("HISTORY",nn,"ACTION")=int^ext
Action of History       (.03)/(#26.14)
The field value contains the event
that occurred to create the Assignment
History record.
PIECE 1 = internal action code number
PIECE 2 = external action text

TARGET_ROOT("HISTORY",nn,"APPRVBY")=int^ext
Approved By of History  (.05)/(#26.14)
The field value contains the person who
approved this change to the Assignment
History record.
PIECE 1 = IEN of (#200) file
PIECE 2 = external person name

TARGET_ROOT("HISTORY",nn,"DATETIME")=int^ext
History Assignment DT  (.02)/(#26.14)
The field value contains a FileMan
internal^external create Date/Time of
the Assignment History record.
PIECE 1 = internal Fileman date
PIECE 2 = external Fileman date

TARGET_ROOT("HISTORY",nn,"HISTIEN")=int^ext
History IEN            (.001)/(#26.14)
The field value contains the
pointer to the PRF Assignment History
file (#26.14) record.
PIECE 1 = IEN of (#26.14) file
PIECE 2 = (same value as PIECE 1)

TARGET_ROOT("HISTORY",nn,"ORIG FAC")=int^ext
Originating Facility for this History record
(.03)/(#26.14)
The field value contains the facility
that created this Assignment History record.
PIECE 1 = IEN of (#4) file
PIECE 2 = external Institution name

TARGET_ROOT("HISTORY",nn,"TIUIEN")=int^ext
TIU PN LINK            (.06)/(#26.14)
The field value contains the pointer
of the linked TIU Progress Note of the
TIU DOCUMENT (#8925) file.
PIECE 1 = IEN of (#8925) file
PIECE 2 = TIU DOCUMENT name
(Note:  Null values returned if no IEN.)
$$FNDTITLE(DGTITLE)
This function entry point is used to search for and
retrieve the IEN and External name value of either a PRF LOCAL FLAG (#26.11)
or PRF NATIONAL FLAG (#26.15) file entry that has been linked to a TIU
DOCUMENT DEFINITION (#8925.1) file IEN.

MUMPS code example of use:

W $$FNDTITLE^DGPFAPI1(DGTITLE)
1;DGPF(26.15,^BEHAVIORAL


VARIABLES TYPE VARIABLES DESCRIPTION
DGTITLE Input

[Required]
IEN of a TIU DOCUMENT DEFINITION (#8925.1) file entry.

$$FNDTITLE Output

(returns 2 piece string (^)-delimited)

On Failure - 0^error text from $$EZBLD^DIALOG
On Success - IEN^External Flag Name

[example:  1;DGPF(26.15,^BEHAVIORAL]
[Note:    "1;DGPF(26.15," is a variable pointer]

$$GETLINK(DGTIUIEN)
This function entry point is used to search for and
retrieve the IEN of the PRF ASSIGNMENT HISTORY (#26.14) record that is linked
to the TIU DOCUMENT (#8925) record.  If no link is found, the function call
will return a 0 value.

MUMPS code example of use:

W $$GETLINK^DGPFAPI1(DGTIUIEN)
2532

VARIABLES TYPE VARIABLES DESCRIPTION
DGTIUIEN Input

[Required]
IEN of the TIU DOCUMENT (#8925) record.

$$GETLINK Output

"0" = Failure
"###" = Successful - IEN of linked history record

SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC
TEXT INTEGRATION UTILITIES Salt Lake City
CREATOR MCPHELAN,STEVEN
DBA Comments
2/28/18-MM:  Deactivated ICR #4383 for editing.  Requestor's
project team (Liberty) has a contract to make modifications the VistA module
Patient Record Flags (PRF) in the DG namespace for High Risk for Suicide
initiatives. Liberty is representing both VistA applications and will be
making all modifications as necessary in both DG and TIU and CPRS which
invokes a TIU RPC to retrieve information from PRF.  There is additional
information requested to be added to the return array for that RPC.  Patches
are DG*5.3*951 and TIU*1.0*318.

Steve will be adding "APPROVBY" and "ORIG FAC" as subscript names to
TARGET_ROOT("HISTORY",nn,"Subscript"-int~ext node. New "APPRVBY" node added to
TARGET_ROOT("HISTORY",nn array:

TARGET_ROOT("HISTORY",nn,"APPRVBY")=int^ext
Approved By of History (.05)/(#26.14)
The field value contains the person who
approved this change to the Assignment
History record.
PIECE 1 = IEN of (#200) file
PIECE 2 = external person name

5/29/18-DT: Shavkat tested for any adverse impact to TIU/CPRS functionality
and found no issues.  Andrew Bakke approved for TIU and Darryl Reese approved
for DG.  Bakke
DATE ACTIVATED 2018/05/29
MAIL MESSAGE 88085918
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2018/02/28 09:59 DEACTIVATED FOR EDITS MCPHELAN,STEVE BAKKE,ANDREW
2018/05/29 10:40 APPROVED SHAMUKHAMEDOV,SHAVKAT BAKKE,ANDREW
Generated from AUG 12, 2020@ IA Listing Descriptions