cdac.medinfo.sdk.hl7282.hl7model.messages.observationreporting

Class ORA_R41

java.lang.Object

cdac.medinfo.sdk.hl7282.baselibs.messages.Message

cdac.medinfo.sdk.hl7282.hl7model.messages.observationreporting.ORA_R41

public final class ORA_R41
extends Message

ORA_R41 - Observation Report Alert Acknowledgement (Event R41). This message enables application level acknowledgements in response to the ORU^R40 alert observation message.

Represents a ORA_R41 message structure (see chapter 7.3.13). This structure contains the following elements:

0: MSH (Message Header Segment) SINGLE_COMPULSARY
1: SFT (Software Segment) MULTIPLE_OPTIONAL
2: UAC (User Authentication Credential) SINGLE OPTIONAL
3: MSA (Message Acknowledgment) SINGLE COMPULSARY
4: ERR (ERROR) MULTIPLE OPTIONAL
5: PRT (Participation-Acknowledging User) MULTIPLE OPTIONAL
This class provides mechanism to validate message against HL7 v 2.8.2 standard. The class provides accessors & mutators for the elements mentioned above. These elements can be easily populated & populated values can be easily retrieved. The class has validate method which validates Message against HL7 v 2.8.2 standard.

Constructor Summary

Constructors

Constructor and Description
ORA_R41(IMap objMessageMap) Constructs the ORA_R41 message.

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorSegment(ERR objERR) Adds Error(ERR) segment to this message.
void	addErrorSegment(ISingleCollection<ERR> objERRSegmentCollection) Adds collection of Error(ERR) segment to this message.
void	addParticipationAcknowledgingUserSegment(ISingleCollection<PRT> objPRTSegmentCollection) Adds collection of Participation(PRT) to this message.
void	addParticipationAcknowledgingUserSegment(PRT objPRT) Adds Participation(PRT) to this message.
void	addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection) Adds collection of Software Segment(SFT) to this message.
void	addSoftwareSegment(SFT objSFT) Adds Software Segment(SFT) to this message.
MSA	getMessageAcknowledgmentSegment() Retrieves Message Acknowledgment(MSA) segment present in this message.
ISingleCollection<PRT>	getParticipationAcknowledgingUserSegments() Retrieves Collection of Participation(PRT) present in this message.
ISingleCollection<ERR>	getSegments() Retrieves Collection of Error(ERR) segment present in this message.
ISingleCollection<SFT>	getSoftwareSegments() Retrieves Collection of Software Segments(SFT) present in this message.
UAC	getUserAuthenticationCredentialSegment() Retrieves User Authentication Credential(UAC) segment present in this message
void	setMessageAcknowledgmentSegment(MSA objMSA) Sets value of MSA segment for this message,overwrites if already present.
void	setUserAuthenticationCredentialSegment(UAC objUAC) Sets value of User Authentication Credential segment for this message,overwrites if already present.

Methods inherited from class cdac.medinfo.sdk.hl7282.baselibs.messages.Message

contains, dumpMessage, dumpMessage, getACKMode, getGroup, getGroupMap, getHeader, getMessageCode, getMessageControlID, getMessageStructure, getQueryUserParameters, getSegment, getSegmentSet, getSubscriptionType, getTriggerEvent, isQuery, isResponse, populate, removeGroup, removeSegment, removeSegment, removeSegmentAttribute, removeSegmentAttribute, removeSegmentAttribute, removeSegments, setHeader, setSubscriptionType, updateSegmentAttribute, updateSegmentAttribute, validate, writeToXML, writeToXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ORA_R41

public ORA_R41(IMap objMessageMap)

Constructs the ORA_R41 message.

Method Detail

getSoftwareSegments

public ISingleCollection<SFT> getSoftwareSegments()

Retrieves Collection of Software Segments(SFT) present in this message.

Returns:

ISingleCollection - Collection of Software Segments(SFT) present in this message.

addSoftwareSegment

public void addSoftwareSegment(SFT objSFT)

Adds Software Segment(SFT) to this message.

Parameters:

objSFT - Specified Software Segment(SFT) to be added in this messageto this message.

addSoftwareSegment

public void addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection)

Adds collection of Software Segment(SFT) to this message.

Parameters:

objSFTSegmentCollection - Collection of Software Segments to add in this message

getUserAuthenticationCredentialSegment

public UAC getUserAuthenticationCredentialSegment()

Retrieves User Authentication Credential(UAC) segment present in this message

Returns:

UAC - Specified UAC Segment

setUserAuthenticationCredentialSegment

public void setUserAuthenticationCredentialSegment(UAC objUAC)

Sets value of User Authentication Credential segment for this message,overwrites if already present.

Parameters:

objUAC - Specified UAC Segment

getMessageAcknowledgmentSegment

public MSA getMessageAcknowledgmentSegment()

Retrieves Message Acknowledgment(MSA) segment present in this message.

Returns:

MSA - the Message Acknowledgment Segment present in this message or null if unavailable.

setMessageAcknowledgmentSegment

public void setMessageAcknowledgmentSegment(MSA objMSA)

Sets value of MSA segment for this message,overwrites if already present.

Parameters:

objMSA - Specified MSA Segment

getSegments

public ISingleCollection<ERR> getSegments()

Retrieves Collection of Error(ERR) segment present in this message.

Returns:

ISingleCollection - Collection of Error(ERR) segment present in this message.

addErrorSegment

public void addErrorSegment(ERR objERR)

Adds Error(ERR) segment to this message.

Parameters:

objERr - Specified Error(ERR) segment to be added in this messageto this message.

addErrorSegment

public void addErrorSegment(ISingleCollection<ERR> objERRSegmentCollection)

Adds collection of Error(ERR) segment to this message.

Parameters:

objERRSegmentCollection - Collection of Error segment to add in this message

addParticipationAcknowledgingUserSegment

public void addParticipationAcknowledgingUserSegment(PRT objPRT)

Adds Participation(PRT) to this message.

Parameters:

objPRT - Specified Participation Segment to be added in message.

addParticipationAcknowledgingUserSegment

public void addParticipationAcknowledgingUserSegment(ISingleCollection<PRT> objPRTSegmentCollection)

Adds collection of Participation(PRT) to this message.

Parameters:

objPRTSegmentCollection - Collection of Participation(PRT) to add in this message

getParticipationAcknowledgingUserSegments

public ISingleCollection<PRT> getParticipationAcknowledgingUserSegments()

Retrieves Collection of Participation(PRT) present in this message.

Returns:

ISingleCollection - Collection of Participation(PRT) present in this message.