PREGNANCY AND LACTATION DATA ICR (6073)

Name

Value

NUMBER

6073

IA #

6073

DATE CREATED

2014/07/10

CUSTODIAL PACKAGE

WOMEN'S HEALTH

USAGE

Controlled Subscription

TYPE

Routine

ROUTINE

WVTDCF

NAME

PREGNANCY AND LACTATION DATA

GENERAL DESCRIPTION

This integration agreement allows subscribing packages
to retrieve pregnancy and lactation data for a patient.  The APIs were
designed for use by the reminder computed finding functionality of the
Clinical Reminders package.

STATUS

Expired

KEYWORDS

REMINDER COMPUTED FINDING
PREGNANCY
LACTATION

DURATION

Till Otherwise Agreed

EXPIRATION DATE

2025/06/25

WVTDCF

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

PREGSTAT(DFN,NGET,BDT,EDT,NFOUND,TEST,DATE,DATA,TEXT)

This entry point returns the entries from the WV
PREGNANCY LOG file for a single patient.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	Internal entry number (IEN) of the patient in the WV PATIENT file.
NGET	Input	Specifies the maximum number of entries to return (optional). Not passing this parameter returns all entries. A negative value will return the entries in reverse date order, with the oldest entry first, while a positive value will return the entries in date order, with the newest entry first.
BDT	Input	The start date for searching for entries (optional). Entries created before this date are not returned.
EDT	Input	The end date for searching for entries (optional). Entries entered after this date are not returned.
NFOUND	Output	The number of entries returned.
TEST	Output	An array of logical values, one for each entry returned. The first subscript number is one for the first entry found and subsequent subscripts are incremented by one. For every entry found, the logical value will be TRUE.
DATE	Output	Array of FileMan formatted dates, one for each entry returned. The first subscript number is one for the first entry found and subsequent subscripts are incremented by one. For every entry returned, the date will be the date the entry was created.
DATA	Output	Array of values from each entry. The array is formatted as follows: DATA(N,"STATUS")=PREGNANCY STATUS field External format DATA(N,"EDD")=EDD field (expected date of delivery) FileMan format DATA(N,"DELIVERY DATE")=DELIVERY DATE field FileMan format N is the entry number and starts at one and increments by one for each entry that is found.
TEXT	Output	Array of display text values, one for each entry returned. The first subscript is one for the first entry found and subsequent subscripts are incremented by one. For every entry returned, the display text is an empty string.

LACSTAT(DFN,NGET,BDT,EDT,NFOUND,TEST,DATE,DATA,TEXT)

This entry point returns entries from the WV
LACTATION LOG file for a single patient.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	Internal entry number (IEN) of the patient in the WV PATIENT file.
NGET	Input	Specifies the maximum number of entries to return (optional). Not passing this parameter returns all entries. A negative value will return the entries in reverse date order, with the oldest entry first, while a positive value will return the entries in date order, with the newest entry first.
BDT	Input	The start date for searching for entries (optional). Entries created before this date are not returned.
EDT	Input	The end date for searching for entries (optional). Entries entered after this date are not returned.
NFOUND	Output	The number of entries returned.
TEST	Output	An array of logical values, one for each entry returned. The first subscript number is one for the first entry found and subsequent subscripts are incremented by one. For every entry found, the logical value will be TRUE.
DATE	Output	Array of FileMan formatted dates, one for each entry returned. The first subscript number is one for the first entry found and subsequent subscripts are incremented by one. For every entry returned, the date will be the date the entry was created.
DATA	Output	Array of values from each entry. The array is formatted as follows: DATA(N,"STATUS")=LACTATION STATUS field External format DATA(N,"END DATE")=END DATE field (date patient stopped lactating) FileMan format N is the entry number and starts at one and increments by one for each entry that is found.
TEXT	Output	Array of display text values, one for each entry returned. The first subscript is one for the first entry found and subsequent subscripts are incremented by one. For every entry returned, the display text is an empty string.

MUTC(DFN,TEST,DATE,DATA,TEXT)

