Skip to main content

HS.IHE.XCA.RespondingGateway.Services

class HS.IHE.XCA.RespondingGateway.Services extends HS.IHE.Common.Services.SOAPServer.Base, HS.IHE.Common.Actor.Base

The typical XCA responding gateway accepts requests for a community and dispenses that request to the local registry (if defined)
and also sends requests to other communities.

The non-typical approach has the XCA Responding Gateway accept the request and based on the patient assigning authority, send the
request out to the home community for that patient. This configuration is often referred to as "The Big Bus"
For this type of configuration to work there need to be service registry entries with DeviceFunction = XCA.Query where the AssigningAuthority =
the coded value for the assigning authority oid.

A non-standard use of the responding gateway is to pass in a parameter in the url /?sendingCommunityId=home.community.oid which will use cached patients (when defined in XCPD & responding gateway process)

Property Inventory

Method Inventory

Parameters

parameter NAMESPACE = urn:ihe:iti:xds-b:2007;
This is the namespace used by the Service
parameter OUTPUTTYPEATTRIBUTE = 1;
Use xsi:type attribute for literal types.
parameter SERVICENAME = RespondingGateway_Service;
This is the name of the Service
parameter SETTINGS = XCAQueryTarget,XCARetrieveTarget;
Inherited description: Can't do grace period without an OnTask loop

Properties

property XCAQueryTarget as Ens.DataType.ConfigName;
Property methods: XCAQueryTargetDisplayToLogical(), XCAQueryTargetGet(), XCAQueryTargetIsValid(), XCAQueryTargetLogicalToDisplay(), XCAQueryTargetLogicalToOdbc(), XCAQueryTargetNormalize(), XCAQueryTargetParseConfigNameSpec(), XCAQueryTargetSet()
property XCARetrieveTarget as Ens.DataType.ConfigName;
Property methods: XCARetrieveTargetDisplayToLogical(), XCARetrieveTargetGet(), XCARetrieveTargetIsValid(), XCARetrieveTargetLogicalToDisplay(), XCARetrieveTargetLogicalToOdbc(), XCARetrieveTargetNormalize(), XCARetrieveTargetParseConfigNameSpec(), XCARetrieveTargetSet()

Methods

method OnProcessInput(pRequest As HS.Message.XMLMessage, Output pResponse As HS.Message.XMLMessage = $$$NULLOREF, ByRef pHint As %Library.String) as %Status
Inherited description: Override this method to process incoming data. Do not call SendRequestSync/Async() from outside this method (e.g. in a SOAP Service or a CSP page).
method Query(pRequest As HS.Message.XMLMessage, Output pResponse As HS.Message.XMLMessage) as %Status [ WebMethod ]
Cross Gateway Query [ITI-38]
method QueryAsync(pRequest As HS.Message.XMLMessage, Output pResponse As HS.Message.XMLMessage) as %Status [ WebMethod ]
Cross Gateway Query [ITI-38]
method Retrieve(pRequest As HS.Message.XMLMessage, Output pResponse As HS.Message.XMLMessage) as %Status [ WebMethod ]
Cross Gateway Retrieve [ITI-39]
method RetrieveAsync(pRequest As HS.Message.XMLMessage, Output pResponse As HS.Message.XMLMessage) as %Status [ WebMethod ]
Cross Gateway Retrieve [ITI-39]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab