HealthLevelSeven::Classes
Class Protocol

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

Attributes
*orderCancelAction *orderCancelAction

***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.

*orderPrintAction *orderPrintAction

***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.

*orderPurgeAction *orderPurgeAction

***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.

acceptAckCode acceptAckCode

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.

access access

This multiple contains the list of security keys which allow access to the protocol. If there are no keys, all users have access.

ackModeSetInSubscriber ackModeSetInSubscriber

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.

applicationAckType applicationAckType

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

batchFileMessageCommitAck batchFileMessageCommitAck

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.

Integer columnWidth columnWidth

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.

Integer cost cost

This is the cost of filling the order associated with this protocol.

«File 200» NewPerson creator creator

This field identifies who created the protocol.

dateTimeOfMessageRequired? dateTimeOfMessageRequired?

String defaultAnswer defaultAnswer

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 defaultHelp defaultHelp

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 defaultPrompt defaultPrompt

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.

defaultWordProcessingAnswer defaultWordProcessingAnswer

This is text used as a template for an item in a dialog that is a word processing type.

description description

This field contains a brief explanation of the protocol.

String dicDic dicDic

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 disable disable

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.

domainDataType domainDataType

This is the data type of a term (i.e. protocol of type term) used in a dialog.

String domainParameter domainParameter

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.

entryAction entryAction

This field contains MUMPS code which will be executed on entering this option. It is applicable to Menu and Action types.

eventType eventType

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.

exitAction exitAction

This field contains MUMPS code which will be executed on leaving this option. It is only applicable to Menu types.

fileLink fileLink

This field is a variable pointer which may point to the entry in a file to which a protocol is linked.

header header

In the case of menus (type M or Q), this contains MUMPS code that is executed to display a header for the menu.

String identifier identifier

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.

item item

This is the item multiple for a protocol

String itemText itemText

The protocol's text as it appears to the user on the menu or subheader.

String lock lock

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.

logicalLink logicalLink

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.

String menuDefault menuDefault

This field contains a default response (i.e., default selection from the menu), if desired.

menuHelp menuHelp

This contains MUMPS code that displays additional help to that already given with the menu.

String menuPrompt menuPrompt

This contains text to replace the standard "Select Item: " prompt normally given with a menu.

messageStructure messageStructure

The message structure is associated with the message type and event type defined by HL7 v2.3.1 and beyond.

String method method

This number identifies individual methods (actions) that may be invoked for this protocol.

Integer mnemonicWidth mnemonicWidth

This field allows the width allowed for mnemonics to be varied. The default width is 5.

String name name

A unique name, which is preceded by the package namespace.

package package