This entry point returns the value of the MEDICALLY
UNABLE TO CONCEIVE field in the WV PATIENT file for a single patient.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	Internal entry number (IEN) of the patient in the WV PATIENT file.
TEST	Output	The value stored in the MEDICALLY UNABLE TO CONCEIVE field in the WV PATIENT file.
DATE	Output	If the MEDICALLY UNABLE TO CONCEIVE field is set to YES, this will be the date the entry point is executed in FileMan format. For all other field values, this will be an empty string.
DATA	Output	A value associated with the value of TEST. This will always be an empty string.
TEXT	Output	The display text value. This will always be an empty string.

LOBP(DFN,TEST,DATE,DATA,TEXT)

This entry point returns the patient's likelihood of
becoming pregnant.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	Internal entry number (IEN) of the patient in the WV PATIENT file.
TEST	Output	The logical value associated with the returned likelihood. The value is TRUE if a likelihood was calculated and FALSE if a likelihood was not calculated.
DATE	Output	If a likelihood is successfully calculated, this will be the date the entry point is executed in FileMan format. If a likelihood is not successfully calculated, this will be an empty string.
DATA	Output	This is the likelihood of the patient becoming pregnant in external format. ["HIGH"\|"LOW"\|"UNKNOWN"]
TEXT	Output	The display text value. This will always be an empty string.

CM(DFN,NGET,BDT,EDT,NFOUND,TEST,DATE,DATA,TEXT)

This entry point returns all of the values in the
CONTRACEPTIVE METHODS USED field in the WV PATIENT file for a single patient.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	Internal entry number (IEN) of the patient in the WV PATIENT file.
NGET	Input	Specifies the maximum number of entries to return (optional). Not passing this parameter returns all entries.
BDT	Input	The start date for searching for entries (ignored). The time period a patient uses a contraceptive method is not tracked.
EDT	Output	The end date for searching for entries (ignored). The time period a patient uses a contraceptive method is not tracked.
NFOUND	Output	The number of entries returned.
TEST	Output	An array of logical values, one for each entry returned. The first subscript number is one for the first entry found and subsequent subscripts are incremented by one. For every entry returned, the logical value will be TRUE.
DATE	Output	An array of FileMan formatted dates, one for each entry returned. The first subscript number is one for the first entry found and subsequent subscripts are incremented by one. For every entry returned, the date will be the date the entry point is executed.
DATA	Output	Array of values from each entry. The array is formatted as follows: DATA(N,"METHOD")=CONTRACEPTIVE METHOD USED Field External Format DATA(N,"LIKELIHOOD")=Calculated likelihood of becoming pregnant using this method alone External Format: ["HIGH"\|"LOW"\|"ERROR"] N is the entry number and starts at one and increments by one for each entry that is returned.
TEXT	Output	An array of display text values, one for each entry returned. The first subscript number is one for the first entry found and subsequent subscripts are incremented by one. For every entry returned, the display text is an empty string.

ATDRUG(DFN,NGET,BDT,EDT,NFOUND,TEST,DATE,DATA,TEXT)

This entry point returns all of the active
teratogenic drug prescriptions for a single patient.  An active prescription
is one that has had activity within the last 5,000 days.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	Internal entry number (IEN) of the patient in the WV PATIENT file.
NGET	Input	Specifies the maximum number of prescriptions to return (optional). Not passing this parameter returns all entries.
BDT	Input	The start date for searching for prescriptions (ignored). Only active prescriptions are returned.
EDT	Input	The end date for searching for prescriptions (ignored). Only active prescriptions are returned.
NFOUND	Output	The number of prescriptions returned.
TEST	Output	An array of logical values, one for each prescription returned. The first subscript number is one for the first entry found and subsequent subscripts are incremented by one. For every prescription returned, the logical value will be TRUE.
DATE	Output	An array of FileMan formatted dates, one for each prescription returned. The first subscript number is one for the first entry found and subsequent subscripts are incremented by one. For every prescription returned, the date value is the issue date of the prescription.
DATA	Output	Array of values from each prescription. The array is formatted as follows: DATA(N,"DRUG_NAME")=GENERIC NAME Field in the DRUG File N is the entry number and starts at one and increments by one for each prescription that is returned.
TEXT	Output	An array of display text values, one for each prescription returned. The first subscript number is one for the first entry found and subsequent subscripts are incremented by one. For every prescription returned, the display text is an empty string.

SUBSCRIBING PACKAGE

CLINICAL REMINDERS