Print Page as PDF
PATIENT RECORD FLAG DATA RETRIEVAL ICR (4903)

PATIENT RECORD FLAG DATA RETRIEVAL    ICR (4903)

Name Value
NUMBER 4903
IA # 4903
DATE CREATED 2011/01/06
CUSTODIAL PACKAGE REGISTRATION
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DGPFAPIH
NAME PATIENT RECORD FLAG DATA RETRIEVAL
GENERAL DESCRIPTION
These API's provide a means to retrieve detailed
Patient Record Flag information by patient and patient record flag, and, to
retrieve a list of patients with a specific assigned patient record flag
during a specified date range.
STATUS Active
KEYWORDS PATIENT RECORD FLAGS
DURATION Till Otherwise Agreed
ID DGPFAPIH
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
GETINF
This function will return detailed information from
the Patient Record Flag files for the specified patient and PRF flag.  A date
range for active PR Flags is optional.  Data array output example:

DGARR("ASSIGNDT") - Date of initial assignment.
i.e. 3110131.093248^Jan 31, 2011@09:32:48) DGARR("CATEGORY") - National
or Local flag category.
i.e. II (LOCAL)^II (LOCAL) DGARR("FLAG") - Variable pointer to
Local/National flag files and flag name.
i.e. 1;DGPF(26.11,^HIGH RISK FOR SUICIDE DGARR("FLAGTYPE") - Type of
flag usage.
i.e. 1^BEHAVIORAL DGARR("HIST",n,"ACTION") - Type of action for history
entry
i.e. 1^NEW ASSIGNMENT DGARR("HIST",n,"APPRVBY") - Person approving the
flag assignment
i.e. 112345^PERSON,STEVE DGARR("HIST",1,"COMMENT",1,0) - Comment for
record assignment action
i.e "New record flag assignment." DGARR("HIST",n,"DATETIME") -
Date/Time of Action
i.e. 3110131.093248^JAN 31, 2011@09:32:48 DGARR("HIST",n,"TIULINK") -
Pointer to the TIU Document file (#8925)
i.e. "^" DGARR("NARR",n,0) - Describes the purpose and instructions for
the application of the flag.
i.e. "TEST ENTRY" DGARR("ORIGSITE") - Site that initially assigned this
flag (Relevant to National flags only)
i.e. 500^ALBANY.VA.GOV DGARR("OWNER") - Site which currently "Owns"
this flag (Relevant to National flags only)
i.e. 500^ALBANY.VA.GOV DGARR("REVIEWDT") - Date for next review of
record flag assignment
i.e. 3110501^MAY 01, 2011 DGARR("TIUTITLE") - Pointer to the TIU
Document Definition file (#8925.1)
i.e. 1309^PATIENT RECORD FLAG CATEGORY II - RESEARCH STUDY
VARIABLES TYPE VARIABLES DESCRIPTION
DGDFN Input
This is the DFN (IEN) for the patient in the PATIENT
File (#2).  This is a required variable.
DGPRF Input
Variable pointer to either the PRF LOCAL FLAG File
(#26.11) or to the PRF NATIONAL FLAG file (#26.15).  This is a required
variable.

For National Flags:  IEN;DGPF(26.15,
For Local Flags:  IEN;DGPF(26.11,
DGSTART Input
Start date for when to begin search for active PRF
flags.  This date must be in FM format, i.e. 3110106.  This variable is
optional, if null, searches will begin with the earliest assigned entry in the
PRF ASSIGNMENT HISTORY file (#26.14)
DGEND Input
End date for the search for active PRF entries.  This
date must be in FM format, i.e. 3110107.  This variable is optional, if null
or not passed in, all entries to the end of the PRF ASSIGNMENT HISTORY file
(#26.14) will be searched.
DGARR Both
This variable contains the array name for the return
data.  This is optional.  If an array name is not specified, the return data
is returned in local array "DGPFAPI1".
DGRSLT Output
Return value from the API call.  Returns "1" if the
API was successful in returning PRF data, returns "0" if the API was
unsuccessful in returning PRF data.
GETLST
This function call returns a list of patients with a
specified Patient Record Flag assigned for a specified date range.

DGARR(DFN,n) - Patient Name^VPID^Date of initial assignment^National or
Local flag category^flag name

Example:
DGARR(9999955648,0)="EASPATIENT,ONE A^5000000295V790537^3100201.103713^II
(LOCAL)^HIGH RISK FOR SUICIDE"
VARIABLES TYPE VARIABLES DESCRIPTION
DGPRF Input
Variable pointer to either the PRF LOCAL FLAG File
(#26.11) or the PRF NATIONAL FLAG File (#26.15). This variable is required.

National:  IEN;DGPF(26.15,
Local:  IEN;DGPF(26.11,
DGSTART Input
This is the start date to begin searching for
patients with the assigned Patient Record Flag.  This date must be in FM
format, i.e. 3100110. This variable is optional.
DGEND Input
This is end date for the search range for patients
with the assigned Patient Record Flag.  This date must be in FM format, i.e.
3100112. This variable is optional.
DGARR Both
This variable contains the array name where the
returned patient information will be placed.  This is optional, if an array
name is not specified, the data will be returned in a TMP Global,
^TMP("PRFLST").
DGRSLT Output
This variable returns a count of the patients placed
in the return list.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
SCHEDULING
Scheduling requires Patient Record Flag information as
part of a new missed appointment report supporting the High Risk Mental Health
Initiative.  This report needs to be able to determine which patients  missing
a recent appointment have a specified Patient Record Flag assigned.
CLINICAL REMINDERS
Retrieval of High Risk Mental Health Patient Flag
information.
HEALTH SUMMARY
ADDED 7/19/2011
INTEGRATED BILLING
CREATOR KOPECKY,STEPHEN C
DBA Comments
2/1/18-MM:  Added IB as a subscriber to ICR #5491 and 4903 for
IB*2.0*614.  The Suicide High Risk Patient Enhancements (SHRPE) product needs
to determine if a National flag is active on the date of service.
DATE ACTIVATED 2011/06/07
MAIL MESSAGE 53680377
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2011/06/07 15:54 APPROVED EBERT,AL KOPECKY,STEVE
2011/08/15 23:13 SUBSCRIBER ADDED THOMPSON,WILLIAM KOPECKY,STEVE
2018/02/01 13:28 SUBSCRIBER ADDED DEWAYNE,ROBERT REESE,DARRYL
Generated from SEP 10, 2019@ IA Listing Descriptions