Skip to main content


class HS.Util.HL7Client.Operations extends EnsLib.HL7.Operation.TCPOperation, HS.IHE.Common.Actor.Base

Class used to create and/or send PDQv2 Query message to PDQv2 Supplier

Property Inventory

Method Inventory


parameter ADAPTER = HS.Util.TCPClient.TCPHL7OutboundAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter FOUNDATION = 1;
parameter SETTINGS = ServiceName:Basic:selector?Select=1&context={HS.Util.ContextSearch/ServiceNameItemsByParam?Type=TCP},SendingApplication,SendingFacility;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property RegistryService as %String;
Caches Service Registry information for the currently selected service. Format is: $lb(Service Name, Service %Id, Device OID, Assigning Authority, Receiving Application, Receiving Facility, Host, Port, StayConnected, SSLConfig)
Property methods: RegistryServiceDisplayToLogical(), RegistryServiceGet(), RegistryServiceIsValid(), RegistryServiceLogicalToDisplay(), RegistryServiceLogicalToOdbc(), RegistryServiceNormalize(), RegistryServiceSet()
property SendingApplication as %String (MAXLEN = 256);
Used as the sending application for MSH:3 - does not need to be an IdentityCode from the HS.Data.OIDMap table
Property methods: SendingApplicationDisplayToLogical(), SendingApplicationGet(), SendingApplicationIsValid(), SendingApplicationLogicalToDisplay(), SendingApplicationLogicalToOdbc(), SendingApplicationNormalize(), SendingApplicationSet()
property SendingFacility as %String;
Used as the sender facility code - IdentityCode from the HS.Data.OIDMap table
Property methods: SendingFacilityDisplayToLogical(), SendingFacilityGet(), SendingFacilityIsValid(), SendingFacilityLogicalToDisplay(), SendingFacilityLogicalToOdbc(), SendingFacilityNormalize(), SendingFacilitySet()
property SendingFacilityOID as %String (MAXLEN = 64);
Converted sender facility code to OID
Property methods: SendingFacilityOIDDisplayToLogical(), SendingFacilityOIDGet(), SendingFacilityOIDIsValid(), SendingFacilityOIDLogicalToDisplay(), SendingFacilityOIDLogicalToOdbc(), SendingFacilityOIDNormalize(), SendingFacilityOIDSet()
property ServiceName as %String (MAXLEN = 512);
The service name found in HS.Registry.Service.*
Property methods: ServiceNameDisplayToLogical(), ServiceNameGet(), ServiceNameIsValid(), ServiceNameLogicalToDisplay(), ServiceNameLogicalToOdbc(), ServiceNameNormalize(), ServiceNameSet()


method OnGetReplyAction(pRequest As EnsLib.HL7.Message, Output pResponse As EnsLib.HL7.Message, ByRef pSC As %Status) as %String
OnGetReplyAction is overridden here because the reply actions are being handled later in the PIXv2/PDQv2 code, and because at this point pRequest is already converted to PatientSearchResponse by the PDQv2 code.
method OnInit() as %Status
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnMessage(pRequest As EnsLib.HL7.Message, Output pResponse As EnsLib.HL7.Message) as %Status
Inherited description: This is the default message handler. All request types not declared in the message map are delivered here
method SetService(pRequest As EnsLib.HL7.Message, ByRef pResponse As EnsLib.HL7.Message) as %Status
method UpdateRegistryService(pService)
UpdateRegistryService updates - if needed - the info in the RegistryService property. Update is based on pService, the ServiceName setting, and the info currently in RegistryService. The ServiceName setting is the default service name to use, and may be overridden by pRequest.AdditionalInfo.GetAt("ServiceName"). If RegistryService is updated, then the properties on this BO's TCP adapter are also updated. If Service Registry settings on a TCP service are changed, then this BO should be restarted to guarantee that the changes are effective at run time.

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab