Print Page as PDF
DGPF PATIENT RECORD FLAG ICR (3860)

DGPF PATIENT RECORD FLAG    ICR (3860)

Name Value
NUMBER 3860
IA # 3860
DATE CREATED 2003/07/08
CUSTODIAL PACKAGE REGISTRATION
CUSTODIAL ISC Albany
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DGPFAPI
NAME DGPF PATIENT RECORD FLAG
GENERAL DESCRIPTION

The purpose of this API is to facilitate the retrieval of specific data
that can be used for the displaying of or the reporting of only ACTIVE
Patient Record Flag (PRF) Assignment information for a patient.
The following Patient Record Flag files are used:
(#26.15) PRF NATIONAL FLAG
(#26.11) PRF LOCAL FLAG
(#26.13) PRF ASSIGNMENT
(#26.14) PRF ASSIGNMENT HISTORY
(#26.16) PRF TYPE
The primary mechanism is from within the Registration package.
STATUS Active
DURATION Till Otherwise Agreed
ID DGPFAPI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$GETACT(DFN,TARGET_ROOT)
This entry point is used to obtain only ACTIVE
Patient Record Flag (PRF) Assignment information for a patient that can be
used for Inquiry and Reporting purposes.  All ACTIVE Patient Record Flag
Assignments will be returned in a multiple subscripted local or global array,
"TARGET_ROOT", as a closed root reference.  Note that the TARGET_ROOT will be
initialized (killed) before being used.

MUMPS code example of use:
-------------------------------------
I $$GETACT^DGPFAPI(DFN,"DGPFAPI") W !,"DGPFAPI array contains all Active
Patient Record Flag Assignments for this patient."

VARIABLES TYPE VARIABLES DESCRIPTION
DFN [Required] Input
Internal entry number of patient in the PATIENT File
(#2).
$$GETACT Output

"0" = No Active Patient Record Flag for
the patient
"nn" = Total number of Active Flags being
returned in array
This number will be used to provide a
unique number for each Active Patient
Record Flag being returned.
TARGET_ROOT [Optional] Both
Input: Target Array name that should be passed as
a closed root reference.
If the parameter is not passed, then the
default name of the TARGET_ROOT is set
equal to "DGPFAPI".

Output: A multiple subscripted local or global array
format is used.

TARGET_ROOT(nn,subscript) = field value
where:
nn = a unique number for each Active Record Flag
subscript = a subscript being derived from the
following table below
field #/file # = global location of data value
field value = Internal value^External value
2 piece string caret(^)-delimited
ie... "int^ext"

subscript  field name             field #/file #
---------  -------------          --------------
"APPRVBY"  Approved By            (.05)/(#26.14)
The field value contains the pointer
to the NEW PERSON FILE (#200) of the
person approving the assignment of a
patient record flag to a patient.
The field values will be one of the
following two explanations:
1. If calling site IS the Originating
Site:
PIECE 1 = IEN of the (#200) file
PIECE 2 = Name of Person
2. If calling site NOT the Originating
Site:
PIECE 1 = .5
PIECE 2 = "CHIEF OF STAFF"
Note: The .5 (POSTMASTER) internal field
value triggers an output transform
that converts the external value of
"POSTMASTER" to "CHIEF OF STAFF".
"ASSIGNDT" Assignment Date/Time   (.02)/(#26.14)
The field value contains a FileMan
internal^external Date and Time of the
initial assignment of the Patient
Record Flag.
"REVIEWDT" Review Date            (.06)/(#26.13)
The field value contains a FileMan
internal^external date that the flag
assignment is due for review to
determine continuing appropriateness.
"FLAG"     Flag Name              (.02)/(#26.13)
The field value contains the Patient
Record Flag name that is assigned to
the patient as a variable pointer.
PIECE 1 = IEN variable pointer to the
(#26.11) or (#26.15) file
PIECE 2 = Name of Flag
"FLAGTYPE" Type of Flag (.03)/(#26.11 or #26.15)
The field value contains the Record
Flag Type usage classification.
(i.e. BEHAVIORAL,RESEARCH,CLINICAL)
PIECE 1 = IEN of the flag Type
(pointer to (#26.16) file)
PIECE 2 = Name of flag Type
"CATEGORY" National or Local Flag    (computed)
The field value contains the type of
category the flag represents.
I (NATIONAL) = (#26.15) PRF NATIONAL
II (LOCAL)   = (#26.11) PRF LOCAL
PIECE 1 = I (NATIONAL) or II (LOCAL)
PIECE 2 = (same value as PIECE 1)
"OWNER"    Owner Site             (.04)/(#26.13)
The field value contains the Site
that owns the patient's Record Flag
Assignment.  Only the Owner Site may
edit a patients flag assignment.
PIECE 1 = IEN of the site (pointer
to INSTITUTION FILE (#4))
PIECE 2 = Name of Institution
"ORIGSITE" Originating Site       (.05)/(#26.13)
The field value contains the Site
that first entered the Patient Record
Flag on this patient.
PIECE 1 = IEN of the site (pointer
to INSTITUTION FILE (#4))
PIECE 2 = Name of Institution "TIUTITLE"  TIU PN TITLE
(.07)/(#26.11)or(#26.15)
The field value contains the pointer
to the TIU Progress Note Title that is
associated with the Record Flag name.
PIECE 1 = IEN of the (#8925.1) file
PIECE 2 = TIU DOCUMENT DEFINITION name
Note: The "TIUTITLE" subscript will not
be returned in the array if the
calling site is not the Owner Site.
"TIULINK"  TIU PN LINK            (.06)/(#26.14)
The field value contains the pointer
to the TIU Progress Note that is
linked to the patients PRF Assignment
History record.
PIECE 1 = IEN of the (#8925) file
PIECE 2 = TIU DOCUMENT name
Note: The "TIULINK" subscript will not
be returned in the array if the
calling site is not the Owner Site.
"NARR"     Assignment Narrative     (1)/(#26.13)
(word-processing, multiple nodes)
The field value contains the reason
narrative for this patients assignment
of a Patient Record Flag.
The format is in a word-processing
value that may contain multiple nodes
of text.  Each node of text will be
less than 80 characters in length.
The format is as follows:
TARGET_ROOT(nn,"NARR",line#,0) = text
where:
nn = a unique number for each Flag
line# = a unique number starting at 1
for each word processing line
of narrative text
0 = standard subscript format for
the nodes of a FileMan Word
Processing field
GETACT(DFN,TARGET_ROOT)
See $$GETACT
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC SUBSCRIBING DETAILS
ORDER ENTRY/RESULTS REPORTING Salt Lake City
BAR CODE MED ADMIN
DSS - DECISION SUPPORT SYSTEM EXTRACTS
INPATIENT MEDICATIONS
OUTPATIENT PHARMACY
TEXT INTEGRATION UTILITIES
EMERGENCY DEPARTMENT
added 4/4/08
NATIONAL HEALTH INFO NETWORK
CLINICAL REMINDERS
effective 6/9/2010
VIRTUAL PATIENT RECORD
VA POINT OF SERVICE (KIOSKS)
HEALTH SUMMARY
GMTS is subscribing to this API so it can display PRF
owner site and history information from a Health Summary.  This is targeted
for release in GMTS*2.7*104 in October 2012.
HEALTH MANAGEMENT PLATFORM

****************************************************
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.
****************************************************


HMP makes calls to the GETACT^DGPFAPI to retrieve Active Patient Record Flag
(PRF) Assignment information for a patient that can be used for inquiry and
reporting purposes.
MENTAL HEALTH
Added 3/11/20 for access to GETACT^DGPFAPI.
AUTOMATED MED INFO EXCHANGE
Added 5/11/20, Effective with Patch DVBA*2.7*220