TIU DOCUMENTS BY CONTEXT

TITLE	VALUE
NAME	TIU DOCUMENTS BY CONTEXT
DESCRIPTION	Returns lists of TIU Documents that satisfy the following search criteria: 1 - signed documents (all) 2 - unsigned documents 3 - uncosigned documents 4 - signed documents/author 5 - signed documents/date range
TAG	CONTEXT
ROUTINE	TIUSRVLO
INPUT PARAMETERS	SEQUENCE NUMBER	1
	INPUT PARAMETER	CLASS
	DESCRIPTION	This is a pointer to the Class of TIU DOCUMENTS which the user is interested in (e.g., 3 for PROGRESS NOTES, 244 for DISCHARGE SUMMARIES, etc.).
	PARAMETER TYPE	LITERAL
	REQUIRED	YES
	MAXIMUM DATA LENGTH

INPUT PARAMETERS	SEQUENCE NUMBER	2
	INPUT PARAMETER	CONTEXT
	DESCRIPTION	This is an integer number which maps the context in which the user wishes the notes to be returned. The mapping is as follows: 1 - signed documents (all) 2 - unsigned documents 3 - uncosigned documents 4 - signed documents/author 5 - signed documents/date range
	PARAMETER TYPE	LITERAL
	REQUIRED	YES
	MAXIMUM DATA LENGTH

INPUT PARAMETERS	SEQUENCE NUMBER	3
	INPUT PARAMETER	DFN
	DESCRIPTION	Pointer to Patient File (#2).
	PARAMETER TYPE	LITERAL
	REQUIRED	YES
	MAXIMUM DATA LENGTH

INPUT PARAMETERS	SEQUENCE NUMBER	4
	INPUT PARAMETER	EARLY
	DESCRIPTION	EARLY DATE/TIME in regular FileMan format for the inclusive lower bound on the search.
	PARAMETER TYPE	LITERAL
	REQUIRED	NO
	MAXIMUM DATA LENGTH

INPUT PARAMETERS	SEQUENCE NUMBER	5
	INPUT PARAMETER	LATE
	DESCRIPTION	LATE DATE/TIME in regular FileMan format for the inclusive upper bound on the search.
	PARAMETER TYPE	LITERAL
	REQUIRED	NO
	MAXIMUM DATA LENGTH

INPUT PARAMETERS	SEQUENCE NUMBER	6
	INPUT PARAMETER	PERSON
	DESCRIPTION	This is a pointer to the NEW PERSON FILE (#200) for the author of the documents to be retrieved.
	PARAMETER TYPE	LITERAL
	REQUIRED	NO
	MAXIMUM DATA LENGTH

INPUT PARAMETERS	SEQUENCE NUMBER	7
	INPUT PARAMETER	OCCLIM
	DESCRIPTION	This is the maximum number of documents to be retrieved in the current query.
	PARAMETER TYPE	LITERAL
	REQUIRED	NO
	MAXIMUM DATA LENGTH

INPUT PARAMETERS	SEQUENCE NUMBER	8
	INPUT PARAMETER	SEQUENCE
	DESCRIPTION	This is the sequence by reference date/time (A=ascending (OLDEST FIRST), D=descending (NEWEST FIRST)) in which the user would like the list returned.
	PARAMETER TYPE	LITERAL
	REQUIRED	NO
	MAXIMUM DATA LENGTH

INPUT PARAMETERS	SEQUENCE NUMBER	9
	INPUT PARAMETER	SHOWADD
	DESCRIPTION	This BOOLEAN parameter determines whether addenda will be included in the return array, when their parent documents are identified by the search criteria, and vice versa. Also if SHOWADD is TRUE (1), the "+" at the beginning of the return text will be omitted (since it offers only redundant information).
	PARAMETER TYPE	LITERAL
	REQUIRED	NO
	MAXIMUM DATA LENGTH

INPUT PARAMETERS	SEQUENCE NUMBER	10
	INPUT PARAMETER	INCUND
	DESCRIPTION	Optional Boolean parameter determines whether Undictated and Untranscribed documents should be returned along with Unsigned documents, when the CONTEXT is passed as 2.
	PARAMETER TYPE	LITERAL
	REQUIRED	NO
	MAXIMUM DATA LENGTH

INPUT PARAMETERS	SEQUENCE NUMBER	11
	INPUT PARAMETER	SHOW
	DESCRIPTION	Boolean: Return "0^SHOW MORE" in return array when additional notes are available for context of 1 or 5 when occurrence limit prevents all notes from displaying.
	PARAMETER TYPE	LITERAL
	REQUIRED	NO
	MAXIMUM DATA LENGTH	1

INPUT PARAMETERS	SEQUENCE NUMBER	12
	INPUT PARAMETER	TIUIEN
	DESCRIPTION	Starting TIU IEN for additional return when "SHOW MORE" was received in previous return array (LATE date/time will be set to Reference date of this TIU document).
	PARAMETER TYPE	LITERAL
	REQUIRED	NO
	MAXIMUM DATA LENGTH

RETURN VALUE TYPE	GLOBAL ARRAY
RETURN PARAMETER DESCRIPTION	The return array has elements with the following positional values: IEN^TITLE^REFERENCE DATE/TIME (INT)^PATIENT NAME (LAST I/LAST 4)^AUTHOR (INT;EXT)^HOSPITAL LOCATION^SIGNATURE STATUS^Visit Date/Time^ Discharge Date/time^Variable Pointer to Request (e.g., Consult)^# of Associated Images^Subject^Has Children^IEN of Parent Document If SHOW parameter received and additional documents are available for return when context is 1 (All Signed (by PT)) or 5 (Signed notes (by PT & date range)), then a final data element will be added indicating more are available with the following positional values: IEN^"SHOW MORE"^^^^^^^^^^^^^
AVAILABILITY	SUBSCRIPTION
INACTIVE
CLIENT MANAGER
WORD WRAP ON	TRUE
VERSION
SUPPRESS RDV USER SETUP
APP PROXY ALLOWED	Yes