Print Page as PDF
RETRIEVE PATIENT'S PREGNANCY/LACTATION DATA ICR (6164)

RETRIEVE PATIENT'S PREGNANCY/LACTATION DATA    ICR (6164)

Name Value
NUMBER 6164
IA # 6164
DATE CREATED 2015/02/24
CUSTODIAL PACKAGE WOMEN'S HEALTH
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE WVRPCPT
NAME RETRIEVE PATIENT'S PREGNANCY/LACTATION DATA
GENERAL DESCRIPTION
This integration agreement allows subscribing packages
to retrieve data from the Women's Health package.
STATUS Active
KEYWORDS
  • PREGNANCY DATA
  • LACTATION DATA
DURATION Till Otherwise Agreed
ID WVRPCPT
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
['GETDATA(RESULT,WVDFN,WVTYPE,WVSDATE,WVEDATE,WVMAX,WVDIR,W', 'VDT)']
This entry point will return data of the requested
type from the WV PATIENT file (#790).
VARIABLES TYPE VARIABLES DESCRIPTION
RESULT Input
The subscript in the ^TMP global under which to
return data or error messages. This value is required.
WVDFN Input
Internal entry number (IEN) of the patient in the WV
PATIENT file (#790). This value is required.
WVTYPE Input
The type of data to return. Valid values include:
"P" for pregnancy data
"L" for lactation data

This value is required.
WVSDATE Input
For date/time-based data, return data entered on or
after this date. The value must be in FileMan internal date/time format and is
optional.
WVEDATE Input
For date/time-based data, return data entered on or
before this date. The value must be in FileMan internal date/time format and
is optional.
WVMAX Input
The maximum number of entries to return. This value
is optional.
WVDIR Input
The date/time order in which to return entries. Valid
values include:
1 for chronological order
-1 for reverse chronological order.

This value is optional and if undefined, data is returned in reverse
chronological order.
WVDT Input
The date to use as today's date. The value must be in
internal FileMan date/time format and is optional. If undefined, the value
stored in the DT system variable is used.
TMP(RESULT,$J) Output
The global node in which data is returned.

Format:

^TMP(RESULT,$J)=Caret-delimited string
RESULT - the value in the RESULT input variable
Caret-delimited string - status of the call to
GETDATA
PIECE   VALUE
=======================
1       -1 to denote an error occurred
>-1 to denote the number of entries
returned
2       ERROR MESSAGE if an error occurred
"" if no error occurred

^TMP(RESULT,$J,N,"FIELD NAME")=Caret-delimited
string
RESULT - the value in the RESULT input variable
N - the entry number; starts at one and
increments by one
"FIELD NAME" - the name of the field from which
the data comes
Caret-delimited string - the returned data
PIECE   VALUE
=======================
1       Internal format
2       External format
NOTE: Two pseudo-fields are returned whose
value is not caret-delimited like the
other "FIELD NAME" subscripts. These
fields are:
"RECORD ID":  FileMan IENS for record N
"VISIT STRING": Semi-colon delimited
string of values from
the VISIT file (#9000010)
in internal format:
"HOSPITAL LOCATION (#.22) ;
VISIT/ADMIT DATE&TIME (#.01) ;
ENCOUNTER TYPE (#15003)"
GETSTATUS(WVDFN)
Returns text containing a patient's pregnancy and
lactation status in a format that is suitable for display to the user.
VARIABLES TYPE VARIABLES DESCRIPTION
WVDFN Input
Internal entry number (IEN) of the patient in the WV
PATIENT file (#790). This value is required.
$$GETSTATUS Output
String containing user-friendly text. Text is only
returned if the patient is pregnant, lactating or both. An empty string is
returned if the patient is neither pregnant nor lactating.
GETEDD(WVDFN)
Returns text suitable for display to the user
containing the patient's expected due date and if applicable, the fetus'
gestational age.
VARIABLES TYPE VARIABLES DESCRIPTION
WVDFN Input
Internal entry number (IEN) of the patient in the WV
PATIENT file (#790). This value is required.
$$GETEDD Output
Returns the string "~@" followed by the global
location where the text to display is returned. The location uses the same
structure as the FileMan word processing type. Each line of text to display is
returned in the 0 (zero) node descendent from the line number node. The first
line number is one and each subsequent line number is incremented by one.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
CLINICAL REMINDERS
HEALTH SUMMARY
OUTPATIENT PHARMACY
Patch WV*1*26 introduces a new component (GETSTATUS)
that Outpatient Pharmacy will begin using in its medication profile.
TEXT INTEGRATION UTILITIES
Patch WV*1*26 introduces a new component (GETEDD) that
Text Integration Utilities will begin using in its VA-WH EXPECTED DUE DATE
object.
INPATIENT MEDICATIONS
Added 7/7/25 effective with Patch PSJ*5*461 As part of
the Methadone Dispensing Tracking Project, will have to make a call to
$$GETSTATUS^WVRPCPT to check the patient's pregnancy and lactation status.
DATE ACTIVATED 2017/11/17