STANDARD DATA DICTIONARY #357.09 -- ENCOUNTER FORM PARAMETERS FILE 6/27/25 PAGE 1
STORED IN ^IBD(357.09, (1 ENTRY) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 3.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains the AICS parameters that control the operation of the package. Included are parameters to manage the automatic
purge and those necessary to create print manager jobs that automatically queue encounter forms to print.
DD ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
CROSS
REFERENCED BY: CLINIC GROUPS(ACG), NAME(B), PRINT PRIORITY(SEQ)
357.09,.001 NUMBER NUMBER
INPUT TRANSFORM: K:+X'=X!(X>1)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAR 03, 1995
HELP-PROMPT: Type a Number between 1 and 1, 0 Decimal Digits
DESCRIPTION: There is only one number in this ENCOUNTER FORM PARAMETERS file, and that is the number 'one'
denoting there is only one Encounter Form Parameter. The labels are subfields of this one
parameter.
357.09,.01 NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: MAR 03, 1995
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION:
This field is the name field. There should only be one entry in this field.
TECHNICAL DESCR:
CROSS-REFERENCE: 357.09^B
1)= S ^IBD(357.09,"B",$E(X,1,30),DA)=""
2)= K ^IBD(357.09,"B",$E(X,1,30),DA)
357.09,.02 RECORDS TO PURGE 0;2 SET
'0' FOR NONE;
'1' FOR COMPLETED;
'2' FOR ALL;
LAST EDITED: DEC 08, 1995
DESCRIPTION: Enter whether you want the background purge option to purge all records from form tracking older
that the number of days specified in the field FORM TRACKING RETENTION DAYS, or completed records,
or no records.
After purging records from form tracking, the purge utility will check to see if all forms for
inactive form definitions have been received. If so, then the form definition and Form
Specification for that form may be deleted. Purging ALL Form Tracking entries will cause the form
definition and form specification to be deleted for forms that have not yet been completed. Once
the form definition is deleted the form specification can not be recreated in DHCP, if it does not
exist on the AICS workstation the form can not be recognized. This is generally not a problem as
entries must be at least 60 days old to purge.
357.09,.03 FORM TRACKING RETENTION DAYS 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999)!(X<60)!(X?.E1"."1N.N) X
LAST EDITED: OCT 03, 1995
HELP-PROMPT: Type a Number between 60 and 9999, 0 Decimal Digits
DESCRIPTION: Enter the number of days to retain form tracking information after it is no longer used. The AICS
purge utility will delete entries in the Encounter Form Definition file (357.95), the Encounter
Form Tracking file (357.96), and the Form Specification file the number of days
357.09,.04 DEFAULT DATA ENTRY FORM 0;4 POINTER TO ENCOUNTER FORM FILE (#357)
LAST EDITED: DEC 08, 1995
HELP-PROMPT: Enter the form to be used as the default form for doing data entry when no form exists for a
clinic.
DESCRIPTION: This is the form definition that will be used during manual data entry if no form for a clinic is
defined. If this is not filled in then the PRIMARY CARE SAMPLE (2.1) form in the tool kit will be
used as the default form. If that form has been deleted then provider, procedure and diagnosis
will be asked but no quick entry features will be available.
357.09,.05 PRINT FORMS FOR INPATIENTS 0;5 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: DEC 18, 1995
HELP-PROMPT: If you would like to suppress printing of encounter forms for inpatients enter 'No'. Answering
'Yes' or leaving blank will cause Encounter Forms for inpatients to print.
DESCRIPTION: Enter 'Yes' if you want encounter forms printed for Inpatients or 'No' if no enounter forms for
inpatients should be printed. If this field is null, it will be treated as a 'Yes' and encounter
forms for inpatients will be printed.
This parameter affects all options that print forms for appointments for a clinic, it does not
affect printing individual forms.
TECHNICAL DESCR: This parameter is checked twice in routine IBDF1B1A when check the status of a patients
appointment.
357.09,.06 MAKE APPOINTMENT IN DATA ENTRY 0;6 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: APR 03, 1996
HELP-PROMPT: Enter 'Yes' if you want to be able to make a follow up appointment using the AICS manual Data entry
option.
DESCRIPTION: Enter 'Yes' if you wish for users at your site to be able to make a follow up appointment during
data entry of an encounter form or enter 'No' if you do not wish to see that prompt.
357.09,.07 PASS DATA TO PCE 0;7 SET
'0' FOR BACKGROUND;
'1' FOR BACKGROUND/W VALIDATION;
'2' FOR FOREGROUND/NO DISPLAY;
'3' FOR FOREGROUND/WITH DISPLAY;
LAST EDITED: APR 11, 1996
HELP-PROMPT: How should data captured in the AICS EF Data entry option be passed to PCE?
DESCRIPTION: Choose how data captured in the AICS EF Data Entry Options should be passed to PCE. The data entry
options use the same mechanism to update PCE (and scheduling) as the scanning software. Background
refers to sending data to PCE by using TaskMan to create a separate process so the user may
continue working. Foreground refers to sending the data to PCE in real time. The choices for data
entry are:
Background - This is the fastest method for the user. No validation
of the data is done by PCE and no display there is no display of
results.
Background with Validation - This is the next fastest way. The data
is validated with PCE prior to passing in the background. If the
data does not validate, the user will be shown the error messages
and allowed to re-edit the data.
Foreground with no display of data - Data is always validated when
passed to PCE in the foreground. If the data does not validate,
the user will be shown the error messages and allowed to re-edit
the data.
Foreground with display - This is the slowest method but will be most
useful as a validation tool. The data sent to PCE is redisplayed
after it has been been accepted by PCE. Any differences in what
was supposed to be sent and what was actually sent should be noticable.
357.09,.08 FILL % FOR BUBBLES 0;8 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JAN 21, 1997
HELP-PROMPT: Type a Number between 0 and 99, 0 Decimal Digits. This is the amount of fill required for Paper
Keyboard to recognize the Bubble as checked.
DESCRIPTION: Enter a number between 0 and 99 that represents the percentage of fill required for a bubble to be
considered as checked. Entering a zero will leave the determination up to Paper Keyboard. If this
field is left blank AICS will use 20% as the amount of fill required.
This field corresponds to the Threshold % field in the Metric dialog box in Paper Keyboard.
Modifying this field will only affect new forms. Existing form specification files will not be
affected. To modify an existing form specification file it must be deleted from the workstation
and the corresponding entry in file 359.2 must be deleted.
WRITE AUTHORITY: ^
357.09,.09 BACKGROUND % FOR BUBBLES 0;9 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JAN 21, 1997
HELP-PROMPT: Type a Number between 0 and 99, 0 Decimal Digits. This is the amount of background allowable that
Paper Keyboard will ignore.
DESCRIPTION: Enter a number between 0 and 99 that represents the percentage of background fill in a bubble that
can exist before Paper Keyboard will consider any markings in the bubble. If this field is left
blank then AICS will use 5%. Entering a zero leaves the determination up to Paper Keyboard.
This field corresponds to the Background % field in the Metric dialog box. Entering a small value
prevents small dots on the page from appearing as check marks. The value of this field should
always be less than the value for the FILL % FOR BUBBLES field.
Editing this field will not affect any current form specification files, only files created after
changing this value. To modify a current form specification you must delete the file from the
workstation and remove the corresponding entry from file 359.2.
WRITE AUTHORITY: ^
357.09,.1 DAYS TO PRINT 1010F 0;10 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: MAR 17, 1997
HELP-PROMPT: Type a Number between 0 and 999, 0 Decimal Digits
DESCRIPTION: If you have chosen to print a 1010F with your encounter forms, this is the number of days between
the expiration of a means test and the appointment date before that you want to print 1010F's for.
For example, if this field is set to 30, then 1010F's will print for means tests that are due to
expire within 30 days of the appointment. 1010F's will also print if they are in a required
status.
TECHNICAL DESCR:
This parameter is used in PRMT^IBDFN2 if a 1010F is printed from the print manager.
357.09,.11 DAYS TO RETAIN PENDING PAGES 0;11 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: OCT 07, 1997
HELP-PROMPT: Type a Number between 0 and 999, 0 Decimal Digits
DESCRIPTION: Enter the number of days that entries in Form Tracking will be retained in a Pending Pages status.
The automatic encounter form job will check this value each night and attempt to pass forms in this
status to PCE after they have been in this status for the specified number of days past the
encounter date.
357.09,.12 REDUCE HANDPRINT RECOGNITION SIZE 0;12 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>8)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: NOV 20, 1998
HELP-PROMPT: Entering a number greater than zero will reduce the recognition area of hand print fields by .1mm
on all sides. Type a Number between 0 and 8.
DESCRIPTION: When scanning, some sites have problems with the outline of hand print fields not being removed
completely. This results in "phantom" entries being detected by Paper Keyboard and user validation
during recognition.
This problem is caused by the interaction of 3 different features, the darkness of the print, the
size of the recognition area, and the light intensity of the scanner. This field allows you to
reduce the size of the recognition area which may assist in moving the "phantom" outside of the
recognition area. This information is then computed and stored in the FormSpec file on the VistA
server and the workstation.
To leave the recognition area the same size as before AICS v3.0 patch IBD*3*25 enter a zero. The
default value of the field if there is no entry is 5. The maximum value of the field is 8.
Reducing the size will move all 4 sides of the box in by .1mm times the number entered.
If you are having the "phantom" problem, you should also check the value in fields DARKNESS OF DOTS
and CLOSENESS OF DOTS in this file. These fields allow for printing the hand print field outlines
at a lighter value.
TECHNICAL DESCR: The value of this field is used in routine IBDFBKS2 to reduce the xy coordinates that are computed
as the recognition area in the Paper Keyboard form spec file.
WRITE AUTHORITY: ^
357.09,.13 DARKNESS OF DOTS 0;13 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>15)!(X<9)!(X?.E1"."1N.N) X
LAST EDITED: AUG 12, 1998
HELP-PROMPT: Entering a number of less than 12 will reduce the size of dots that print on Encounter Forms. Type
a Number between 9 and 15, 0 Decimal Digits
DESCRIPTION: When scanning, some sites have problems with the outline of hand print fields not being removed
completely. This results in "phantom" entries being detected by Paper Keyboard and user validation
during recognition.
This problem is caused by the interaction of 3 different features, the darkness of the print, the
size of the recognition area, and the light intensity of the scanner. This field allows sites to
determine the Pen Width value of the dots of handprint fields and bubbles when printing on laser
printers. Reducing the pen width below 12 will make the dots smaller thus making it more likely
for the dots to disappear during the scanning process.
To leave the dot size the same as before AICS v3.0 patch IBD*3*25 enter a 12. The default value of
the field if there is no entry is 12. The minimum value of this field is 9, the maximum value is
15. Changing this value immediately affects the printing of encounter forms. Test changes by
changing the value one number at a time and then viewing the form.
If you are having the "phantom" problem, you should also check the values in fields CLOSENESS OF
DOTS and REDUCE HANDPRINT RECOGNITION SIZE in this file. These fields allow for printing the hand
print field outlines at a lighter value and reduce the size of the area used for recognition.
357.09,.14 CLOSENESS OF DOTS 0;14 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>30)!(X<20)!(X?.E1"."1N.N) X
LAST EDITED: AUG 12, 1998
HELP-PROMPT: Type a Number between 20 and 30, 0 Decimal Digits. The default value is 25. A number lower than
25 will reduce "Phantom" data found during scanning.
DESCRIPTION: When scanning, some sites have problems with the outline of hand print fields not being removed
completely. This results in "phantom" entries being detected by Paper Keyboard and user validation
during recognition.
This problem is caused by the interaction of 3 different features, the darkness of the print, the
size of the recognition area, and the light intensity of the scanner. This field allows sites to
determine the percentage of fill (closeness of dots) that is used to print handprint field outlines
and bubbles when using a laser printer.
To leave the closeness of dots the same as before AICS v3.0 patch IBD*3*25 enter a 25. The default
value of the field if there is no entry is 25. The minimum value of this field is 20, the maximum
value is 30. Changing this value immediately affects the printing of encounter forms. Reducing
the closeness of dots below 25 will allow Paper Keyboard to more easily remove the dots. Test
changes by changing the value one number at a time and then viewing the form.
If you are having the "phantom" problem, you should also check the values in fields DARKNESS OF
DOTS and REDUCE HANDPRINT RECOGNITION SIZE in this file. These fields allow for printing of the
hand print field outlines at a lighter value and improve recognition during scanning.
357.09,1.01 PURGE NOTIFICATION MAIL GROUP 1;1 POINTER TO MAIL GROUP FILE (#3.8)
LAST EDITED: DEC 08, 1995
HELP-PROMPT: This mail group will automatically receive notification of purge results. Results are also stored
in the AICS PURGE LOG file and may be reviewed. Mail notification is not required.
DESCRIPTION: Enter the name of the mail group that should receive the automatic notification of purge results.
Purge results are sent every time the AICS purge runs, regardless of whether or not the auto purge
or manual purge is run.
If no group is entered then no message will be sent. Results are always stored in the AICS PURGE
LOG file (357.08) and can be reviewed at any time.
357.09,1.02 STOP DEFAULTING C/O DATE/TIME 1;2 SET
'1' FOR YES;
LAST EDITED: JAN 22, 1997
HELP-PROMPT: Enter 'YES' to stop defaulting the checkout date/time during scanning to the scan date/time if no
checkout data exists on the form.
DESCRIPTION: If checkout date/time is not present on the Encounter Form, the software will automatically default
a checkout date/time to that of the scan date/ time. If you do not wish to default the checkout
date/time, you should enter 'YES' in this field to stop the automatic default.
357.09,11 PRINT MGR'S QUEUING PARAM NAME Q;0 Multiple #357.091 (Add New Entry without Asking)
LAST EDITED: NOV 04, 1997
DESCRIPTION: This field is a multiple. This is the name of the parameter group for the printing of encounter
forms. The encounter form background print job will loop through all of the parameter groups and
print the forms for the clinics that are under this parameter the print job.
TECHNICAL DESCR:
357.091,.01 PRINT MGR'S QUEUING PARAM NAME 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3) X
LAST EDITED: APR 02, 1996
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION: This field is the name of the parameter group for printing of encounter forms when using the
background print job.
CROSS-REFERENCE: 357.091^B
1)= S ^IBD(357.09,DA(1),"Q","B",$E(X,1,30),DA)=""
2)= K ^IBD(357.09,DA(1),"Q","B",$E(X,1,30),DA)
357.091,.02 DATE/TIME STARTED 0;2 DATE
INPUT TRANSFORM: S %DT="ETX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: OCT 04, 1995
HELP-PROMPT: This is the date/time that the print job began.
DESCRIPTION: This field is the date that the job started. It is supplied by the system when the queued print
job begins.
357.091,.03 DATE/TIME ENDED 0;3 DATE
INPUT TRANSFORM: S %DT="ETX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: OCT 04, 1995
HELP-PROMPT: This is the date/time the print job finished.
DESCRIPTION: This field contains the date that the print job finished. This data is supplied by the system
when the print job is finished.
357.091,.04 CLINIC SORT BY 0;4 SET (Required)
'1' FOR DIVISION/CLINIC/PATIENT;
'2' FOR DIVISION/TERMINAL DIGITS;
'3' FOR DIVISION/CLINIC/TERMINAL DIGITS;
LAST EDITED: OCT 04, 1995
HELP-PROMPT: Select the way the encounter forms should be sorted when printing.
DESCRIPTION: This field contains the sort sequence for the printing of encounter forms. Its value can be:
1) Division/Clinic/Patient
2) Division/Terminal Digits
3) Division/Clinic/Terminal Digits
357.091,.05 ADD ONS 0;5 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: OCT 04, 1995
DESCRIPTION: This field is a Yes/No field as to whether the print job will be just for printing add ons only.
If this field contains 'Yes', the print job will only print the add ons for the clinics.
357.091,.06 CLINIC GROUPS 0;6 POINTER TO PRINT MANAGER CLINIC GROUPS FILE (#357.99)
LAST EDITED: FEB 20, 1996
DESCRIPTION: This field is a pointer to the PRINT MANAGERS CLINIC GROUPS file (#357.99). This stores the name
of the clinic group that the encounter forms should be printed for. Each Clinic Group has one or
more clinics assigned to it.
CROSS-REFERENCE: 357.09^ACG
1)= S ^IBD(357.09,"ACG",$E(X,1,30),DA(1),DA)=""
2)= K ^IBD(357.09,"ACG",$E(X,1,30),DA(1),DA)
Cross reference of clinic groups used to prevent deleting of clinic groups used in parameter
setup.
357.091,.07 DAYS TO PRINT AHEAD 0;7 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>10)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JAN 09, 1996
HELP-PROMPT: Type a Number between 0 and 10, 0 Decimal Digits
DESCRIPTION: This field contains a number which will be the number of days ahead that the encounter forms will
be printed for.
TECHNICAL DESCR:
357.091,.08 SPECIAL INSTRUCTIONS 0;8 SET
'R' FOR RUN REGARDLESS;
'I' FOR IGNORE BOTH WEEKENDS AND HOLIDAYS;
'W' FOR IGNORE WEEKENDS;
'H' FOR IGNORE HOLIDAYS;
'T' FOR TODAY;
'N' FOR NOT ACTIVE;
LAST EDITED: FEB 09, 1996
DESCRIPTION: This field will store the special instructions for the printing of the encounter forms. The
values for this field can be:
(I) Ignore both holidays and weekends
(R) Run Regardless
(W) Ignore Weekends
(H) Ignore Holidays
(T) Today
(N) Not active
357.091,.09 DEVICE 0;9 FREE TEXT
INPUT TRANSFORM:N IBL S IBL=X,X=$P(X,";"),DIC=3.5,DIC(0)="EQZ" D ^DIC K:Y'>0!(X=" ") X S:$D(X) X=$G(Y(0,0))_$S(IBL[
";":";"_$P(IBL,";",2,99),1:"") S DIC=DIE
LAST EDITED: APR 02, 1996
HELP-PROMPT: Answer must be 3-40 characters in length.
DESCRIPTION: This field contains a free text pointer to the device. This stores the name of the printer where
the encounter forms should be printed for the print job.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
357.091,.1 PRINT PRIORITY 0;10 NUMBER (Required)
INPUT TRANSFORM:K:+X'=X!(X>999)!(X<1)!(X?.E1"."3N.N) X
LAST EDITED: OCT 04, 1995
HELP-PROMPT: Type a Number between 1 and 999, 2 Decimal Digits
DESCRIPTION: This field contains a number which will be used to sequence the print job tasks. The lower the
number, the higher the priority of the job and those will be queued to print first.
TECHNICAL DESCR:
CROSS-REFERENCE:357.09^SEQ
1)= S ^IBD(357.09,"SEQ",$E(X,1,30),DA(1),DA)=""
2)= K ^IBD(357.09,"SEQ",$E(X,1,30),DA(1),DA)
Cross reference used to find sequences to print encounter forms.
357.091,.11 TASK NUMBER 0;11 NUMBER
INPUT TRANSFORM:K:+X'=X!(X>999999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: OCT 04, 1995
HELP-PROMPT: Type a Number between 0 and 999999999, 0 Decimal Digits
DESCRIPTION: This field contains the task number from taskman, when a print job is queued to print. It will
delete the entry when the job finished. This value is supplied by the system. If the job has been
interrupted, waiting to run or is running this value will be present. This field is used by the
action Queue Status on the Parameter Interface screen. That action will give the user the status
of the queued job.
TECHNICAL DESCR:
357.091,.12 LAST DAY PRINTED 0;12 DATE
INPUT TRANSFORM:S %DT="EX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: OCT 04, 1995
DESCRIPTION: This field contains the last day teh encounter forms were printed for. This will keep track so
that the date does not get printed again.
357.091,.13 TIME QUEUED 0;13 FREE TEXT
INPUT TRANSFORM:K:$L(X)>4!($L(X)<4)!'(X?4N) X I $D(X),+$E(X,1,2)>24!(+$E(X,3,4)>59)!(+X>2400) K X
LAST EDITED: JAN 26, 1999
HELP-PROMPT: Enter time as a 4 digit number from 0000 - 2400 (military time). Answer must be 4 numbers in
length.
DESCRIPTION: This field stores the time that the job will queue to print. The user will supply the time as a 4
digit number from 0000 - 2400 (military time). This will allow the user to stagger the times
certain print jobs start to print to different printers.
TECHNICAL DESCR:
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
357.091,.14 PREVIOUS TASK NUMBER 0;14 NUMBER
INPUT TRANSFORM:K:+X'=X!(X>999999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: DEC 29, 1997
HELP-PROMPT: Type a Number between 0 and 999999999, 0 Decimal Digits
DESCRIPTION: This field holds the previous task number of the print job if the job has not finished the task
(due to paper jam etc.) before the job gets tasked again. The current job will be the most recent
task number and the previous task number will be the task number of the job that has not yet
finished.
FILES POINTED TO FIELDS
ENCOUNTER FORM (#357) DEFAULT DATA ENTRY FORM (#.04)
MAIL GROUP (#3.8) PURGE NOTIFICATION MAIL GROUP (#1.01)
PRINT MANAGER CLINIC GROUPS
(#357.99) PRINT MGR'S QUEUING PARAM NAME:CLINIC GROUPS (#.06)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):