TIU Package API - Revision history

DavidWhitten: /* TIU API */

2015-05-18T03:30:54Z

TIU API

← Older revision		Revision as of 03:30, 18 May 2015
Line 3:		Line 3:
	=== TIU API ===		=== TIU API ===

	The [[CPRS Text Integration Utility (TIU)\|TIU package]] deals with medical [[Record~\|Record]]s, i.e. progress notes, discharge summaries etc. etc.		The [[CPRS Text Integration Utility (TIU)\|TIU package]] deals with medical [[Record~\|Record]]s, i.e. [[PROGRESS NOTE~\|progress notes]], [[DISCHARGE SUMMARY~\|discharge summaries]] etc. etc.

	No documentation of an [[API]] was created with the TIU [[package]]. The purpose of this page will be to document some entry points, for those needing an API. This page will be used as a work in progress, as the interdependencies etc. are explored.		No documentation of an [[API~\|API]] was created with the TIU [[package]]. The purpose of this page will be to document some entry points, for those needing an API. This page will be used as a work in progress, as the interdependencies etc. are explored.

	~~[[Entire TIU Source Code]]~~

			[[Entire TIU Source Code\|List of all M routines in TIU]]

	=== TIU Document Array ===		=== TIU Document Array ===

NeilArmstrong: Added a glossary link to Action~

2012-07-10T08:39:27Z

Added a glossary link to Action~

← Older revision		Revision as of 08:39, 10 July 2012
Line 116:		Line 116:
	[NOSAVE] --> Boolean flag to suppress saving the data		[NOSAVE] --> Boolean flag to suppress saving the data
	(e.g., when testing new Boilerplates		(e.g., when testing new Boilerplates
	using DDEF action TRY, etc.).		using DDEF [[action~\|Action]] TRY, etc.).
	[by ref] [TIUNDA] --> array of form: TIUNDA(IFN)="".		[by ref] [TIUNDA] --> array of form: TIUNDA(IFN)="".
	Used in SHOW NOTES ACROSS PATIENTS.		Used in SHOW NOTES ACROSS PATIENTS.
Line 125:		Line 125:
	[by ref] [TIUCHNG] --> If received, passes back TIUCHNG array,		[by ref] [TIUCHNG] --> If received, passes back TIUCHNG array,
	which collects info across [[record~\|Record]]s about		which collects info across [[record~\|Record]]s about
	~~actions~~ taken. Used in feedback		[[action~\|Action]]s taken. Used in feedback
	msgs to user.		msgs to user.
	Other variables:		Other variables:

NeilArmstrong: Added glossary link to Record~

2012-03-10T20:48:47Z

Added glossary link to Record~

← Older revision		Revision as of 20:48, 10 March 2012
Line 3:		Line 3:
	=== TIU API ===		=== TIU API ===

	The [[CPRS Text Integration Utility (TIU)\|TIU package]] deals with medical ~~records~~, i.e. progress notes, discharge summaries etc. etc.		The [[CPRS Text Integration Utility (TIU)\|TIU package]] deals with medical [[Record~\|Record]]s, i.e. progress notes, discharge summaries etc. etc.

	No documentation of an [[API]] was created with the TIU [[package]]. The purpose of this page will be to document some entry points, for those needing an API. This page will be used as a work in progress, as the interdependencies etc. are explored.		No documentation of an [[API]] was created with the TIU [[package]]. The purpose of this page will be to document some entry points, for those needing an API. This page will be used as a work in progress, as the interdependencies etc. are explored.
Line 33:		Line 33:
	Purpose: [[prompt~\|Prompt]]s user, "Do you want to print note?" Then asks if chart or work copy, and destination device.		Purpose: [[prompt~\|Prompt]]s user, "Do you want to print note?" Then asks if chart or work copy, and destination device.

	RecNum: is record number of note to print, aka DA, in the {{File\|TIU DOCUMENT}}.		RecNum: is [[record~\|Record]] number of note to print, aka DA, in the {{File\|TIU DOCUMENT}}.

	=== Print Documents(s) ===		=== Print Documents(s) ===
