The Master Data Model for Veteran Care

Developer Documentation » VDM » Protocol-101

Protocol (101)

This file contains the orderables and methods for accomplishing orders (protocols) within OE/RR.

Global: ^ORD(101,

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Name
  name
.01 A unique name, which is preceded by the package namespace. STRING INDEXED
REQUIRED
 
Item Text
  item_text
1 The protocol’s text as it appears to the user on the menu or subheader. STRING INDEXED  
Synonym
  synonym
1.1 This is another name for the protocol that may be used on lookup. STRING    
Print Name
  print_name
1.11 This is a shortened version of the item text to be used on print-outs
where the name must be abbreviated.
STRING    
Disable
  disable
2 This field disables use of the protocol when there is text in it. The
text should be a short message explaining why use of the protocol has
been disabled, as it will be displayed if the protocol is selected.
STRING    
Lock
  lock
3 This field is used to deny access to users who have this option
as part of their menu. If an option has a lock, then only users
who hold the matching key can access it.
STRING    
Description
  description
3.5 This field contains a brief explanation of the protocol. STRING    
Prohibited Times
  prohibited_times
3.9 This specifies a time range during which this option cannot be accessed.
The time should be entered in military format. For example, to
prohibit an option from running between 9 AM and 2 PM, enter 0900-1400.
STRING    
Type
  type-4
4 This field defines the type of protocol to be executed. Types Q, O, and
L are strictly related to the ‘Add orders’ function.
Q = Protocol menu - used for displaying and selecting orderable items
during the add sequence. When this type of protocol is encountered
OE/RR will ask the ‘Select PATIENT:,’ ‘LOCATION:,’ ‘Provider:’
prompts and execute the transaction logic for the new orders
screen. This is also true for type O and L.
O = Protocol - same as Q but the protocol is the item selected.
Protocols are directly executed when encountered.
L = Limited protocol - same as O but any existing sub-items are
not executed.
M = Menu - used for displaying and selecting items.
X = Extended action - protocols of this type execute the entry action
plus all sub-items.
A = Action - same as X but any existing sub-items are
not executed.
X = Extended action - protocols of this type execute the entry action
plus all sub-items.

A = Action - same as X but any existing sub-items are
not executed.
ENUMERATION REQUIRED term: T
protocol: O
menu: M
protocol menu: Q
event driver: E
subscriber: S
extended action: X
dialog: D
action: A
limited protocol: L
Creator
  creator
5 This field identifies who created the protocol. POINTER REQUIRED New_Person-200
File Link
  file_link
6 This field is a variable pointer which may point to the entry in a file
to which a protocol is linked.
POINTER INDEXED Option-19
Laboratory_Test-60
Collection_Sample-62
Topography_Field-61
Rad_nuc_Med_Procedures-71
Urgency-62_05
Execute_Code-62_07
Request_Services-123_5
Request_Action_Types-123_1
Cost
  cost
8 This is the cost of filling the order associated with this protocol. NUMERIC    
Item
  item
10 This is the item multiple for a protocol OBJECT   Item-101_01
Package
  package
12 Pointer to Package File (#9.4). POINTER   Package-9_4
Exit Action
  exit_action
15 This field contains MUMPS code which will be executed on leaving
this option. It is only applicable to Menu types.
STRING    
Entry Action
  entry_action
20 This field contains MUMPS code which will be executed on entering
this option. It is applicable to Menu and Action types.
STRING    
Required Variables
  required_variables
21 This lists the variables that must be defined for the proper execution of
this protocol. This aids in documenting the protocol. Also, in the case
of ‘;’ jumping, the variables defined as required may be newed before
jumping, thus preserving the context when returning from the jump.
STRING    
Screen
  screen
24 This field contains MUMPS code that screens out menu items or the
execution of particular items in a protocol. Before each item is
displayed or executed, the screen is executed and the item is only
processed if $T is true.
STRING    
Header
  header
26 In the case of menus (type M or Q), this contains MUMPS code that is
executed to display a header for the menu.
STRING    
Menu Help
  menu_help
27 This contains MUMPS code that displays additional help to that already
given with the menu.
STRING    
Menu Prompt
  menu_prompt
28 This contains text to replace the standard “Select Item: “ prompt normally
given with a menu.
STRING    
Menu Default
  menu_default
29 This field contains a default response (i.e., default selection from the
menu), if desired.
STRING    
Dic {dic}
  dic_dic
30 This field is used as the global reference passed to ^DIC for a file
look-up. The entry should be in the regular format for a call to ^DIC
i.e. ^GL(41,
STRING    
Column Width
  column_width
41 This is the width, in characters, for each column on a menu. For example,
to have 3 columns on an 80 character device, enter a column width of 26.
NUMERIC    
Mnemonic Width
  mnemonic_width
42 This field allows the width allowed for mnemonics to be varied. The
default width is 5.
NUMERIC    
Path Switch
  path_switch
43 This allows the user, when traversing back UP the tree of protocols, to
select a new path back down the tree. In other words, the menu is
redisplayed when returning to that menu’s level in the tree, and processing
back down the tree is possible from that point. If nothing is selected
from the menu, the path continues back up the tree.
BOOLEAN   false: N
true: Y
Identifier
  identifier
44 Entries into this file can be given identifiers to show context, function
and/or relationships. For example, Digoxin may exist in the file as three
different entries with identifiers of SERUM, PLASMA and Drug.
STRING    
Timestamp
  timestamp
99 This contains the $H time that fields which are necessary to menu display
were last changed.
STRING    
*order Print Action
  order_print_action
100 NOTICE- THIS FIELD WILL BE REMOVED IN A FUTURE VERSION
Package action when a detailed listing of an order is requested.
Included in this file for backward compatability with earlier versions
of OE/RR.
STRING DEPRECATED  
*order Cancel Action
  order_cancel_action
100.1 NOTICE- THIS FIELD WILL BE REMOVED IN A FUTURE VERSION
Package action when an order is cancelled or discontinued. Included in
this file for backward compatability with earlier versions of OE/RR.
STRING DEPRECATED  
*order Purge Action
  order_purge_action
100.2 NOTICE- THIS FIELD WILL BE REMOVED IN A FUTURE VERSION
Package action when an order is to be purged from file 100. Included in
this file for backward compatability with earlier versions of OE/RR.
STRING DEPRECATED  
Access
  access
100.3 This multiple contains the list of security keys which allow access to
the protocol. If there are no keys, all users have access.
POINTER   Security_Key-19_1
Requires Signature
  requires_signature
101.01 This field is used to specify an orderable/protocol that does not
require a physician signature in OE/RR. Some of the things entered
in OE/RR are considered instructions and don’t require physician
signature. An example of this might be an entry for an Early/Late tray.
ENUMERATION   NO SIGNATURE REQUIRED: 1
PHYSICIAN SIGNATURE: 0
Domain (data Type)
  domain_data_type
101.041 This is the data type of a term (i.e. protocol of type term) used in a
dialog.
ENUMERATION   free text: F
set of codes: S
list or range: L
menu: M
numeric: N
yes/no: Y
date/time: D
word processing: W
pointer: P
Default Prompt
  default_prompt
101.042 For this term, this is the prompt that is automatically used when the
term is used as an item in a dialog. The prompt may be modified at the
item level.
STRING    
Default Answer
  default_answer
101.043 For a term protocol, this is the default answer that is automatically used
when the term is used as an item in a dialog. The default may be modified
at the item level.
STRING    
Default Word Processing Answer
  default_word_processing_answer
101.0431 This is text used as a template for an item in a dialog that is a word
processing type.
STRING    
Default Help
  default_help
101.044 For a term protocol, this is the help text that is automatically used when
the term is used as an item in a dialog. The help text may be replaced at
the item level.
STRING    
Domain Parameter
  domain_parameter
101.045 This is a parameter that may be used to further specify the data type
(i.e. input transform) for a term protocol. The parameter is what would
be placed in the second up-arrow piece of DIR(0) when calling the reader.
STRING    
Method
  method
101.05 This number identifies individual methods (actions) that may be invoked
for this protocol.
OBJECT   Method-101_05
Set Membership
  set_membership
101.07 This is a namespaced name of a set. If this is entered, a cross reference
of the format “S.set membership” is created. This allows rapid lookups on
subsets of the Protocol file.
STRING    
Sending Application
  sending_application
770.1 Enter the name of the application that initiates a transaction. It
is required only when defining an EVENT POINT protocol.
POINTER   Hl7_Application_Parameter-771
Response Message Type
  response_message_type
770.11 Enter the message type of the expected RESPONSE. It should only be defined
on a SUBSCRIBER PROTOCOL.

NOTE:
In a contract between the initiating system and the responding system, the
Event Driver protocol defines the characteristics of the INITIATING
SYSTEM. The Initiating System initiates either queries or unsolicited
update messages. A Subscriber Protocol defines the characteristics of the
RESPONDING SYSTEM. The responding system completes a transaction by
returning either an acknowledgement and/or a response to the specific
query message.
POINTER   Hl7_Message_Type-771_2
Batch/file Message Commit Ack
  batch_file_message_commit_ack
770.14 In a bi-directional interface, this field will be used
to determine whether or not a Batch or File message should
send or receive a Commit Acknowledgement. A Batch or File
message will always send/receive an Application Ack. This
feature is non-standard according to HL7. It is needed to
insure the receipt of a message.
BOOLEAN   false: 0
true: 1
Receiving Application
  receiving_application
770.2 This is the application that receives a message. It is otherwise known as
the “responding” application when a transaction takes place. This
information is required for SUBSCRIBER protocols only.
POINTER INDEXED Hl7_Application_Parameter-771
Transaction Message Type
  transaction_message_type
770.3 Enter the name of the message type for the the message that is sent from
the initiating system. When initiating a new transaction, this field is
referenced when generating the header for the outbound message.

NOTE:
In a contract between the initiating system and the responding system, the
Event Driver protocol defines the characteristics of the INITIATING
SYSTEM. The Initiating System initiates either queries or unsolicited
update messages. A Subscriber Protocol defines the characteristics of the
RESPONDING SYSTEM. The responding system completes a transaction by
returning either an acknowledgement and/or a response to the specific
query message.
POINTER   Hl7_Message_Type-771_2
Event Type
  event_type
770.4 This is the HL7 Event Type code for the message represented by this
protocol. In HL7, the message type and event type of an application
response message may be different from the original message.

If this is an event point protocol, enter the event type
corresponding to the initial message generated by the SENDING APPLICATION.


If this is a subscriber protocol, then enter the event type corresponding
to the RECEIVING APPLICATION response. Note that an event type is not
required when responding with a general acknowledgement (ACK) and the
receiving application does not always need to generate a response.

NOTE:

1. In “original acknowledgement mode” the receiving application always
generates the response.
2. In “enhanced acknowledgement mode” the HL7 package may be configured to
produce a “commit ack” before the application receives the message. If the
receiving application does not need to generate a response in addition to
the ack, then the event type is the same as the original message (and the
message type would be ACK)
3. In “enhanced acknowledgement mode with two-phase commit” the HL7
package generates a commit ack, and passes the message to the application.
The second phase of the transaction occurs when the application is ready
to initiate a response. This is interpreted as the start of a new
transaction and may require a commit ack itself.
POINTER   Hl7_Event_Type_Code-779_001
Message Structure
  message_structure
770.5 The message structure is associated with the message type and event type defined by HL7 v2.3.1 and beyond. POINTER   Hl7_Message_Structure_Code-779_005
Processing Id
  processing_id
770.6 This field describes how a message should be processed once it is handed
off to the receiving application.

PROCESSING ID is a required field in the HL7 message header. However, the
Event Driver protocol entry is only used whenset to DEBUG. Data for the
header is normally derived from the HL COMMUNICATION SERVER FILE. If
testing a transaction in Debug mode, make sure it is changed on both the
sending and receiving system.


The receiving application developer should consider checking this portion
of the header before filing data on a production system. Training and
Debug messages may not be suitable for filing.
ENUMERATION   debug: D
Logical Link
  logical_link
770.7 This field is used with a SUBSCRIBER PROTOCOL to describe the network path
to the subscriber. It is most often used with a fixed point-to-point
interface between Vista and another system, e.g., a local COTS application
or another Vista facility. See the documentation on use of the ROUTING
LOGIC field and “dynamic addressing” for more complex routing scenarios.
POINTER   Hl_Logical_Link-870
Accept Ack Code
  accept_ack_code
770.8 This field defines whether or not a COMMIT ACK will be generated by the
HL7 package. This only applies to transactions using version 2.2 and
higher of the HL7 Standard. See Chapter 2 of the HL7 Standard for details
of Enhanced Mode Acknowledgements.
POINTER   Hl7_Accept_application_Ack_Condition-779_003
Application Ack Type
  application_ack_type
770.9 For transactions using versions 2.2 and higher of the HL7 standard, this
field defines whether or not the receiving application is expected to
return an acknowledgement. Enhanced Mode Application Acks are always
initiated as a new transaction. The following is an example of a 2-phased
acknowledgement over a tcp connection.


(A)INITIATING SYSTEM (B)RESPONDING SYSTEM

PHASE I
Open connection to B
send ADT/A04—————–>receive ADT/A04
validate header
commit to safe storage
receive CA<——————-send CA to A
Close connection

PHASE II
handoff to receiving Application
parse and validate message content
generate APPLICATION ACCEPT ACK
Open connection to A
receive AA<——————-send AA
validate header
commit to safe storage
send CA to B——————>receive CA
close connection
POINTER   Hl7_Accept_application_Ack_Condition-779_003
Version Id
  version_id
770.95 Enter the version of the HL7 standard used to implement this transaction.

Note that a screen has been added to insure that the version selected
corresponds to the appropriate version of the Message Type defined.
POINTER   Hl7_Version-771_5
Processing Routine
  processing_routine
771 This field is executed on the receiving system. It defines the routine
used to process the original inbound message in a transaction and to
GENERATE and APPLICATION response/ACK back to the sending system using the
entry point, GENACK^HLMA1.
STRING    
Response Processing Routine
  response_processing_routine
772 This field is executed on the sending system when an Acknowledgement or
Query response is received. The message ID of the original message is
always contained within the response. This is used to identify the
location of the original message and the corresponding event point
protocol. Note that this pertains to Original and Enhanced Mode
Application Acks only. The HL7 package generates and processes
Enhanced mode Commit Accepts internally.
STRING    
Sending Facility Required?
  sending_facility_required
773.1   BOOLEAN   false: 0
true: 1
Receiving Facility Required?
  receiving_facility_required
773.2   BOOLEAN   false: 0
true: 1
Security Required?
  security_required
773.3   BOOLEAN   false: 0
true: 1
Date/time Of Message Required?
  date_time_of_message_required
773.4   BOOLEAN   false: 0
true: 1
Ack Mode Set In Subscriber
  ack_mode_set_in_subscriber
773.5 A ‘YES’ of this field will indicate that MSH-15 and MSH-16 will be taken
from Subscriber protocol instead of the value(s) defined in Event driver
protocol.
BOOLEAN   false: 0
true: 1
Routing Logic
  routing_logic
774 M code in this field is executed only when a message is in an OUTBOUND
state. Normally, Vista HL7 ‘broadcasts’ a message to all subscribers
whenever a message is generated. However, in some cases, a client may need
to receive the message only if it matches a particular condition. This
field allows you to set up screening logic to interpret the message and
dynamically address the message to those interested in the data when it
meets these conditions. The output of your routing logic routine should be
the creation of a list of additional message recipients set into the
HLL(“LINKS”) array.

For details on dynamic addressing, see the documentation for HL1.614.
STRING    
Subscribers
  subscribers
775   POINTER   Protocol-101

↑ Return to top

Sub-Files

Item (101.01)

ID
Item-101_01

Properties

Label/Field Name Field # Description Datatype Attributes Range
Item
  item
.01 This points to a protocol which is subordinate to this protocol.
NOTE: The parent protocol or one of its ancestors may not be entered
as an item.
POINTER INDEXED
REQUIRED
Protocol-101
Mnemonic
  mnemonic
2 This is a short abbreviation for the item. STRING    
Sequence
  sequence
3 This is the order in which items in the list should be processed. In the
case of menus, the items are displayed in the order derived from this
field. In the case of protocols and extended actions, the items are
executed in the order derived from this field.
NUMERIC    
Modifying Action
  modifying_action
4 This points to a protocol which is executed before the item for this same
entry is executed. This allows the possibility of creating protocols
which set up special variables, etc., according to the context of the
protocol. It also allows screens at the item level if the variables
ORQUIT or ORABORT are used to prevent execution of the item.
POINTER   Protocol-101
Format Code
  format_code
5 This allows items used on menus for formatting purposes to be made
unselectable (sub-headers, blank lines, etc.).
ENUMERATION   output only: O
header: H
Display Name
  display_name
6 This allows the item text that normally appears on the menu to be
displayed. For example, this field may be used to set up menus so
that items are displayed in mixed case, even though the item text may
all be in upper case.
STRING    
Prompt
  prompt
11 This is the actual prompt displayed for this item in the dialog. STRING    
Default
  default
12 This is the default response for this item in the dialog. STRING    
Help
  help
13 This is the help text displayed for this item in the dialog. STRING    
Mode
  mode
14 This tells how this item should be treated when processing the dialog.
S - suppresses inclusion of the prompt when creating the text generated
by the dialog.
E - allows the item to only be presented when editing an existing
response.
R - identifies the field as required.
STRING    

↑ Return to top

Method (101.05)

ID
Method-101_05

Properties

Label/Field Name Field # Description Datatype Attributes Range
Method
  method
.01 This is reserved for future use. The numeric values of this field
currently correspond to OE/RR actions.
NUMERIC REQUIRED  
Method Action
  method_action
.02 This is the code necessary to implement the method. STRING    

↑ Return to top


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