Pointer to Package File (#9.4).

pathSwitch pathSwitch

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.

String printName printName

This is a shortened version of the item text to be used on print-outs where the name must be abbreviated.

processingId processingId

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.

processingRoutine processingRoutine

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 prohibitedTimes prohibitedTimes

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.

receivingApplication receivingApplication

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.

receivingFacilityRequired? receivingFacilityRequired?

String requiredVariables requiredVariables

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.

requiresSignature requiresSignature

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.

responseMessageType responseMessageType

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.

responseProcessingRoutine responseProcessingRoutine

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.

routingLogic routingLogic

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 HL*1.6*14.

screen screen

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.

securityRequired? securityRequired?

sendingApplication sendingApplication

Enter the name of the application that initiates a transaction. It is required only when defining an EVENT POINT protocol.

sendingFacilityRequired? sendingFacilityRequired?

String setMembership setMembership

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.

subscribers subscribers

String synonym synonym

This is another name for the protocol that may be used on lookup.

String timestamp timestamp

This contains the $H time that fields which are necessary to menu display were last changed.

transactionMessageType transactionMessageType

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.

type type

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.

versionId versionId

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.


Properties:

Alias
businessRule[]
Classifier Behavior
dateAdded10/11/12
dateModified
fileNamePROTOCOL
fileNumber19
highLevelConcept
informationDomain
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsFile 101
modReason
NameProtocol
Name Expression
NamespaceClasses
note
originalName
Owned Template Signature
OwnerClasses
Owning Template Parameter
PackageClasses
packageNameHEALTH LEVEL SEVEN (HL7)
projectID
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
Representation
requestedBy
rootClass
StereotypeVistaClassDictionary, ClassDictionary
synonym
Template Parameter
VisibilityPublic

Attribute Details

 *orderCancelAction
Public  *orderCancelAction

***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.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldName*ORDER CANCEL ACTION
fieldNumber100.1
fileNumber101
formatRule
formatString
generalDescription***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.
helpTextENTER STANDARD MUMPS CODE
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
Name*orderCancelAction
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::*orderCancelAction
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 *orderPrintAction
Public  *orderPrintAction

***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.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldName*ORDER PRINT ACTION
fieldNumber100
fileNumber101
formatRule
formatString
generalDescription***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.
helpTextENTER STANDARD MUMPS CODE
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
Name*orderPrintAction
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::*orderPrintAction
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 *orderPurgeAction
Public  *orderPurgeAction

***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.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldName*ORDER PURGE ACTION
fieldNumber100.2
fileNumber101
formatRule
formatString
generalDescription***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.
helpTextENTER STANDARD MUMPS CODE
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
Name*orderPurgeAction
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::*orderPurgeAction
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 acceptAckCode
Public  acceptAckCode

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.

Constraints:
Properties:

absMaxLength2
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameACCEPT ACK CODE
fieldNumber770.8
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextThis field specifies the method for handling accept acknowledgements to a message.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameacceptAckCode
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameHL7 ACCEPT/APPLICATION ACK CONDITION
pointerFileNumber779.003
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::acceptAckCode
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 access
Public  access

This multiple contains the list of security keys which allow access to the protocol. If there are no keys, all users have access.

Constraints:
Properties:

absMaxLength27
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameACCESS
fieldNumber100.3
fileNumber101
formatRule
formatString
generalDescriptionThis multiple contains the list of security keys which allow access to the protocol. If there are no keys, all users have access.
helpTextEnter a security key to limit access to this protocol.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleTrue
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Nameaccess
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::access
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber101.03
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 ackModeSetInSubscriber
Public  ackModeSetInSubscriber

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameACK MODE SET IN SUBSCRIBER
fieldNumber773.5
fileNumber101
formatRule
formatString
generalDescriptionA '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.
helpTextEnter 'Y' for 'YES' for setting the MSH-15 and MSH-16 from subscriber protocol instead of Event driver protocol.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsEnumeration
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameackModeSetInSubscriber
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsYES;NO
permissableValues1;0
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::ackModeSetInSubscriber
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 applicationAckType
Public  applicationAckType

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

Constraints:
Properties:

absMaxLength2
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameAPPLICATION ACK TYPE
fieldNumber770.9
fileNumber101
formatRule
formatString
generalDescriptionFor 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
helpTextThis field specifies the method for handling application acknowledgements to a message.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameapplicationAckType
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameHL7 ACCEPT/APPLICATION ACK CONDITION
pointerFileNumber779.003
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::applicationAckType
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 batchFileMessageCommitAck
Public  batchFileMessageCommitAck

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameBATCH/FILE MESSAGE COMMIT ACK
fieldNumber770.14
fileNumber101
formatRule
formatString
generalDescriptionIn 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.
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsEnumeration
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamebatchFileMessageCommitAck
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsYES;NO
permissableValues1;0
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::batchFileMessageCommitAck
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 columnWidth
Public Integer columnWidth

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeNUMERIC
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameCOLUMN WIDTH
fieldNumber41
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextType a Number between 25 and 132, 0 Decimal Digits
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamecolumnWidth
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::columnWidth
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 cost
Public Integer cost

This is the cost of filling the order associated with this protocol.

Constraints:
Properties:

absMaxLength10
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeNUMERIC
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameCOST
fieldNumber8
fileNumber101
formatRule
formatString
generalDescriptionThis is the cost of filling the order associated with this protocol.
helpTextType a Dollar Amount between 0 and 9999999, 2 Decimal Digits
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Namecost
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::cost
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 creator
Public «File 200» NewPerson creator

This field identifies who created the protocol.

Constraints:
Properties:

absMaxLength35
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameCREATOR
fieldNumber5
fileNumber101
formatRule
formatString
generalDescriptionThis field identifies who created the protocol.
helpTextEnter the creator of this protocol.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
KeywordsPointer
Lower1
Lower Value(1)
maxLength-
minLength-
modReason
Multiplicity1
Namecreator
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameNEW PERSON
pointerFileNumber200
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::creator
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type«File 200» NewPerson
Upper1
Upper Value(1)
VisibilityPublic


 dateTimeOfMessageRequired?
Public  dateTimeOfMessageRequired?

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDATE/TIME OF MESSAGE REQUIRED?
fieldNumber773.4
fileNumber101
formatRule
formatString
generalDescription-
helpTextEnter 'Y' for 'YES' if the date/time of message field is required in the message header segment.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsEnumeration
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamedateTimeOfMessageRequired?
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsYES;NO
permissableValues1;0
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::dateTimeOfMessageRequired?
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 defaultAnswer
Public String defaultAnswer

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.

Constraints:
Properties:

absMaxLength80
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDEFAULT ANSWER
fieldNumber101.043
fileNumber101
formatRule
formatString
generalDescriptionFor 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.
helpTextAnswer must be 1-80 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength80
minLength1
modReason
Multiplicity0..1
NamedefaultAnswer
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::defaultAnswer
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 defaultHelp
Public String defaultHelp

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.

Constraints:
Properties:

absMaxLength80
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDEFAULT HELP
fieldNumber101.044
fileNumber101
formatRule
formatString
generalDescriptionFor 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.
helpTextAnswer must be 1-80 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength80
minLength1
modReason
Multiplicity0..1
NamedefaultHelp
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::defaultHelp
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 defaultPrompt
Public String defaultPrompt

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.

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDEFAULT PROMPT
fieldNumber101.042
fileNumber101
formatRule
formatString
generalDescriptionFor 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.
helpTextAnswer must be 1-30 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength30
minLength1
modReason
Multiplicity0..1
NamedefaultPrompt
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::defaultPrompt
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 defaultWordProcessingAnswer
Public  defaultWordProcessingAnswer

This is text used as a template for an item in a dialog that is a word processing type.

Constraints:
Properties:

absMaxLength-
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeWORD-PROCESSING
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDEFAULT WORD PROCESSING ANSWER
fieldNumber101.0431
fileNumber101
formatRule
formatString
generalDescriptionThis is text used as a template for an item in a dialog that is a word processing type.
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleTrue
isNullableFalse
isRequiredFalse
KeywordsWORD-PROCESSING
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamedefaultWordProcessingAnswer
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::defaultWordProcessingAnswer
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber101.0431
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 description
Public  description

This field contains a brief explanation of the protocol.

Constraints:
Properties:

absMaxLength-
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeWORD-PROCESSING
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDESCRIPTION
fieldNumber3.5
fileNumber101
formatRule
formatString
generalDescriptionThis field contains a brief explanation of the protocol.
helpTextEnter a description for this protocol
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleTrue
isNullableFalse
isRequiredFalse
KeywordsWORD-PROCESSING
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Namedescription
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::description
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber101.06
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 dicDic
Public String dicDic

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,

Constraints:
Properties:

absMaxLength64
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDIC {DIC}
fieldNumber30
fileNumber101
formatRule
formatString
generalDescriptionThis 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,
helpTextAnswer must be 1-64 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength64
minLength1
modReason
Multiplicity0..1
NamedicDic
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::dicDic
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 disable
Public String disable

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.

Constraints:
Properties:

absMaxLength40
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDISABLE
fieldNumber2
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextEnter text to disable this protocol (1-40 characters).
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength40
minLength1
modReason
Multiplicity0..1
Namedisable
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::disable
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 domainDataType
Public  domainDataType

This is the data type of a term (i.e. protocol of type term) used in a dialog.

Constraints:
Properties:

absMaxLength15
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDOMAIN (DATA TYPE)
fieldNumber101.041
fileNumber101
formatRule
formatString
generalDescriptionThis is the data type of a term (i.e. protocol of type term) used in a dialog.
helpTextEnter the appropriate type for this prompt.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsEnumeration
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamedomainDataType
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsdate/time;free text;list or range;numeric;set of codes;yes/no;pointer;menu;word processing
permissableValuesD;F;L;N;S;Y;P;M;W
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::domainDataType
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 domainParameter
Public String domainParameter

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.

Constraints:
Properties:

absMaxLength56
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDOMAIN PARAMETER
fieldNumber101.045
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextAnswer must be 1-56 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength56
minLength1
modReason
Multiplicity0..1
NamedomainParameter
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::domainParameter
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 entryAction
Public  entryAction

This field contains MUMPS code which will be executed on entering this option. It is applicable to Menu and Action types.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameENTRY ACTION
fieldNumber20
fileNumber101
formatRule
formatString
generalDescriptionThis field contains MUMPS code which will be executed on entering this option. It is applicable to Menu and Action types.
helpTextENTER STANDARD MUMPS CODE
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
NameentryAction
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::entryAction
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 eventType
Public  eventType

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameEVENT TYPE
fieldNumber770.4
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextThe event type associated with the message to be generated.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameeventType
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameHL7 EVENT TYPE CODE
pointerFileNumber779.001
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::eventType
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 exitAction
Public  exitAction

This field contains MUMPS code which will be executed on leaving this option. It is only applicable to Menu types.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameEXIT ACTION
fieldNumber15
fileNumber101
formatRule
formatString
generalDescriptionThis field contains MUMPS code which will be executed on leaving this option. It is only applicable to Menu types.
helpTextENTER STANDARD MUMPS CODE
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
NameexitAction
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::exitAction
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 fileLink
Public  fileLink

This field is a variable pointer which may point to the entry in a file to which a protocol is linked.

Constraints:
Properties:

absMaxLength80
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameFILE LINK
fieldNumber6
fileNumber101
formatRule
formatString
generalDescriptionThis field is a variable pointer which may point to the entry in a file to which a protocol is linked.
helpTextEnter the file, if any, that this protocol is linked to.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamefileLink
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber19^60^62^61^71^62.05^62.07^123.5^123.1
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::fileLink
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 header
Public  header

In the case of menus (type M or Q), this contains MUMPS code that is executed to display a header for the menu.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameHEADER
fieldNumber26
fileNumber101
formatRule
formatString
generalDescriptionIn the case of menus (type M or Q), this contains MUMPS code that is executed to display a header for the menu.
helpTextEnter standard MUMPS code that will used to replace the header on the menu.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
Nameheader
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::header
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 identifier
Public String identifier

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.

Constraints:
Properties:

absMaxLength63
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameIDENTIFIER
fieldNumber44
fileNumber101
formatRule
formatString
generalDescriptionEntries 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.
helpTextAnswer must be 1-63 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength63
minLength1
modReason
Multiplicity0..1
Nameidentifier
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::identifier
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 item
Public  item

This is the item multiple for a protocol

Constraints:
Properties:

absMaxLength63
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameITEM
fieldNumber10
fileNumber101
formatRule
formatString
generalDescriptionThis is the item multiple for a protocol
helpTextEnter items for this protocol.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleTrue
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Nameitem
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::item
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber101.01
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 itemText
Public String itemText

The protocol's text as it appears to the user on the menu or subheader.

Constraints:
Properties:

absMaxLength63
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameITEM TEXT
fieldNumber1
fileNumber101
formatRule
formatString
generalDescriptionThe protocol's text as it appears to the user on the menu or subheader.
helpTextANSWER MUST BE 3-63 CHARACTERS IN LENGTH
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength63
minLength3
modReason
Multiplicity0..1
NameitemText
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::itemText
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 lock
Public String lock

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.

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameLOCK
fieldNumber3
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextEnter the exact name of the key required to access this option.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength30
minLength1
modReason
Multiplicity0..1
Namelock
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::lock
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 logicalLink
Public  logicalLink

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.

Constraints:
Properties:

absMaxLength10
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameLOGICAL LINK
fieldNumber770.7
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextThis field should be left blank for internal DHCP to DHCP communications. Otherwise, this field associates the event protocol with the communication information needed to transmit a message.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamelogicalLink
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameHL LOGICAL LINK
pointerFileNumber870
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::logicalLink
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 menuDefault
Public String menuDefault

This field contains a default response (i.e., default selection from the menu), if desired.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameMENU DEFAULT
fieldNumber29
fileNumber101
formatRule
formatString
generalDescriptionThis field contains a default response (i.e., default selection from the menu), if desired.
helpTextEnter a default for the menu prompt.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength245
minLength1
modReason
Multiplicity0..1
NamemenuDefault
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::menuDefault
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 menuHelp
Public  menuHelp

This contains MUMPS code that displays additional help to that already given with the menu.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameMENU HELP
fieldNumber27
fileNumber101
formatRule
formatString
generalDescriptionThis contains MUMPS code that displays additional help to that already given with the menu.
helpTextEnter standard MUMPS code that will be used to supplement the standard help prompt for this entry.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
NamemenuHelp
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::menuHelp
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 menuPrompt
Public String menuPrompt

This contains text to replace the standard "Select Item: " prompt normally given with a menu.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameMENU PROMPT
fieldNumber28
fileNumber101
formatRule
formatString
generalDescriptionThis contains text to replace the standard "Select Item: " prompt normally given with a menu.
helpTextEnter a replacement prompt for selecting items on this menu.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength245
minLength1
modReason
Multiplicity0..1
NamemenuPrompt
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::menuPrompt
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 messageStructure
Public  messageStructure

The message structure is associated with the message type and event type defined by HL7 v2.3.1 and beyond.

Constraints:
Properties:

absMaxLength10
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameMESSAGE STRUCTURE
fieldNumber770.5
fileNumber101
formatRule
formatString
generalDescriptionThe message structure is associated with the message type and event type defined by HL7 v2.3.1 and beyond.
helpTextEnter the HL7 message structure code.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamemessageStructure
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameHL7 MESSAGE STRUCTURE CODE
pointerFileNumber779.005
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::messageStructure
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 method
Public String method

This number identifies individual methods (actions) that may be invoked for this protocol.

Constraints:
Properties:

absMaxLength2
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameMETHOD
fieldNumber101.05
fileNumber101
formatRule
formatString
generalDescriptionThis number identifies individual methods (actions) that may be invoked for this protocol.
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleTrue
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Namemethod
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::method
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber101.05
synonym
technicalDescriptionMethod numbers correspond to ORACTION numbers.
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 mnemonicWidth
Public Integer mnemonicWidth

This field allows the width allowed for mnemonics to be varied. The default width is 5.

Constraints:
Properties:

absMaxLength1
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeNUMERIC
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameMNEMONIC WIDTH
fieldNumber42
fileNumber101
formatRule
formatString
generalDescriptionThis field allows the width allowed for mnemonics to be varied. The default width is 5.
helpTextType a Number between 1 and 9, 0 Decimal Digits
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamemnemonicWidth
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::mnemonicWidth
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 name
Public String name

A unique name, which is preceded by the package namespace.

Constraints:
Properties:

absMaxLength63
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameNAME
fieldNumber.01
fileNumber101
formatRule
formatString
generalDescriptionA unique name, which is preceded by the package namespace.
helpTextEnter a name that is preceded by the package namespace.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Namename
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::name
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 package
Public  package

Pointer to Package File (#9.4).

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNamePACKAGE
fieldNumber12
fileNumber101
formatRule
formatString
generalDescriptionPointer to Package File (#9.4).
helpTextEnter the package for this protocol.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Namepackage
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNamePACKAGE
pointerFileNumber9.4
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::package
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 pathSwitch
Public  pathSwitch

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNamePATH SWITCH
fieldNumber43
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextEnter Y for YES, N for NO, ?? for detailed description.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsEnumeration
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamepathSwitch
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsYES;NO
permissableValuesY;N
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::pathSwitch
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 printName
Public String printName

This is a shortened version of the item text to be used on print-outs where the name must be abbreviated.

Constraints:
Properties:

absMaxLength7
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNamePRINT NAME
fieldNumber1.11
fileNumber101
formatRule
formatString
generalDescriptionThis is a shortened version of the item text to be used on print-outs where the name must be abbreviated.
helpTextAnswer must be 1-7 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength7
minLength1
modReason
Multiplicity0..1
NameprintName
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::printName
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 processingId
Public  processingId

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.

Constraints:
Properties:

absMaxLength5
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNamePROCESSING ID
fieldNumber770.6
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextSet this only for DEBUG MODE. Use HL7 site params for Test or Production
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsEnumeration
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameprocessingId
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsdebug
permissableValuesD
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::processingId
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 processingRoutine
Public  processingRoutine

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.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNamePROCESSING ROUTINE
fieldNumber771
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpText This is Standard MUMPS code.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
NameprocessingRoutine
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::processingRoutine
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 prohibitedTimes
Public String prohibitedTimes

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.

Constraints:
Properties:

absMaxLength9
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNamePROHIBITED TIMES
fieldNumber3.9
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextEnter the times in military format that this protocol cannot be used.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength9
minLength9
modReason
Multiplicity0..1
NameprohibitedTimes
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::prohibitedTimes
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 receivingApplication
Public  receivingApplication

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.

Constraints:
Properties:

absMaxLength120
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameRECEIVING APPLICATION
fieldNumber770.2
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextThe application that will receive the message.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamereceivingApplication
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameHL7 APPLICATION PARAMETER
pointerFileNumber771
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::receivingApplication
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 receivingFacilityRequired?
Public  receivingFacilityRequired?

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameRECEIVING FACILITY REQUIRED?
fieldNumber773.2
fileNumber101
formatRule
formatString
generalDescription-
helpTextEnter 'Y' for 'YES' if the receiving facility field is required in the message header segment.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsEnumeration
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamereceivingFacilityRequired?
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsYES;NO
permissableValues1;0
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::receivingFacilityRequired?
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 requiredVariables
Public String requiredVariables

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.

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameREQUIRED VARIABLES
fieldNumber21
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextEnter the required variables for this protocol.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleTrue
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamerequiredVariables
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::requiredVariables
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber101.021
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 requiresSignature
Public  requiresSignature

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.

Constraints:
Properties:

absMaxLength21
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameREQUIRES SIGNATURE
fieldNumber101.01
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextEnter a '1' if this protocol does not require a physician signature.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsEnumeration
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamerequiresSignature
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsPHYSICIAN SIGNATURE;NO SIGNATURE REQUIRED
permissableValues0;1
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::requiresSignature
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 responseMessageType
Public  responseMessageType

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameRESPONSE MESSAGE TYPE
fieldNumber770.11
fileNumber101
formatRule
formatString
generalDescriptionEnter 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.
helpTextEnter the message type of the expected response.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameresponseMessageType
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameHL7 MESSAGE TYPE
pointerFileNumber771.2
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::responseMessageType
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 responseProcessingRoutine
Public  responseProcessingRoutine

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.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameRESPONSE PROCESSING ROUTINE
fieldNumber772
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextCode that executes the routine to generate an acknowledgement message (for a subscriber application) or to process an acknowledgement message (for a server application). This is Standard MUMPS code.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
NameresponseProcessingRoutine
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::responseProcessingRoutine
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 routingLogic
Public  routingLogic

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 HL*1.6*14.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameROUTING LOGIC
fieldNumber774
fileNumber101
formatRule
formatString
generalDescriptionM 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 HL*1.6*14.
helpTextThis is Standard MUMPS code.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
NameroutingLogic
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::routingLogic
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 screen
Public  screen

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.

Constraints:
Properties:

absMaxLength245
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeMUMPS
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSCREEN
fieldNumber24
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextThis is standard MUMPS code to screen an item from processing.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsMUMPS
Lower0
Lower Value(0)
maxLength245
minLength0
modReason
Multiplicity0..1
Namescreen
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::screen
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 securityRequired?
Public  securityRequired?

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSECURITY REQUIRED?
fieldNumber773.3
fileNumber101
formatRule
formatString
generalDescription-
helpTextEnter 'Y' for 'YES' if the security field is required in the message header segment.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsEnumeration
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamesecurityRequired?
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsYES;NO
permissableValues1;0
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::securityRequired?
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 sendingApplication
Public  sendingApplication

Enter the name of the application that initiates a transaction. It is required only when defining an EVENT POINT protocol.

Constraints:
Properties:

absMaxLength120
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSENDING APPLICATION
fieldNumber770.1
fileNumber101
formatRule
formatString
generalDescriptionEnter the name of the application that initiates a transaction. It is required only when defining an EVENT POINT protocol.
helpTextEnter the application that initiates the transaction.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamesendingApplication
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameHL7 APPLICATION PARAMETER
pointerFileNumber771
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::sendingApplication
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 sendingFacilityRequired?
Public  sendingFacilityRequired?

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSENDING FACILITY REQUIRED?
fieldNumber773.1
fileNumber101
formatRule
formatString
generalDescription-
helpTextEnter 'Y' for 'YES' if the sending facility field is required in the message header segment.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsEnumeration
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamesendingFacilityRequired?
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsYES;NO
permissableValues1;0
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::sendingFacilityRequired?
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 setMembership
Public String setMembership

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.

Constraints:
Properties:

absMaxLength8
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSET MEMBERSHIP
fieldNumber101.07
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleTrue
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamesetMembership
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::setMembership
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber101.07
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 subscribers
Public  subscribers

Constraints:
Properties:

absMaxLength63
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSUBSCRIBERS
fieldNumber775
fileNumber101
formatRule
formatString
generalDescription-
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleTrue
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Namesubscribers
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::subscribers
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber101.0775
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 synonym
Public String synonym

This is another name for the protocol that may be used on lookup.

Constraints:
Properties:

absMaxLength65
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSYNONYM
fieldNumber1.1
fileNumber101
formatRule
formatString
generalDescriptionThis is another name for the protocol that may be used on lookup.
helpTextEnter a synonym for this protocol
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleTrue
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Namesynonym
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::synonym
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber101.02
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 timestamp
Public String timestamp

This contains the $H time that fields which are necessary to menu display were last changed.

Constraints:
Properties:

absMaxLength15
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeFREE TEXT
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameTIMESTAMP
fieldNumber99
fileNumber101
formatRule
formatString
generalDescriptionThis contains the $H time that fields which are necessary to menu display were last changed.
helpTextANSWER MUST BE 1-15 CHARACTERS IN LENGTH
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength15
minLength1
modReason
Multiplicity0..1
Nametimestamp
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::timestamp
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 transactionMessageType
Public  transactionMessageType

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameTRANSACTION MESSAGE TYPE
fieldNumber770.3
fileNumber101
formatRule
formatString
generalDescriptionEnter 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.
helpTextEnter the HL7 MESSAGE TYPE that is sent by the initiating system.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NametransactionMessageType
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameHL7 MESSAGE TYPE
pointerFileNumber771.2
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::transactionMessageType
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 type
Public  type

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.

Constraints:
Properties:

absMaxLength16
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypeSET
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameTYPE
fieldNumber4
fileNumber101
formatRule
formatString
generalDescriptionThis 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.
helpTextSpecify a type for this protocol.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
KeywordsEnumeration
Lower1
Lower Value(1)
maxLength-
minLength-
modReason
Multiplicity1
Nametype
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeaningsaction;menu;protocol;protocol menu;limited protocol;extended action;dialog;term;event driver;subscriber
permissableValuesA;M;O;Q;L;X;D;T;E;S
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::type
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 versionId
Public  versionId

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.

Constraints:
Properties:

absMaxLength8
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 101» Protocol
dataTypePOINTER
Datatype
dateAdded10/11/12
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameVERSION ID
fieldNumber770.95
fileNumber101
formatRule
formatString
generalDescriptionEnter 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.
helpTextEnter the version of the HL7 Standard used to implement this transaction
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
KeywordsPointer
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameversionId
Name Expression
Namespace«File 101» Protocol
note
Opposite
originalClass
originalName
Owner«File 101» Protocol
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameHL7 VERSION
pointerFileNumber771.5
Qualified NameHybrid::HealthLevelSeven::Classes::Protocol::versionId
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeVistaAttributeDictionary, AttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic