Kernel 8.0 APIs Banner [skip navigation]
Office of Information & Technology (OIT) Banner

$$TYPE^XPDPROT(): Get Protocol Type

Reference Type: Supported, Category: Menu Manager, Integration Agreement: 5567

Description

This extrinsic function returns the value of the TYPE field (#4) in the PROTOCOL file (#101) for the input protocol IEN.

(NOTE: This API was released with Kernel Patch XU*8.0*547.)

Format

  $$LKPROT^XPDPROT(protocol_ien)

Input Parameters

protocol_ien:

(required) The protocol's internal entry number (IEN) in the PROTOCOL file (#101).

Output

returns:

Returns the one character TYPE field (#4) value in the PROTOCOL file (#101) for the input protocol IEN. For example:

  • A—Action: Same as the "X" type, except any existing sub-items are not executed.
  • M—Menu: This type is used for displaying and selecting items.
  • O—Protocol: This value is strictly related to the Add orders function. It is the same as the "Q" type, except the protocol is the item selected. Protocols are directly executed when encountered.
  • Q—Protocol Menu: This value is strictly related to the Add orders function. It is used for displaying and selecting orderable items during the add sequence. When this type of protocol is encountered OE/RR will prompt the user with "Select PATIENT:," "LOCATION:," and "Provider:," and execute the transaction logic for the new orders screen.
  • L—Limited Protocol: This value is strictly related to the Add orders function. It is the same as the "O" type, except any existing sub-items are not executed.
  • X—Extended Action: Protocols of this type execute the entry action plus all sub-items.
  • D—Dialog
  • T—Term
  • E—Event Driver
  • S—Subscriber

 


VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: August 09, 2012

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.