Print Page as PDF
DG MST STATUS API'S ICR (2716)

DG MST STATUS API'S    ICR (2716)

Name Value
NUMBER 2716
IA # 2716
DATE CREATED 1999/01/19
CUSTODIAL PACKAGE REGISTRATION
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DGMSTAPI
NAME DG MST STATUS API'S
GENERAL DESCRIPTION
The purpose of these API's is to facilitate the entry
and retrieval of Military Sexual Trauma status information on veterans.  The
primary mechanism is within the Registration package, but data will be
requested from, and eventually updated from Scheduling and Patient Care
Encounters.  VAH Directive 98-058 "Sexual Trauma Counseling Care and
Services", provides the guidance on this data collection.

STATUS Active
DURATION Till Otherwise Agreed
ID DGMSTAPI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$NEWSTAT(DFN,DGSTAT,DGDATE,DGPROV,DGSITE,DGXMIT)
Will enter new or edited Military Sexual Trauma (MST)
status data for a veteran into the MST HISTORY File (#29.11).  This is an
historical entry and will be added in addition to any previous entries.

A verification check is made on the new or edited MST status entry
before allowing any data to be filed to file (#29.11).
If the verification check is successful and the DGXMIT variable equals
a value of 1, an Enrollment Full Data Transmission (ORF/ORU~Z07) HL7 message
will be triggered to the VistA Enrollment module for transmission to the
Health Eligibility Center (HEC).
The Internal Entry Number (IEN) of the new entry in File (#29.11) is
returned if the entry was successful, else an error message is returned in the
format: -1^error message.
The HEC will transmit the new MST Status data to all sites of record
for the patient via an Enrollment/Eligibility (ORF/ORU~Z11) HL7 message.
No HL7 Z07 message will be triggered if the MST Status change event is
the result of an update received from the HEC via an HL7 Z11 message.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
Internal entry number for patient in the PATIENT File
(#2)
DGSTAT Input
MST Status code, "Y,N,D,U"
Y - Yes, Screened reports MST
N - No, Screened does not report MST
D - Screened, declines to answer
U - Unknown, not screened
DGDATE Input
Date of MST status change [Optional].  Defaults to
NOW if parameter is NULL.
DGPROV Input
Provider making MST status determiniation, pointer to
^VA(200)
$$NEWSTAT Output
Returns either the IEN of the new file entry, or
-1^error message if file update fails.
DGXMIT Input
HL7 trasmit flag [Optonal].
0 = don't queue a Z07 message.
1 = queue a Z07 message [Default].
DGSITE Input
Site Determining MST Status [Optional].  IEN pointer
of the INSTITUTION file (#4) for a Station number. If this parameter is NULL,
the current Primary Station number pointer to the INSTITUTION file (#4) will
be filed.
$$GETSTAT(DFN,DGDATE)
Entry point $$GETSTAT^DGMSTAPI(DFN,DGDATE) will
return the current MST status for a patient from the MST HISTORY File (#29.11)
AS OF THE DATE passed in as DGDATE.  Any MST status entries after the date in
DGDATE will be ignored.  DGDATE is optional, if it is not passed in, a date of
TODAY will be used.  To return the most recent MST status for a patient, call
GETSTAT^DGMSTAPI(DFN) only.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input

IEN of patient in the PATIENT File (#2)
DGDATE Input
Date to check MST status on, [Optional].  If not
passed in, default of TODAY is used.
$$GETSTAT Output


Piece 1  - IEN of entry in MST HISTORY File (#29.11) Piece 2  - Internal value
of MST Staus ("Y,N,D,U") Piece 3  - Date of status change Piece 4  - IEN of
provider making determination, NEW USER File (#200) Piece 5  - IEN of user who
entered status, NEW USER File (#200) Piece 6  - External format of MST Status
Piece 7  - IEN pointer of the INSTITUTION file (#4).

If no MST history entry is found for the patient, a
"0^U" will be returned.

If an error occurred while retrieving the MST status, a
"-1^^Error msg" will be returned.