Line 41:		Line 41:

	Input:		Input:
	^TMP("TIUPR",$J) is array of ~~records~~ to be printed		^TMP("TIUPR",$J) is array of [[record~\|Record]]s to be printed
	Format:^TMP("TIUPR",$J,S,Order,TIUDA)=TIUPFNBR (e.g. "Vice SF 509")		Format:^TMP("TIUPR",$J,S,Order,TIUDA)=TIUPFNBR (e.g. "Vice SF 509")
	S format: "SSN;DNF" or "TIUGRP$HeaderText;DFN		S format: "SSN;DNF" or "TIUGRP$HeaderText;DFN
	SSN=Patient's Social security number		SSN=Patient's Social security number
	DFN=Patient's record number in file #2		DFN=Patient's [[record~\|Record]] number in file #2
	TIUGRP=??		TIUGRP=??
	HeaderText=String to put into header (default='Progress Notes')		HeaderText=String to put into header (default='Progress Notes')
	Order: a sorting number. Date of note can be used for this		Order: a sorting number. Date of note can be used for this
	TIUDA=record number in file 8925		TIUDA=[[record~\|Record]] number in file 8925
	e.g. SET ^TMP("TIUPR",$J,SSN_";"_DFN,DATE,DA)="Vice SF 509"		e.g. SET ^TMP("TIUPR",$J,SSN_";"_DFN,DATE,DA)="Vice SF 509"
	WorkType: 1=Chart Copy; 0=Work Copy		WorkType: 1=Chart Copy; 0=Work Copy
Line 72:		Line 72:
	Input:		Input:

	TIUDA -- the is the IEN, or record number, from file 8925, of the document to sign.		TIUDA -- the is the IEN, or [[record number~\|Record]], from file 8925, of the document to sign.
	TIUADD -- This appears to be an OUT parameter, and is set to 1		TIUADD -- This appears to be an OUT parameter, and is set to 1
	TIUPASK -- I believe if value is not 0, then user is asked if they want to print note.		TIUPASK -- I believe if value is not 0, then user is asked if they want to print note.
Line 84:		Line 84:
	Input:		Input:

	TIUDA -- the is the IEN, or record number, from file 8925, of the document to sign.		TIUDA -- the is the IEN, or [[record~\|Record]] number, from file 8925, of the document to sign.
	TIUES -- a string like this: "1^Author Name^Signature Title"		TIUES -- a string like this: "1^Author Name^Signature Title"
	TIUI -- Not used, optional (??)		TIUI -- Not used, optional (??)
