STANDARD DATA DICTIONARY #8927 -- TIU TEMPLATE FILE 3/24/25 PAGE 1
STORED IN ^TIU(8927, (35 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file stores TIU Templates, which are on-the-fly boilerplates that can be added to any note or addendum in the CPRS GUI. All
shared and personal templates, as well as template hierarchy, are stored within this file.
Duplicate template names are allowed, usually distinguished by personal owner.
This file is intended for the CPRS GUI only. No server side implementation is provided or feasible. Maintenance of this file
should only be performed using the Template Editor, which is contained within the CPRS GUI. Bypassing the template editor can
cause file structure problems.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
POINTED TO BY: ITEM field (#.02) of the ITEMS sub-field (#8927.03) of the TIU TEMPLATE File (#8927)
CROSS
REFERENCED BY: ITEM(AD), LINK(AL), TYPE(AROOT), STATUS(AROOT1), PERSONAL OWNER(AROOT2), NAME(B), PERSONAL OWNER(PO)
LAST MODIFIED: JUN 24,2020@12:13:55
8927,.01 NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>60!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: OCT 07, 1999
HELP-PROMPT: Answer must be 3-60 characters in length.
DESCRIPTION: This is the name of the template as it will appear in the template tree, 3-60 characters in length,
not starting with punctuation.
Duplicate NAMEs ARE permitted, and are distinguished by the tree they belong to.
CROSS-REFERENCE: 8927^B
1)= S ^TIU(8927,"B",$E(X,1,60),DA)=""
2)= K ^TIU(8927,"B",$E(X,1,60),DA)
8927,.02 BLANK LINES 0;2 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>3)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: MAY 19, 1999
HELP-PROMPT: Type a Number between 0 and 3, 0 Decimal Digits
DESCRIPTION: This is the number of blank lines inserted between Group Template items when the template is used
for composing documents.
For example, suppose a Group Template DEMOGRAPHICS has item templates NAME and ADDRESS, each with
boilerplate as shown:
Template Boilerplate
-------------------------------
NAME Patient Name:
ADDRESS Street Address:
City:
State, Zip:
Then the boilerplate for a document entered using template DEMOGRAPHICS with BLANK LINES = 1 would
look like:
Patient Name:
<< 1 blank line
Street Address:
City:
State, Zip:
BLANK LINES can have values from 0 to 3. BLANK LINES applies only to GROUP TEMPLATES. The default
value for BLANK LINES is 0.
8927,.03 TYPE 0;3 SET (Required)
'T' FOR TEMPLATE;
'G' FOR GROUP TEMPLATE;
'C' FOR CLASS CONTAINER;
'P' FOR PERSONAL ROOT CONTAINER;
'R' FOR SHARED ROOT CONTAINER;
'TF' FOR TITLE ROOT FOLDER;
'CF' FOR CONSULT ROOT FOLDER;
'OF' FOR PROCEDURE ROOT FOLDER;
INPUT TRANSFORM: K:($$BADTYPE^TIUDDT(X,DA)) X
LAST EDITED: AUG 23, 2001
DESCRIPTION: The TIU TEMPLATE FILE stores templates for use in composing documents and also stores the
containers which organize the templates into trees. Every entry in the file belongs to at least one
tree. Some entries contain other entries as items.
There are 5 types of entries in the TIU TEMPLATE FILE:
'T' for TEMPLATE
'G' for GROUP TEMPLATE
'C' for CONTAINER
'P' for PERSONAL ROOT CONTAINER
'R' for SHARED ROOT CONTAINER
'TF' for TITLE ROOT FOLDER
'CF' for CONSULT ROOT FOLDER
'OF' for PROCEDURE ROOT FOLDER
The first two types, T and G, are true templates and may be selected for composing documents.
The remaining types are "containers" which hold templates as items. The purpose of the container
types is to organize templates according to subject matter into trees, so that individual templates
can be easily found as "leaves" of a tree. Container types are NOT used for composing documents.
Besides holding templates, containers may hold other containers, which then function as
subcontainers.
The last five types, P, R, TF, CF, and OF, are containers of a special type, denoted "roots". A
root functions as the single top level of its tree. Each site has a "shared" root container, which
contains templates shared across the whole facility. Each user at a site has a "personal" root
container, which contains the user's personal templates. Thus, each user at a site has access to
two trees: the shared tree, and their own personal tree. The Title, Consult and Procedure root
folders are special folders that allow templates to be linked to specific TIU Titles, Consult
Reasons for Request, and Procedure Reasons for Request.
Root containers (like all container types) hold templates of type T and G, and may also hold
subcontainers (type C).
TYPE DETAILS
'T': A TEMPLATE is the most basic piece of boilerplate text desired. It may be used by itself for
composing documents, or it may be added as an item to a Group Template, becoming part of a larger
template.
'G': A GROUP TEMPLATE is a composite of its item TEMPLATES. In addition to the boilerplate text
of its items, it may also have its own boilerplate text. A GROUP TEMPLATE may also have items of
type CONTAINER (C). These items are for storage only; they are ignored when the GROUP TEMPLATE is
used to compose a document.
'C': A CLASS CONTAINER is a container for templates. In addition to templates, it may also contain
other containers (C), which then function as subcontainers.
'P': A PERSONAL ROOT CONTAINER functions as the root (top level) of a user's personal template
tree. A PERSONAL ROOT CONTAINER may contain both shared and personal entries.
When adding shared entries to their personal trees, users need to be aware that changes made at the
facility level to a shared template will carry over to their personal tree. Changes a user makes to
a shared entry in their personal tree do NOT, however, carry over to the shared tree. Instead,
when a user goes to edit a shared item under his/her PERSONAL ROOT CONTAINER, that item is copied,
and the user made the PERSONAL OWNER of the copy. The original shared item remains the same in the
shared tree.
'R': A SHARED ROOT CONTAINER is shared across a site. Templates contained in it may be selected
by any user composing a document, but the user may not edit the template itself. Besides its use
for documents, a site's shared tree functions as a repository from which users can add templates to
their own personal tree.
'TF': The TITLE ROOT FOLDER links templates to specific TIU Titles. Although end users will not
see this folder directly, they will see templates appear automatically when the associated TIU
Title is selected.
'CF': The CONSULT ROOT FOLDER links templates to specific Consult Reasons for Request. End users
will not see this folder directly, but they will see templates appear automatically when ordering a
consult, and the associated Consult service is selected.
'OF': The PROCEDURE ROOT FOLDER links templates to specific Procedure Reasons for Request. End
users will not see this folder directly, but they will see templates appear automatically when
ordering a procedure, and the associated procedure is selected.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 8927^AROOT^MUMPS
1)= D TYPESETR^TIUDDT(X,DA)
2)= D TYPEKILR^TIUDDT(X,DA)
3)= Don't delete this or Templates will not work
The "AROOT" cross-reference keeps track of active shared and personal template root folders. The
Shared Templates folder is found in the ^TIU(8927,"AROOT","ROOT",DA) reference. Personal Templates
are found in the ^TIU(8927,"AROOT",DUZ,DA) reference.
8927,.04 STATUS 0;4 SET
'A' FOR ACTIVE;
'I' FOR INACTIVE;
INPUT TRANSFORM: K:($$BADSTS^TIUDDT(X,DA)) X
LAST EDITED: MAY 26, 1999
DESCRIPTION: Entries in the TIU TEMPLATE FILE have status ACTIVE or INACTIVE. Status INACTIVE serves as a way to
hide entries from users composing documents.
INACTIVE templates are NOT available for composing documents. In theory, ACTIVE templates ARE
available. In fact, however, even an ACTIVE template's select ability depends on its position in
the tree, as will be seen below.
Containers, for their part, may also have status ACTIVE or INACTIVE, and may contain ACTIVE or
INACTIVE items. Thus, an INACTIVE container may contain ACTIVE templates. However, an INACTIVE
container and all its items (whatever status) are hidden from the user composing documents and are
thus not selectable.
Although users are permitted to have more than one Personal Root Container, only one per user is
allowed to be ACTIVE at a given time. Similarly, a site can have only one ACTIVE Shared Root
Container at a given time.
If an entry is no longer desired for either storage or for composing documents, it can be deleted.
However, once the last occurrence of it as an item in any tree is deleted, it is deleted from the
file itself and cannot be retrieved. Therefore, users are encouraged to INACTIVATE entries rather
than delete them unless they are sure they won't want them back in the future.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 8927^AROOT1^MUMPS
1)= D STSSETR^TIUDDT(X,DA)
2)= D STSKILLR^TIUDDT(X,DA)
3)= Don't delete this or Templates won't work
The "AROOT" cross-reference keeps track of active shared and personal template root folders. The
Shared Templates folder is found in the ^TIU(8927,"AROOT","ROOT",DA) reference. Personal Templates
are found in the ^TIU(8927,"AROOT",DUZ,DA) reference.
8927,.05 EXCLUDE FROM GROUP BOILERPLATE 0;5 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: MAY 19, 1999
DESCRIPTION: Applies only to templates (types T and G). There are occasions when a template is added as an item
to some Group Template simply as a logical storage place, and not because the template is usually
desired as part of the composite boilerplate text of the Group Template.
This field permits the user to specify that a particular template be ignored whenever it is an item
of a Group Template being used to compose a document.
The field applies to both shared and personal templates.
8927,.06 PERSONAL OWNER 0;6 POINTER TO NEW PERSON FILE (#200)
INPUT TRANSFORM: K:($$BADOWNER^TIUDDT(X,DA)) X
LAST EDITED: JUN 01, 1999
DESCRIPTION: The PERSONAL OWNER of an entry is a user from the NEW PERSON FILE who can edit the template or
container. An entry is recognized by the computer as personal (as opposed to shared) by the
presence of a PERSONAL OWNER. PERSONAL OWNER is set automatically when a user goes to edit a
shared entry in their personal tree: the shared entry is copied, and the user is made the owner of
the copy.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 8927^AROOT2^MUMPS
1)= D OWNRSETR^TIUDDT(X,DA)
2)= D OWNRKILR^TIUDDT(X,DA)
3)= Don't delete this or Templates won't work
The "AROOT" cross-reference keeps track of active shared and personal template root folders. The
Shared Templates folder is found in the ^TIU(8927,"AROOT","ROOT",DA) reference. Personal Templates
are found in the ^TIU(8927,"AROOT",DUZ,DA) reference.
CROSS-REFERENCE: 8927^PO
1)= S ^TIU(8927,"PO",$E(X,1,30),DA)=""
2)= K ^TIU(8927,"PO",$E(X,1,30),DA)
This regular cross-reference on Personal Owner is used for look-ups and searches by owner.
8927,.07 EDITOR CLASS 0;7 POINTER TO USR CLASS FILE (#8930)
INPUT TRANSFORM: K:'$$ISROOT^TIUDDT($P($G(^TIU(8927,DA,0)),"^",3)) X
LAST EDITED: JUN 25, 2001
DESCRIPTION: EDITOR CLASS applies ONLY to shared root containers, active or inactive. The EDITOR CLASS is a
class from the USR CLASS FILE whose members can edit all containers and templates in the shared
template tree. This applies to the SHARED ROOT CONTAINER, TITLE ROOT FOLDER, CONSULT ROOT FOLDER
and PROCEDURE ROOT FOLDER.
The CLINICAL COORDINATOR User Class is automatically made the default EDITOR CLASS when a Shared
Root Container is first created.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
8927,.08 DIALOG 0;8 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: MAR 29, 2000
HELP-PROMPT: Is this Group Template a Dialog?
DESCRIPTION: When this field is Yes, Group Templates appear to function as dialogs, asking the user to check off
which elements of the group to insert into the note.
8927,.09 DISPLAY ONLY 0;9 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 28, 2000
HELP-PROMPT: Display only within Template Dialogs?
DESCRIPTION: When this field is yes, a template will not be selectable from within a template dialog, but will
appear for informational purposes only.
8927,.1 FIRST LINE 0;10 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 28, 2000
HELP-PROMPT: Only Show First Line of Text in Dialog
DESCRIPTION: When set to YES, the template will only show the first line of text when displayed in a template
dialog. All text will be added to the note text.
8927,.11 ONE ITEM ONLY 0;11 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 05, 2001
HELP-PROMPT: Allow only one child item to be selected
DESCRIPTION: When set to YES, this field allows only one child item to be selected at a time. Selecting a new
child item unselects any existing child items.
8927,.12 HIDE DIALOG ITEMS 0;12 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 29, 2000
HELP-PROMPT: Hide child items when folder is not selected
DESCRIPTION: In a template dialog, this field allows child items to be hidden when the parent item has not been
selected.
8927,.13 HIDE TREE ITEMS 0;13 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 29, 2000
HELP-PROMPT: Hide child items from template drawer view
DESCRIPTION: When set to YES, this field will cause a folder, group template or dialog to not display any of
it's child items when viewed from the Templates drawer.
8927,.14 INDENT ITEMS 0;14 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 30, 2000
HELP-PROMPT: Indent child items in dialog
DESCRIPTION:
When set to YES, child items will be indented in the dialog.
8927,.15 REMINDER DIALOG 0;15 POINTER TO REMINDER DIALOG FILE (#801.41)
INPUT TRANSFORM: S DIC("S")="I ($P(^(0),""^"",3)="""")!(($P(^(0),""^"",3)=0))&($P(^(0),""^"",4)=""R"")" D ^DIC K DIC
S DIC=$G(DIE),X=+Y K:Y<0 X
LAST EDITED: MAY 06, 2015
SCREEN: S DIC("S")="I ($P(^(0),""^"",3)="""")!(($P(^(0),""^"",3)=0))&($P(^(0),""^"",4)=""R"")"
EXPLANATION: Only allow Active Reminder Dialogs
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
8927,.16 LOCK 0;16 SET
'0' FOR Not Locked;
'1' FOR Locked;
LAST EDITED: AUG 02, 2001
HELP-PROMPT: Lock Shared Template
DESCRIPTION:
Locks Shared Templates so they can not be copied.
8927,.17 COM OBJECT 0;17 POINTER TO OE/RR COM OBJECTS FILE (#101.15)
INPUT TRANSFORM: S DIC("S")="I $P(^(0),""^"",3)'=""I""" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X
LAST EDITED: JUN 21, 2001
HELP-PROMPT: COM Object
DESCRIPTION:
When linked to a COM Object, template activates object.
SCREEN: S DIC("S")="I $P(^(0),""^"",3)'=""I"""
EXPLANATION: Screen out Inactive Objects
8927,.18 COM PARAM 0;18 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: JUN 21, 2001
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
Optional Parameter to pass to COM Object
8927,.19 LINK 0;19 VARIABLE POINTER
FILE ORDER PREFIX LAYGO MESSAGE
8925.1 1 T n TIU Title
123.5 2 C n Consult Service
123.3 3 P n Procedure
SCREEN ON FILE 8925.1: S DIC("S")="I $P(^(0),""^"",4)=""DOC"""
SCREEN EXPLANATION: Limit to TIU Titles
INPUT TRANSFORM: K:($$BADLINK^TIUDDT(X,DA)) X
LAST EDITED: JUN 25, 2001
DESCRIPTION:
Allows link to a TIU Title, Consult Reason for Request, or Procedure Reason for Request.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 8927^AL
1)= S ^TIU(8927,"AL",$E(X,1,30),DA)=""
2)= K ^TIU(8927,"AL",$E(X,1,30),DA)
8927,.2 CONSULT LOCK 0;20 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 13, 2017
HELP-PROMPT: Select 'YES' if consult template should be locked from edit.
DESCRIPTION: This field is set by adding or removing templates to or from the TIU TEMPLATE CONSULT LOCK
parameter via the TIU TEMPLATE CONSULT LOCK option. When this field is set to YES, the template
may not be edited in the CPRS GUI Template Editor.
8927,2 BOILERPLATE TEXT 2;0 WORD-PROCESSING #8927.02 (NOWRAP)
LAST EDITED: OCT 11, 2000
DESCRIPTION: Boilerplated text of Templates and Groups, including TIU Objects.
This is the pre-defined text which will be inserted into the text of a new document. The user
may select several templates in the course of writing one document. The template boilerplate
text will be inserted at the top of a new document, or at the cursor's current position in the
document.
Once inserted, boilerplate text is editable. It is NOT updated later if the template is changed.
Template boilerplate text may contain TIU objects, which find and insert patient- and/ or
time-specific information into the text at the time a template is selected. As with text, object
information is editable, and is NOT automatically updated once inserted.
8927,5 DESCRIPTION 5;0 WORD-PROCESSING #8927.05 (NOWRAP)
DESCRIPTION:
This field can be used to keep notes about a given template.
LAST EDITED: OCT 11, 2000
HELP-PROMPT: TEMPLATE DESCRIPTION
DESCRIPTION:
This field can be used to keep notes about a given template.
8927,10 ITEMS 10;0 Multiple #8927.03 (Add New Entry without Asking)
DESCRIPTION: Items are themselves members of the TIU TEMPLATE FILE, and vary according to the type of the item
parent.
A container (type C, P, or R) holds templates (TEMPLATES and GROUP TEMPLATES) as its items. It may
also hold other containers as items.
A GROUP TEMPLATE is made up of TEMPLATES or of other GROUP TEMPLATES as items. Its boilerplate
text is a composite consisting of, first, it own boilerplate text if it has any, and then the
boilerplate text of its items, in SEQUENCE order. (See also field EXCLUDE FROM GROUP BOILERPLATE.)
A GROUP TEMPLATE may also have a container (type C) as an item. In this case, the container is
simply being stored in the GROUP TEMPLATE; the container is ignored when the GROUP TEMPLATE is used
for composing a document.
A TEMPLATE (type T) does not have items.
A given template or container may occur as an item in more than one tree, and may even occur more
than once in the same tree. It cannot, however, be an item under itself. Nor can it occur twice,
as an item of the same parent.
An item may be deleted (after a warning) from a tree by its Personal Owner (for personal trees) or
by a member of the Editor Class (for shared trees). If this instance is the only remaining
occurrence of the entry in any tree, it is then deleted not only as an item, but also as an entry
in the TIU TEMPLATE FILE and cannot be retrieved.
8927.03,.01 SEQUENCE 0;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 19, 1999
HELP-PROMPT: Type a Number between 1 and 99999, 0 Decimal Digits
DESCRIPTION: SEQUENCE number determines boilerplate text order for a GROUP TEMPLATE, with the GROUP TEMPLATE's
own boilerplate text preceding that of its items.
For containers and for GROUP TEMPLATES, SEQUENCE determines the order in which items appear when
the container is expanded.
SEQUENCE applies only to entries used as items.
CROSS-REFERENCE: 8927.03^B
1)= S ^TIU(8927,DA(1),10,"B",$E(X,1,30),DA)=""
2)= K ^TIU(8927,DA(1),10,"B",$E(X,1,30),DA)
8927.03,.02 ITEM 0;2 POINTER TO TIU TEMPLATE FILE (#8927) (Required)
INPUT TRANSFORM: K:$$BADITEM^TIUDDT(X,DA(1)) X
LAST EDITED: MAY 19, 1999
DESCRIPTION: Items are themselves members of the TIU TEMPLATE FILE, and vary according to the type of the item
parent.
A container (type C, P, or R) holds templates (TEMPLATES and GROUP TEMPLATES) as its items. It
may also hold other containers as items.
A GROUP TEMPLATE is made up of TEMPLATES or of other GROUP TEMPLATES as items. Its boilerplate
text is a composite consisting of, first, it own boilerplate text if it has any, and then the
boilerplate text of its items, in SEQUENCE order. (See also field EXCLUDE FROM GROUP
BOILERPLATE.) A GROUP TEMPLATE may also have a container (type C) as an item. In this case, the
container is simply being stored in the GROUP TEMPLATE; the container is ignored when the GROUP
TEMPLATE is used for composing a document.
A TEMPLATE (type T) does not have items.
A given template or container may occur as an item in more than one tree, and may even occur more
than once in the same tree. It cannot, however, be an item under itself. Nor can it occur
twice, as an item of the same parent.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 8927^AD
1)= S ^TIU(8927,"AD",$E(X,1,30),DA(1),DA)=""
2)= K ^TIU(8927,"AD",$E(X,1,30),DA(1),DA)
FILES POINTED TO FIELDS
GMRC PROCEDURE (#123.3) LINK (#.19)
NEW PERSON (#200) PERSONAL OWNER (#.06)
OE/RR COM OBJECTS (#101.15) COM OBJECT (#.17)
REMINDER DIALOG (#801.41) REMINDER DIALOG (#.15)
REQUEST SERVICES (#123.5) LINK (#.19)
TIU DOCUMENT DEFINITION (#8925.1) LINK (#.19)
TIU TEMPLATE (#8927) ITEMS:ITEM (#.02)
USR CLASS (#8930) EDITOR CLASS (#.07)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):