The Master Data Model for Veteran Care

Developer Documentation » MVDM » Tiu_Document_Definition

Tiu_Document_Definition

TIU Document Definition

This file stores Document Definitions, which identify and define behavior for documents stored in the TIU DOCUMENTS FILE (#8925). For consistency with the V-file schema, it may be viewed as the "Attribute Dictionary" for the Text Integration Utilities.

It also stores Objects, which can be embedded in a Document Definition's Boilerplate Text (Overprint). Objects contain M code which gets a piece of data and inserts it in the document's Boilerplate Text when a document is entered.

Warning: objects embedded in boilerplate text are looked up by multiple index (i.e. DIC(0) contains 'M'). Current code (see routine CHECK^TIUFLF3) checks all present indexes to make sure object names, abbreviations and print names are not ambiguous for this lookup. If new indexes are added, this code MUST BE UPDATED to check the new index as well.

Some entries in this file are developed Nationally and exported across the country. Others are created by local sites. Entries in the first category are marked National Standard and are not editable by sites.

This file does NOT allow multiple entries OF THE SAME TYPE with the same name. That is, within a given Type, there are no duplicate names. (This refers to the .01 field, the Technical name of the entry.)

This file does not allow a parent to have items with the same name, even if the items have different internal file numbers (i.e. are different file entries). Again, this refers to the .01 Technical name of the entry.

Because of ownership considerations, the file does NOT allow an entry to be an item under more than 1 parent. If the same item is desired under more than 1 parent, the item must be copied into a new entry. There is one exception: Document Definitions of Type Component which have been marked Shared may have more than one parent.

The Document Definition Utility TIUF categorizes certain fields as Basic, Technical, or Upload, and displays these fields together as a group when user edits or views a Document Definition. BASIC fields include Name, Abbreviation, Print Name, Type, Personal Owner, Class Owner, Status, In Use, Shared, Orphan, Has Boiltxt, National Standard, OK to Distribute, and Suppress Visit Selection. TECHNICAL fields include Entry Action, Exit Action, Edit Template, Print Method, Print Form Header, Print Form Number, Print Group, Allow Custom Form Headers, Visit Linkage Method, Validation Method, and Object Method. UPLOAD fields include Upload Target File, Laygo Allowed, Target Text Field Subscript, Upload Look-up Method, Upload Post-Filing Code, Upload Filing Error Code, and multiples Upload Captioned ASCII Header and Upload Delimited ASCII Header.

The Document Definition file contains extensive, detailed field descriptions. Likewise, some protocols (File 101) used in TIU have extensive and careful descriptions in the Protocol file. Many of these descriptions are used in TIU for online help. If it becomes necessary for a national programmer to edit these descriptions, the programmer should check to make sure all online help is still displayed properly.

Users are expected to use the Document Definition Utility TIUF to enter, edit, and delete file entries. In fact, the file prohibits the deletion of entries through generic Fileman Options. It also prohibits the edit through generic Fileman of a few critical fields: Type, Status, Shared, and National Standard. Adding and Deleting (but not editing) Items is also prohibited through generic Fileman options. Abbreviation and Print Name of OBJECTS cannot be edited through generic Fileman Options.

This does NOT imply that it is SAFE to use generic Fileman to edit other fields. Users are cautioned that edit through generic Fileman bypasses many safeguards built in to the Document Definition Utility and can create havoc unless the user THOROUGHLY UNDERSTANDS the File and its uses.

If users find needs which are not met through TIUF, please communicate them to the TIU development team.

                           *****************

WARNING: Using generic Fileman options to edit entries can cause SERIOUS database problems.

                           ****************

Fileman ID: 8925.1

Base VDM Class: Tiu_Document_Definition-8925_1

Property Summary

Property Count: 50

Type Count
STRING 26
ENUMERATION 4
POINTER 6
BOOLEAN 7
OBJECT 5
NUMERIC 1
DATE-TIME 1

Sub-Object Count: 5

ID Label Field ID
1 Dialog dialog
2 Item item
3 Processing Steps processingSteps
4 Upload Captioned Ascii Header uploadCaptionedAsciiHeader
5 Upload Delimited Ascii Header uploadDelimitedAsciiHeader

↑ Return to top

Properties

Label/Field ID Datatype FromVDM Default Attributes Range
Name
  name
STRING name   INDEXED
REQUIRED
 
Abbreviation
  abbreviation
STRING abbreviation   INDEXED  
Print Name
  printName
STRING print_name   INDEXED  
Type
  type04
ENUMERATION type-_04   INDEXED
REQUIRED
0: DOCUMENT CLASS
1: OBJECT
2: COMPONENT
3: CLASS
4: TITLE
Personal Owner
  personalOwner
POINTER personal_owner   INDEXED New_Person-200
Class Owner
  classOwner
POINTER class_owner   INDEXED Usr_Class-8930
Status
  status
POINTER status   INDEXED TIU_Status-8925_6
Shared
  shared
BOOLEAN shared      
National Standard
  nationalStandard
BOOLEAN national_standard      
Posting Indicator
  postingIndicator
ENUMERATION posting_indicator   INDEXED 0: crisis note
1: warning
2: allergy/ADR
3: directive
Upload Delimited Ascii Header
  uploadDelimitedAsciiHeader
OBJECT upload_delimited_ascii_header     uploadDelimitedAsciiHeader
Upload Target File
  uploadTargetFile
POINTER upload_target_file     File-1
Laygo Allowed
  laygoAllowed
BOOLEAN laygo_allowed      
Target Text Field Subscript
  targetTextFieldSubscript
STRING target_text_field_subscript      
Boilerplate On Upload Enabled
  boilerplateOnUploadEnabled
BOOLEAN boilerplate_on_upload_enabled      
Upload Captioned Ascii Header
  uploadCaptionedAsciiHeader
OBJECT upload_captioned_ascii_header     uploadCaptionedAsciiHeader
Boilerplate Text
  boilerplateText
STRING boilerplate_text      
Ok To Distribute
  okToDistribute
BOOLEAN ok_to_distribute      
Suppress Visit Selection
  suppressVisitSelection
BOOLEAN suppress_visit_selection      
Upload Look-up Method
  uploadLookupMethod
STRING upload_lookup_method      
Commit Action
  commitAction
STRING commit_action      
Release Action
  releaseAction
STRING release_action      
Verification Action
  verificationAction
STRING verification_action      
Delete Action
  deleteAction
STRING delete_action      
Package Reassignment Action
  packageReassignmentAction
STRING package_reassignment_action      
Upload Post-filing Code
  uploadPostfilingCode
STRING upload_postfiling_code      
Entry Action
  entryAction
STRING entry_action      
Exit Action
  exitAction
STRING exit_action      
Upload Filing Error Code
  uploadFilingErrorCode
STRING upload_filing_error_code      
Post-signature Code
  postsignatureCode
STRING postsignature_code      
Edit Template
  editTemplate
STRING edit_template      
Print Method
  printMethod
STRING print_method      
Print Form Header
  printFormHeader
STRING print_form_header      
Print Form Number
  printFormNumber
STRING print_form_number      
Print Group
  printGroup
NUMERIC print_group      
Allow Custom Form Headers
  allowCustomFormHeaders
BOOLEAN allow_custom_form_headers      
On Browse Event
  onBrowseEvent
STRING on_browse_event      
On Retract Event
  onRetractEvent
STRING on_retract_event      
Visit Linkage Method
  visitLinkageMethod
STRING visit_linkage_method      
Validation Method
  validationMethod
STRING validation_method      
Object Method
  objectMethod
STRING object_method      
Item
  item
OBJECT item     item
Stat Auto Print Event
  statAutoPrintEvent
ENUMERATION stat_auto_print_event      
Routine Auto Print Event
  routineAutoPrintEvent
ENUMERATION routine_auto_print_event      
Processing Steps
  processingSteps
OBJECT processing_steps     processingSteps
Dialog
  dialog
OBJECT dialog     dialog
Timestamp
  timestamp
STRING timestamp      
Vha Enterprise Standard Title
  vhaEnterpriseStandardTitle
POINTER vha_enterprise_standard_title   INDEXED TIU_Vha_Enterprise_Standard_Title-8926_1
Map Attempted
  mapAttempted
DATE-TIME map_attempted      
Map Attempted By
  mapAttemptedBy
POINTER map_attempted_by     New_Person-200

↑ Return to top

Sub-Objects

1. Dialog

Field ID: dialog

Properties

Label/Field ID Datatype FromVDM Default Attributes Range
Prompt
  prompt
STRING prompt   INDEXED
REQUIRED
 
Item Name
  itemName
STRING item_name      
Sequence
  sequence
NUMERIC sequence   INDEXED  
Field
  field
STRING field      
Required
  required
BOOLEAN required      
Visible
  visible
BOOLEAN visible      
Set Method
  setMethod
STRING set_method      
Windows Control
  windowsControl
ENUMERATION windows_control     0: SimpleList
1: Edit
2: Memo
3: LongList
Api Name
  apiName
STRING api_name      
Api Parameter #1
  apiParameterNumber1
STRING api_parameter_number1      
Windows Condition
  windowsCondition
STRING windows_condition      
Windows Default
  windowsDefault
STRING windows_default      

↑ Return to top

2. Item

Field ID: item

Properties

Label/Field ID Datatype FromVDM Default Attributes Range
Item
  item
POINTER item   INDEXED
REQUIRED
Tiu_Document_Definition-8925_1
Mnemonic
  mnemonic
STRING mnemonic      
Sequence
  sequence
NUMERIC sequence   INDEXED  
Menu Text
  menuText
STRING menu_text   REQUIRED  

↑ Return to top

3. Processing Steps

Field ID: processingSteps

Properties

Label/Field ID Datatype FromVDM Default Attributes Range
Processing Step
  processingStep
POINTER processing_step   INDEXED
REQUIRED
Usr_Action-8930_8
Sequence
  sequence
NUMERIC sequence      
Required?
  required
ENUMERATION required     0: REQUIRED
1: OPTIONAL
Resulting Status
  resultingStatus
POINTER resulting_status     Usr_Record_Status-8930_6
Condition Text
  conditionText
STRING condition_text      

↑ Return to top

4. Upload Captioned Ascii Header

Field ID: uploadCaptionedAsciiHeader

Properties

Label/Field ID Datatype FromVDM Default Attributes Range
Caption
  caption
STRING caption   INDEXED
REQUIRED
 
Item Name
  itemName
STRING item_name   INDEXED  
Field Number
  fieldNumber
STRING field_number   INDEXED  
Lookup Local Variable Name
  lookupLocalVariableName
STRING lookup_local_variable_name   INDEXED  
Example Entry
  exampleEntry
STRING example_entry      
Clinician Must Dictate
  clinicianMustDictate
BOOLEAN clinician_must_dictate      
Required Field?
  requiredField
BOOLEAN required_field      
Transform Code
  transformCode
STRING transform_code      

↑ Return to top

5. Upload Delimited Ascii Header

Field ID: uploadDelimitedAsciiHeader

Properties

Label/Field ID Datatype FromVDM Default Attributes Range
Header Piece
  headerPiece
NUMERIC header_piece   INDEXED
REQUIRED
 
Item Name
  itemName
STRING item_name   INDEXED  
Field Number
  fieldNumber
STRING field_number   INDEXED  
Lookup Local Variable Name
  lookupLocalVariableName
STRING lookup_local_variable_name   INDEXED  
Example Entry
  exampleEntry
STRING example_entry      
Clinician Must Dictate
  clinicianMustDictate
BOOLEAN clinician_must_dictate      
Required Field?
  requiredField
BOOLEAN required_field      
Transform Code
  transformCode
STRING transform_code      

↑ Return to top


Document generated on August 31st 2017, 2:55:48 pm