Line 106:		Line 106:
	from which to select a title		from which to select a title
	[by ref] [SUCCESS] --> Boolean flag returned as IFN when a		[by ref] [SUCCESS] --> Boolean flag returned as IFN when a
	record is created, or 0 when record		[[record~\|Record]] is created, or 0 when [[record~\|Record]]
	creation fails		creation fails
	[DFN] --> IEN in patient file (#2)		[DFN] --> IEN in patient file (#2)
Line 124:		Line 124:
	regardless of multiple pt preference.		regardless of multiple pt preference.
	[by ref] [TIUCHNG] --> If received, passes back TIUCHNG array,		[by ref] [TIUCHNG] --> If received, passes back TIUCHNG array,
	which collects info across ~~records~~ about		which collects info across [[record~\|Record]]s about
	actions taken. Used in feedback		actions taken. Used in feedback
	msgs to user.		msgs to user.

NeilArmstrong: Added glossary link to Prompt~

2012-03-03T09:17:41Z

Added glossary link to Prompt~

← Older revision		Revision as of 09:17, 3 March 2012
Line 31:		Line 31:
	<mentry>PRINT^TIUEPRNT</mentry>(RecNum)		<mentry>PRINT^TIUEPRNT</mentry>(RecNum)

	Purpose: ~~prompts~~ user, "Do you want to print note?" Then asks if chart or work copy, and destination device.		Purpose: [[prompt~\|Prompt]]s user, "Do you want to print note?" Then asks if chart or work copy, and destination device.

	RecNum: is record number of note to print, aka DA, in the {{File\|TIU DOCUMENT}}.		RecNum: is record number of note to print, aka DA, in the {{File\|TIU DOCUMENT}}.
Line 112:		Line 112:
	TITLE from file 8925.1 to be used as		TITLE from file 8925.1 to be used as
	the default.		the default.
	[EVNTFLAG] --> Boolean flag for visit prompt (0 to		[EVNTFLAG] --> Boolean flag for visit [[prompt~\|Prompt]] (0 to
	prompt, 1 to force event type visit)		[[prompt~\|Prompt]], 1 to force event type visit)
	[NOSAVE] --> Boolean flag to suppress saving the data		[NOSAVE] --> Boolean flag to suppress saving the data
	(e.g., when testing new Boilerplates		(e.g., when testing new Boilerplates

NeilArmstrong: Added glossary link to Stop Code~

2012-02-18T07:55:17Z

Added glossary link to Stop Code~

← Older revision		Revision as of 07:55, 18 February 2012
Line 26:		Line 26:
	TIU("LOC")=TIULOC		TIU("LOC")=TIULOC
	TIU("VLOC")=TIULOC		TIU("VLOC")=TIULOC
	TIU("STOP")=0 ;"0=FALSE, don't worry about stop ~~codes~~.		TIU("STOP")=0 ;"0=FALSE, don't worry about [[stop code~\|Stop Code]]s.

	=== Print a Document ===		=== Print a Document ===

69.68.182.66 at 16:32, 18 September 2005

2005-09-18T16:32:19Z

← Older revision		Revision as of 16:32, 18 September 2005
Line 1:		Line 1:
			Back to [[Programming VistA Issues]]

	=== TIU API ===		=== TIU API ===

128.249.162.120 at 18:21, 15 August 2005

2005-08-15T18:21:42Z

Show changes

85.99.49.96 at 22:07, 13 August 2005

2005-08-13T22:07:43Z

Show changes

81.214.97.4: /* TIU API */

2005-08-05T23:32:55Z

TIU API

Show changes

69.68.182.66: /* TIU DOCUMENT ARRAY */

2005-04-13T00:50:06Z

TIU DOCUMENT ARRAY

← Older revision		Revision as of 00:50, 13 April 2005
Line 7:		Line 7:
	[[Entire TIU Source Code]]		[[Entire TIU Source Code]]

	=== TIU ~~DOCUMENT ARRAY~~ ===		=== TIU Document Array ===
	Many of the TIU functions pass an array that holds information about the current document. Here is the info that I have been able to determine:		Many of the TIU functions pass an array that holds information about the current document. Here is the info that I have been able to determine:

Line 19:		Line 19:
	TIU("EDT")=TIUEDT^DateStr = event begin time: FMDate^DateStr		TIU("EDT")=TIUEDT^DateStr = event begin time: FMDate^DateStr
	TIU("LDT")=TIULDT^DateStr = event end time: FMDate^DateStr		TIU("LDT")=TIULDT^DateStr = event end time: FMDate^DateStr
	TIU("VSTR")="x;x;OFFICE VISIT" ~~;"LOC;VDT;VTYP~~		TIU("VSTR")=LOC;VDT;VTYP e.g. "x;x;OFFICE VISIT"
	TIU("VISIT")=~~0 ;"~~Visit File IFN		TIU("VISIT")=Visit File IFN
	TIU("LOC")=TIULOC		TIU("LOC")=TIULOC
	TIU("VLOC")=TIULOC		TIU("VLOC")=TIULOC
	TIU("STOP")=0 ;"0=FALSE, don't worry about stop codes.		TIU("STOP")=0 ;"0=FALSE, don't worry about stop codes.


	=== Print a Document ===		=== Print a Document ===