Print Page as PDF
OUTPATIENT MEALS DATA ICR (4763)

OUTPATIENT MEALS DATA    ICR (4763)

Name Value
NUMBER 4763
IA # 4763
DATE CREATED 2005/08/16
CUSTODIAL PACKAGE DIETETICS
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE FHOMAPI
NAME OUTPATIENT MEALS DATA
GENERAL DESCRIPTION 
This IA allows OE/RR to call functions that will return
3 pieces of data for Outpatient Meals.

$$AUTH^FHOMAPI(DUZ) - The user's DUZ is passed into this function and the
function returns a '1' (user holds the FHAUTH key) or a '0' (user does not
hold the FHAUTH key).

DIETLST^FHOMAPI - No variables are passed into this API, which simply returns
the array FHDIET containing the list of allowable outpatient diets from the FH
Site Parameters (#119.9) file.

$$MAXDAYS^FHOMAPI(FHLOC) - A hospital location pointer is passed into this
function and the function returns the numeric "Max Number of Days" for which
recurring meals can be ordered for this location.

$$NFSLOC^FHOMAPI(FHLOC) - A hospital location pointer is passed into this
function and the function returns the NFS location name corresponding to that
hospital location.
STATUS Active
DURATION Till Otherwise Agreed
ID FHOMAPI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$AUTH(DUZ) 
Returns whether or not user holds FHAUTH key.
VARIABLES TYPE VARIABLES DESCRIPTION
DUZ Input 
This is a pointer to the New Person (#200) file.
$$AUTH Output 
This will be a numeric field returning whether or not
the person holds the FHAUTH key, 1 for "Yes", 0 for "No".
$$MAXDAYS(FHLOC) 
Returns Max Number of Days recurring meals can be
ordered for at this location.
VARIABLES TYPE VARIABLES DESCRIPTION
FHLOC Input 
This is a pointer to the Hospital Location (#44)
file.
$$MAXDAYS Output 
This will be a numeric field containing the maximum
number of days in advance a recurring meal can be ordered for this NFS
location.
$$NFSLOC(FHLOC) 
Returns NFS location name corresponding to the
hospital location passed in.
VARIABLES TYPE VARIABLES DESCRIPTION
FHLOC Input 
This is a pointer to the Hospital Location (#44)
file.
$$NFSLOC Output 
This will be a free-text field displaying the NFS
location name.
DIETLST 
Returns array FHDIET containing list of allowable
outpatient meals diets from the FH Site Parameters (#119.9) file.
VARIABLES TYPE VARIABLES DESCRIPTION
FHDIET Output 
This output variable is an array containing the
allowable outpatient diets from the FH Site Parameters (#119.9) file, in the
format FHDIET(N)="IEN^NAME".  The IEN is the pointer to the entry in the Diets
(#111) file and the NAME is the displayable name of the Diet.  For example:

FHDIET(1)="25^OUTPATIENT REGULAR" FHDIET(2)="33^LOW CHOLESTEROL" etc...
SUBSCRIBING PACKAGE ORDER ENTRY/RESULTS REPORTING