oracle.hsgbu.hdr.message.improcessor.hl7.configuration.interaction

Interface SenderConfiguration

All Superinterfaces:

Serializable

public interface SenderConfiguration
extends Serializable

SenderConfiguration interface contains the Sender and Receiver Organization information for a particular Message Type. A SenderConfiguration is uniquely identified by Sender Id and Receiver Id combination. The SenderConfiguration details are extracted from Message. The Receiver Information should be already configured in HDR. A SenderConfiguration can contain zero or more SenderInteractionConfiguration(s). A SenderConfiguration object contains the following detail:

• Sender Id Root - Root part of the ID of the sending device.
• Receiver Id Root - Root part of the ID of a valid Organization registered in the system.
• Sender Id Extension - Extension part of the ID of the sending device.
• Receiver Id Root - Root part of the ID of a valid Organization registered in the system.
• Receiver Id Extension - Extension part of the ID of a valid Receiver registered in the system.
• SenderInteractionConfiguration[] - An array of SenderInteractionConfiguration, associated with this SenderConfiguration.

For creating sender and receiver configuration Organization's external II should be used.Internal II's that are auto-generated in HDR should not be used
When Creating a SenderConfiguration the following validation rules are applied:
Validation Rules:

• SenderConfiguration should not be null or empty.
• The Sender Id and Receiver Id should be complaint to ISO 8824 format. That is, Sender Id and Receiver Id should be a globally unique string representing an identifier, in a form that consists only of numbers and dots (e.g., SenderId = "2.16.840.1.113883.3.1" and Receiver ID="99.123.888.999.1322").
• A SenderConfiguration should not contain null SenderInteractionConfiguration
• A SenderConfiguration should not contain duplicate SenderInteractionConfiguration(s).
• A SenderInteractionConfiguration should not contain duplicate SenderSideEffectConfiguration(s).
• A SenderSideEffectConfiguration should not contain null MasterCatalog Ids. MasterCatalog Id details should be already present in the database.

The following code snippet is an example for populating SenderConfiguration object.


private SenderConfiguration createSenderConfiguration()
{
//Sender and Receiver detail
String senderRoot = "9.99.999.9999.149.99976";
String senderExtn = "TEST-011";
String recvRoot = "9.989898.5";
String recvExtn = "2803";
String interactionId = "PORR_IN040001";
String mcIds[] = {"1780", "1781"}; // This list of MasterCatalog ids should already exist.

//creating the SenderSideEffectConfiguration
SenderSideEffectConfiguration sideEffectConfig[] = createSideEffectConfig();
//creating SenderInteractionConfiguration
SenderInteractionConfiguration senderInteractionConfiguration = new SenderInteractionConfigurationImpl();
senderInteractionConfiguration.setInteractionId(interactionId); //setting interaction id
senderInteractionConfiguration.setSenderSideEffectConfiguration(sideEffectConfig); //associating the SenderSideEffectConfiguration with SenderInteractionConfiguration
//Creating SenderConfiguration
SenderConfiguration senderConfiguration = new SenderConfigurationImpl();
senderConfiguration.setSenderIdRoot(senderRoot); //setting Sender Id
senderConfiguration.setSenderIdExtension(senderExtn); //setting Sender Id Extension
senderConfiguration.setReceiverIdRoot(recvRoot); // setting Receiver Id
senderConfiguration.setReceiverIdExtension(recvExtn);// setting Receiver Id Extension
//associating SenderInteractionConfiguration with SenderConfiguration
senderConfiguration.setSenderInteractionConfigurations(new SenderInteractionConfiguration[] {senderInteractionConfiguration });
impConfigAdminIntrService.createSenderConfiguration(senderConfiguration);
}

//creating SenderSideEffectConfiguration
private SenderSideEffectConfiguration[] createSideEffectConfig()
{
SenderSideEffectConfiguration [] senderSideEffectConfigs = new SenderSideEffectConfiguration[mcIds.length];

for (int i = 0; i < mcIds.length; i++)
{
senderSideEffectConfigs[i] = new SenderSideEffectConfigurationImpl();
senderSideEffectConfigs[i].setObjectRefModifierCode(SenderSideEffectConfiguration.CREATE_OR_OVERLAY);
senderSideEffectConfigs[i].setPlayerRefModifierCode(SenderSideEffectConfiguration.CREATE_OR_OVERLAY);
senderSideEffectConfigs[i].setScoperRefModifierCode(SenderSideEffectConfiguration.CREATE_OR_OVERLAY);
senderSideEffectConfigs[i].setMasterCatalogId(mcIds[i]);
}
return senderSideEffectConfigs;
}


Method Summary

Modifier and Type	Method and Description
String	getReceiverIdExtension() Returns the Receiver Id Extension.
String	getReceiverIdRoot() Returns the Receiver Id.
String	getSenderConfigId() Returns the SenderConfiguration Id.
String	getSenderIdExtension() Returns the Sender Id Extension.
String	getSenderIdRoot() Returns the Sender Id.
SenderInteractionConfiguration[]	getSenderInteractionConfigurations() Returns an array of SenderInteractionConfiguration associated with this SenderConfiguration.
void	setReceiverIdExtension(String receiverIdExtension) Sets the Receiver Id Extension for this SenderConfiguration.
void	setReceiverIdRoot(String receiverIdRoot) Sets the Receiver Id for this SenderConfiguration.
void	setSenderIdExtension(String senderIdExtension) Sets the Sender Id Extension for this SenderConfiguration.
void	setSenderIdRoot(String senderIdRoot) Sets the Sender Id for this SenderConfiguration.
void	setSenderInteractionConfigurations(SenderInteractionConfiguration[] senderInteractionConfigurations) Sets an array of SenderInteractionConfiguration associated with this SenderConfiguration.

Method Detail

getSenderConfigId

String getSenderConfigId()

Returns the SenderConfiguration Id. This is an unique identifier for a SenderConfiguration, and it is autogenerated when creating the SenderConfiguration in the database. This value can not be set by the user.

getSenderIdRoot

String getSenderIdRoot()

Returns the Sender Id.

Returns:

Sender Id for this SenderConfiguration.

getSenderIdExtension

String getSenderIdExtension()

Returns the Sender Id Extension.

Returns:

Sender Id Extension for this SenderConfiguration.

getReceiverIdRoot

String getReceiverIdRoot()

Returns the Receiver Id.

Returns:

Receiver Id for this SenderConfiguration.

getReceiverIdExtension

String getReceiverIdExtension()

Returns the Receiver Id Extension.

Returns:

Receiver Id Extension for this SenderConfiguration.

setSenderIdRoot

void setSenderIdRoot(String senderIdRoot)

Sets the Sender Id for this SenderConfiguration.

Parameters:

senderIdRoot - Sender Id for this SenderConfiguration.

setReceiverIdExtension

void setReceiverIdExtension(String receiverIdExtension)

Sets the Receiver Id Extension for this SenderConfiguration.

Parameters:

receiverIdExtension - Receiver Id for this SenderConfiguration.

setReceiverIdRoot

void setReceiverIdRoot(String receiverIdRoot)

Sets the Receiver Id for this SenderConfiguration.

Parameters:

receiverIdRoot - Receiver Id for this SenderConfiguration.

setSenderIdExtension

void setSenderIdExtension(String senderIdExtension)

Sets the Sender Id Extension for this SenderConfiguration.

Parameters:

senderIdExtension - Sender Id Extension for this SenderConfiguration.

getSenderInteractionConfigurations

SenderInteractionConfiguration[] getSenderInteractionConfigurations()

Returns an array of SenderInteractionConfiguration associated with this SenderConfiguration.

Returns:

Array of SenderInteractionConfiguration.

setSenderInteractionConfigurations

void setSenderInteractionConfigurations(SenderInteractionConfiguration[] senderInteractionConfigurations)

Sets an array of SenderInteractionConfiguration associated with this SenderConfiguration.

Parameters:

senderInteractionConfigurations - An array of SenderInteractionConfiguration associated with this SenderConfiguration.