oracle.hsgbu.hdr.message.submissionunit

Interface SubmissionUnit

All Superinterfaces:

Serializable

All Known Implementing Classes:

SubmissionUnitImpl

public interface SubmissionUnit
extends Serializable

Defines a structure that contains the messages processed by Outbound Message Processor or the messages received and processed by Inbound Message Processor.

Summary

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLINICAL_ACT Value of FocalActName attribute when Outbound Message Processor processes a clinical act.
static String	CONTROL_ACT Value of FocalActName attribute when Outbound Message Processor is processing a control act.
static String	ENCOUNTER Value of the FocalActName attribute when Outbound Message Processor processes an encounter act.
static String	ENCOUNTER_APPOINTMENT Value of FocalActName attribute when Outbound Message Processor processes an encounter appointment act.
static String	FOCAL_ACT Value of FocalActName attribute when Outbound Message Processor is processing an act, other than clinical, encounter, encounter appointment, or person merge.
static String	FOCAL_ENTITY Value of FocalActName attribute when Outbound Message Processor is processing an entity other than an act.
static String	FOCAL_ROLE Value of FocalActName attribute when Outbound Message Processor is processing an encounter act.
static String	IMP_APP_NAME Value of SubmittedByAppName attribute when Inbound Message Processor submits the SubmissionUnit.
static String	OMP_APP_NAME Value of SubmittedByAppName attribute when Outbound Message Processor submits the SubmissionUnit.
static String	PERSON_MERGE Value of FocalActName attribute attribute when Outbound Message Processor processes a person merge.

Method Summary

Modifier and Type	Method and Description
Date	getAckDate() Gets the date and time when the acknowledgement message was sent.
String	getAckMessageText() Gets the acknowledgement message text.
String	getAckRequestCode() Gets the acknowledgement request code.
String	getAckTypeCode() Gets the acknowledgement code as described in the HL7 message processing rules.
String	getControlActAuthorId() Deprecated. Use getControlActAuthorII().
II	getControlActAuthorII() Gets the identifier of the author who is responsible of the ControlAct and who "owns" the act.
String	getControlActAuthorName() Gets the name of the author who is responsible of the ControlAct and who "owns" the act.
II	getControlActII() Gets the ControlAct identifier.
String	getFocalActId() Deprecated. Use getFocalActII().
II	getFocalActII() Gets the identifier of the focal act, which is the focus of the ControlAct, and may be a ClinicalAct, Encounter, EncounterAppointment, or PersonMergeRequest.
String	getFocalActName() Gets the name of the focal act.
String	getFocalActVersionNum() Gets the version number of the focal act.
String	getMessageId() Deprecated. Use getMessageII().
II	getMessageII() Gets the identifier of the HL7 message.
String	getMessageReferenceText() Deprecated. No replacement.
String	getMessageSeqNum() Gets the message sequence number.
String	getOriginalMessageText() Gets the original HDR-compliant HL7 version 3.0 message text.
String	getPersonId() Deprecated. Use getPersonII().
II	getPersonII() Gets the person identifier.
String	getProcessingEnvCode() Gets the processing environment code.
String	getProcessingModeCode() Gets the processing mode code.
String	getReceivedNum() Gets the received number, which is a counter that indicates the number of times
II	getReceiverII() Gets the receiver identifier.
Boolean	getResendFlag() Gets the flag that indicates whether the message should be resent.
II	getRespondToII() Gets the identifier of the entity to which a response for this message has be sent.
String	getRespondToOID() Deprecated. Use getRespondToII().
Date	getSendDate() Gets the date and time when the message was sent.
II	getSenderII() Gets the sender identifier.
String	getSenderOid() Deprecated. Use getSenderII().
Boolean	getSkipFlag() Gets the flag that indicates if the message identifier associated with this SubmissionUnit must be skipped.
Date	getSubmissionDate() Gets the date the SubmissionUnit was persisted.
String	getSubmissionUnitId() Gets the identifier that uniquely identifies this SubmissionUnit.
String	getSubmittedByAppName() Gets the name of the application that submitted this SubmissionUnit.
String	getTriggerEventCode() Gets the trigger event code.
void	setAckDate(Date ackTimeSent) Sets the date and time when the acknowledgement message was sent.
void	setAckMessageText(String ackMessageText) Sets the acknowledgement message text.
void	setAckRequestCode(String ackRequestCode) Sets the acknowledgement request code.
void	setAckTypeCode(String ackTypeCode) Sets the acknowledgement code as described in the HL7 message processing rules.
void	setControlActAuthorId(String root) Deprecated. Use setControlActAuthorII(II).
void	setControlActAuthorII(II authorId) Sets the identifier of the author who is responsible of the ControlAct and who "owns" the act.
void	setControlActAuthorName(String controlActAuthorName) Sets the name of the author who is responsible of the ControlAct and who "owns" the act.
void	setControlActII(II controlActId) Sets the ControlAct identifier.
void	setFocalActId(String actId) Deprecated. Use setFocalActII(II).
void	setFocalActII(II actId) Sets the identifier of the focal act, which is the focus of the ControlAct, and may be a ClinicalAct, Encounter, EncounterAppointment, or PersonMergeRequest.
void	setFocalActName(String act) Sets the focal act name, which indicates the specific type of focal act.
void	setFocalActVersionNum(String versionNum) Sets the version number of the focal act.
void	setMessageId(String messageRootId) Deprecated. Use setMessageII(II).
void	setMessageII(II messageId) Sets the identifier of the HL7 message.
void	setMessageReferenceText(String messageReferenceText) Deprecated. No replacement.
void	setMessageSeqNum(String messageSeqNum) Sets the message sequence number.
void	setOriginalMessageText(String originalMessageText) Sets the original HDR-compliant HL7 version 3.0 message text.
void	setPersonId(String personId) Deprecated. Use setPersonII(II).
void	setPersonII(II personId) Sets the person identifier.
void	setProcessingEnvCode(String processingEnvCode) Sets the processing environment code.
void	setProcessingModeCode(String processingModeCode) Sets the processing mode code.
void	setReceivedNum(String receivedNum) Sets the received number, which is a counter that indicates the number of times Inbound Message Processor received a message with the same identifier, and for the same receiver.
void	setReceiverII(II receiverId) Sets the receiver identifier.
void	setResendFlag(Boolean resendFlag) Sets the flag that indicates whether the message should be resent.
void	setRespondToII(II identifier) Sets the identifier of the entity to which a response for this message has to be sent.
void	setRespondToOID(String root) Deprecated. Use setRespondToII(II).
void	setSendDate(Date timeSent) Sets the date and time when the message was sent to the receiver.
void	setSenderII(II senderId) Sets the sender identifier.
void	setSenderOid(String senderOID) Deprecated. Use setSenderII(II).
void	setSkipFlag(Boolean skipFlag) Sets the flag that indicates if the message identifier associated with this SubmissionUnit should be skipped.
void	setSubmissionDate(Date submissionDate) Sets the date when the SubmissionUnit was persisted.
void	setSubmissionUnitId(String submissionUnitId) Sets the identifier that uniquely identifies this SubmissionUnit.
void	setSubmittedByAppName(String submittedByAppName) Sets the name of the application that submitted this SubmissionUnit.
void	setTriggerEventCode(String triggerEventCode) Sets the trigger event code.

Field Detail

ENCOUNTER

static final String ENCOUNTER

Value of the FocalActName attribute when Outbound Message Processor processes an encounter act. Only applies to acts submitted before V5 release.

See Also:

Constant Field Values

ENCOUNTER_APPOINTMENT

static final String ENCOUNTER_APPOINTMENT

Value of FocalActName attribute when Outbound Message Processor processes an encounter appointment act. Only applies to acts submitted before V5 release.

See Also:

Constant Field Values

CLINICAL_ACT

static final String CLINICAL_ACT

Value of FocalActName attribute when Outbound Message Processor processes a clinical act. Only applies to acts submitted before V5 release.

See Also:

Constant Field Values

PERSON_MERGE

static final String PERSON_MERGE

Value of FocalActName attribute attribute when Outbound Message Processor processes a person merge. Only applies to acts submitted before V5 release.

See Also:

Constant Field Values

CONTROL_ACT

static final String CONTROL_ACT

Value of FocalActName attribute when Outbound Message Processor is processing a control act. Only applies to acts submitted before V5 release.

See Also:

Constant Field Values

FOCAL_ACT

static final String FOCAL_ACT

Value of FocalActName attribute when Outbound Message Processor is processing an act, other than clinical, encounter, encounter appointment, or person merge. Only applies to acts submitted before V5 release.

See Also:

Constant Field Values

FOCAL_ENTITY

static final String FOCAL_ENTITY

Value of FocalActName attribute when Outbound Message Processor is processing an entity other than an act. Only applies to entities submitted before V5 release.

See Also:

Constant Field Values

FOCAL_ROLE

static final String FOCAL_ROLE

Value of FocalActName attribute when Outbound Message Processor is processing an encounter act. Only applies to acts submitted before V5 release.

See Also:

Constant Field Values

OMP_APP_NAME

static final String OMP_APP_NAME

Value of SubmittedByAppName attribute when Outbound Message Processor submits the SubmissionUnit.

See Also:

Constant Field Values

IMP_APP_NAME

static final String IMP_APP_NAME

Value of SubmittedByAppName attribute when Inbound Message Processor submits the SubmissionUnit.

See Also:

Constant Field Values

Method Detail

setSubmissionUnitId

void setSubmissionUnitId(String submissionUnitId)

Sets the identifier that uniquely identifies this SubmissionUnit. This method is called internally by Inbound Message Processor and not by an application.

Parameters:

submissionUnitId - Submission unit identifier.

See Also:

getSubmissionUnitId()

validated value

Must be numeric.

Comment:

Identifier that uniquely identifies this SubmissionUnit.

getSubmissionUnitId

String getSubmissionUnitId()

Gets the identifier that uniquely identifies this SubmissionUnit.

Returns:

Submission unit identifier.

See Also:

setSubmissionUnitId(java.lang.String)

setSenderOid

void setSenderOid(String senderOID)

Deprecated. Use setSenderII(II).

Sets the root of the Object Identifier (OID) of the sender.

Parameters:

senderOID - OID of the sender.

getSenderOid

String getSenderOid()

Deprecated. Use getSenderII().

Gets the Object Identifier (OID) of the sender.

Returns:

OID of the sender.

setMessageId

void setMessageId(String messageRootId)

Deprecated. Use setMessageII(II).

Sets the root of the identifier of the message contained in this SubmissionUnit.

Parameters:

messageRootId - Root of the identifier of the message contained in this SubmissionUnit.

getMessageId

String getMessageId()

Deprecated. Use getMessageII().

Gets the root of the identifier of the message contained in this SubmissionUnit.

Returns:

Root of the identifier of the message contained in this SubmissionUnit.

setMessageII

void setMessageII(II messageId)

Sets the identifier of the HL7 message.

Parameters:

messageId - HL7 message identifier.

See Also:

getMessageII()

Comment:

The interaction identifier is a reference to the unique information interchange derived from the HL7 V3 Message Definition Framework for specifying a message.

getMessageII

II getMessageII()
         throws HDRRimException

Gets the identifier of the HL7 message.

Returns:

Identifier of the HL7 message contained in this SubmissionUnit.

Throws:

CTBException - If error occurs creating II datatype object.

HDRRimException

See Also:

setMessageII(oracle.hsgbu.hdr.hl7.rim.types.II)

setTriggerEventCode

void setTriggerEventCode(String triggerEventCode)

Sets the trigger event code.

Parameters:

triggerEventCode - Trigger event code.

See Also:

getTriggerEventCode()

Comment:

The code identifying an explicit set of conditions that initiate the transfer of information between system components (application roles). It is a real-world event, such as the placing of a laboratory order or drug order. The trigger event must be systematically recognizable by an automated system.

getTriggerEventCode

String getTriggerEventCode()

Gets the trigger event code.

Returns:

Trigger event code.

See Also:

setTriggerEventCode(java.lang.String)

setControlActAuthorId

void setControlActAuthorId(String root)

Deprecated. Use setControlActAuthorII(II).

Sets the author identifier root of the ControlAct.

Parameters:

root - ControlAct author identifier root.

setControlActAuthorII

void setControlActAuthorII(II authorId)

Sets the identifier of the author who is responsible of the ControlAct and who "owns" the act.

Parameters:

authorId - ControlAct author identifier.

See Also:

getControlActAuthorII()

Comment:

Identifier of the author who is responsible of the ControlAct and who "owns" the act.

getControlActAuthorId

String getControlActAuthorId()

Deprecated. Use getControlActAuthorII().

Gets the author identifier root of the ControlAct.

Returns:

ControlAct author identifier root.

getControlActAuthorII

II getControlActAuthorII()
                  throws HDRRimException

Gets the identifier of the author who is responsible of the ControlAct and who "owns" the act.

Returns:

ControlAct author identifier.

Throws:

CTBException - If error occurs creating II datatype object.

HDRRimException

See Also:

setControlActAuthorII(oracle.hsgbu.hdr.hl7.rim.types.II)

setControlActAuthorName

void setControlActAuthorName(String controlActAuthorName)

Sets the name of the author who is responsible of the ControlAct and who "owns" the act.

Parameters:

controlActAuthorName - Author name of the ControlAct.

See Also:

getControlActAuthorName()

Comment:

Name of the author who is responsible of the ControlAct and who "owns" the act.

getControlActAuthorName

String getControlActAuthorName()

Gets the name of the author who is responsible of the ControlAct and who "owns" the act.

Returns:

Author name of the ControlAct.

See Also:

setControlActAuthorName(java.lang.String)

setSubmittedByAppName

void setSubmittedByAppName(String submittedByAppName)

Sets the name of the application that submitted this SubmissionUnit. Valid values are "HTBOMP" and "HTBIMP".

Parameters:

submittedByAppName - Name of the application that is submitting this SubmissionUnit.

See Also:

getSubmittedByAppName()

Comment:

Name of the application that submitted this SubmissionUnit. Valid values are "HTBOMP" and "HTBIMP".

getSubmittedByAppName

String getSubmittedByAppName()

Gets the name of the application that submitted this SubmissionUnit. Valid values are "HTBOMP" and "HTBIMP".

Returns:

Name of the application that submitted this SubmissionUnit. Valid values are "HTBOMP" and "HTBIMP".

See Also:

setSubmittedByAppName(java.lang.String)

setRespondToOID

void setRespondToOID(String root)

Deprecated. Use setRespondToII(II).

Sets the root of the RespondToOID.

Parameters:

root - Root of RespondToOID.

setRespondToII

void setRespondToII(II identifier)

Sets the identifier of the entity to which a response for this message has to be sent.

Parameters:

identifier - Identifier of the entity.

See Also:

getRespondToII()

Comment:

Identifier of the entity to which a response for this message has be sent.

getRespondToOID

String getRespondToOID()

Deprecated. Use getRespondToII().

Gets the root of the RespondToOID, which is the Object Identifier (OID) of the organization to which a response to this message has be sent.

Returns:

Identifier root of RespondToOID.

getRespondToII

II getRespondToII()
           throws HDRRimException

Gets the identifier of the entity to which a response for this message has be sent.

Returns:

Identifier of entity.

Throws:

CTBException - If error occurs creating II datatype object.

HDRRimException

See Also:

setRespondToII(oracle.hsgbu.hdr.hl7.rim.types.II)

setSubmissionDate

void setSubmissionDate(Date submissionDate)

Sets the date when the SubmissionUnit was persisted.

Parameters:

submissionDate - Submission date of the SubmissionUnit.

See Also:

getSubmissionDate()

Comment:

Date when the SubmissionUnit was persisted.

getSubmissionDate

Date getSubmissionDate()

Gets the date the SubmissionUnit was persisted.

Returns:

Submission date of the SubmissionUnit.

See Also:

setSubmissionDate(java.util.Date)

setMessageSeqNum

void setMessageSeqNum(String messageSeqNum)

Sets the message sequence number.

Parameters:

messageSeqNum - Message sequence number.

See Also:

getMessageSeqNum()

validated value

Comment:

Provided for implementing the sequence number protocol. This field is incremented by one for each subsequent value assignment.

getMessageSeqNum

String getMessageSeqNum()

Gets the message sequence number.

Returns:

Message sequence number.

See Also:

setMessageSeqNum(java.lang.String)

setMessageReferenceText

void setMessageReferenceText(String messageReferenceText)

Deprecated. No replacement.

Sets the message reference text.

Parameters:

messageReferenceText - Message reference text.

getMessageReferenceText

String getMessageReferenceText()

Deprecated. No replacement.

Gets the message reference text.

Returns:

Message reference text.

setAckMessageText

void setAckMessageText(String ackMessageText)

Sets the acknowledgement message text.

Parameters:

ackMessageText - Acknowledgement message text.

See Also:

getAckMessageText()

Comment:

The error, warning, and information details accompanying the acknowledgment.

getAckMessageText

String getAckMessageText()

Gets the acknowledgement message text.

Returns:

Acknowledgement message text.

See Also:

setAckMessageText(java.lang.String)

setReceivedNum

void setReceivedNum(String receivedNum)

Sets the received number, which is a counter that indicates the number of times Inbound Message Processor received a message with the same identifier, and for the same receiver.

Parameters:

receivedNum - Received number.

See Also:

getReceivedNum()

validated value

Comment:

Received number is a counter that indicates the number of times Inbound Message Processor received a message with the same identifier, and for the same receiver.

getReceivedNum

String getReceivedNum()

Gets the received number, which is a counter that indicates the number of times

Returns:

Received number.

See Also:

setReceivedNum(java.lang.String)

setAckRequestCode

void setAckRequestCode(String ackRequestCode)

Sets the acknowledgement request code.

Parameters:

ackRequestCode - Acknowledgement request code.

See Also:

getAckRequestCode()

Comment:

The code identifying the conditions under which accept acknowledgements are required to be returned in response to this message such as always, error only, success only, or never. Valid values are "AL", "ER", "NE", and "SU".

getAckRequestCode

String getAckRequestCode()

Gets the acknowledgement request code.

Returns:

Acknowledgement request code.

See Also:

setAckRequestCode(java.lang.String)

setAckTypeCode

void setAckTypeCode(String ackTypeCode)

Sets the acknowledgement code as described in the HL7 message processing rules.

Parameters:

ackTypeCode - Acknowledgement type code.

See Also:

getAckTypeCode(), setAckTypeCode(java.lang.String)

Comment:

Contains an acknowledgement code as described in the HL7 message processing rules, representing concepts such as accept(AA), error(AE), and reject(AR).

getAckTypeCode

String getAckTypeCode()

Gets the acknowledgement code as described in the HL7 message processing rules.

Returns:

Acknowledgement type code.

See Also:

setAckTypeCode(java.lang.String)

setProcessingModeCode

void setProcessingModeCode(String processingModeCode)

Sets the processing mode code.

Parameters:

processingModeCode - Processing mode code.

See Also:

getProcessingModeCode()

Comment:

Defines whether the message is being sent in current processing, archive mode, initial load mode, or restore from archive mode, as described in the HL7 Reference Information Model (RIM).

getProcessingModeCode

String getProcessingModeCode()

Gets the processing mode code.

Returns:

Processing mode code.

See Also:

setProcessingModeCode(java.lang.String)

setProcessingEnvCode

void setProcessingEnvCode(String processingEnvCode)

Sets the processing environment code.

Parameters:

processingEnvCode - Processing environment code.

See Also:

getProcessingEnvCode()

Comment:

Defines whether the message is part of a production, training, or a debugging system.

getProcessingEnvCode

String getProcessingEnvCode()

Gets the processing environment code.

Returns:

Processing environment code.

See Also:

setProcessingEnvCode(java.lang.String)

setOriginalMessageText

void setOriginalMessageText(String originalMessageText)

Sets the original HDR-compliant HL7 version 3.0 message text.

Parameters:

originalMessageText - Original message text.

See Also:

getOriginalMessageText(), setOriginalMessageText(java.lang.String)

Comment:

The original HDR-compliant HL7 version 3.0 message text. This text gets stored in database if "CTB_MS_STORE_MESSAGE" profile option is set.

getOriginalMessageText

String getOriginalMessageText()

Gets the original HDR-compliant HL7 version 3.0 message text.

Returns:

Original message text.

See Also:

setOriginalMessageText(java.lang.String)

setSendDate

void setSendDate(Date timeSent)

Sets the date and time when the message was sent to the receiver.

Parameters:

timeSent - Date and time when the message was sent to the receiver.

See Also:

getSendDate()

Comment:

Date and time the message was sent to the receiver.

getSendDate

Date getSendDate()

Gets the date and time when the message was sent.

Returns:

Date and time when the message was sent.

See Also:

setSendDate(java.util.Date)

setAckDate

void setAckDate(Date ackTimeSent)

Sets the date and time when the acknowledgement message was sent.

Parameters:

ackTimeSent - Date and time when the acknowledgement message was sent.

See Also:

getAckDate()

Comment:

Date and time when the message was acknowledged by the receiver.

getAckDate

Date getAckDate()

Gets the date and time when the acknowledgement message was sent.

Returns:

Date and time when the acknowledgement message was sent.

See Also:

setAckDate(java.util.Date)

setSkipFlag

void setSkipFlag(Boolean skipFlag)

Sets the flag that indicates if the message identifier associated with this SubmissionUnit should be skipped.

Parameters:

skipFlag - Flag that indicates if the message identifier associated with this SubmissionUnit must be skipped. "Yes" indicates that the next message has to be skipped, and "No" indicates that the message has to be processed.

See Also:

getSkipFlag()

validated value

Comment:

Flag that indicates if the message identifier associated with this SubmissionUnit should be skipped. "Yes" indicates that the next message has to be skipped, and "No" indicates that the message has to be processed.

getSkipFlag

Boolean getSkipFlag()

Gets the flag that indicates if the message identifier associated with this SubmissionUnit must be skipped.

Returns:

Flag that indicates if the message identifier associated with this SubmissionUnit is skipped. "Yes" indicates that the next message will be skipped, and "No" indicates that the next message will be processed.

See Also:

setSkipFlag(java.lang.Boolean)

setFocalActName

void setFocalActName(String act)

Sets the focal act name, which indicates the specific type of focal act. Valid values include "ENCOUNTER", "ENCOUNTER_APPOINTMENT", "CLINICAL_ACT", and "PERSON_MERGE".

Parameters:

act - Name of the focal act.

See Also:

getFocalActName()

Comment:

Name of the focal act. Valid values include "ENCOUNTER", "ENCOUNTER_APPOINTMENT", "CLINICAL_ACT", and "PERSON_MERGE".

getFocalActName

String getFocalActName()

Gets the name of the focal act.

Returns:

Name of the focal act.

See Also:

setFocalActName(java.lang.String)

setFocalActII

void setFocalActII(II actId)

Sets the identifier of the focal act, which is the focus of the ControlAct, and may be a ClinicalAct, Encounter, EncounterAppointment, or PersonMergeRequest. The FocalActName attribute determines the specific type of focal act.

Parameters:

actId - Identifier of the focal act.

See Also:

getFocalActII()

validated value

Comment:

Identifier of the focal act, which is the focus of the ControlAct and may be a ClinicalAct, Encounter, EncounterAppointment, or PersonMergeRequest.

setFocalActId

void setFocalActId(String actId)

Deprecated. Use setFocalActII(II).

Sets the identifier of the focal act.

Parameters:

actId - Identifier of the focal act.

getFocalActII

II getFocalActII()
          throws HDRRimException

Gets the identifier of the focal act, which is the focus of the ControlAct, and may be a ClinicalAct, Encounter, EncounterAppointment, or PersonMergeRequest. The FocalActName attribute determines the specific type of focal act.

Returns:

Identifier of the focal act.

Throws:

HDRRimException - If an error occurs while creating an object of II datatype.

See Also:

setFocalActII(oracle.hsgbu.hdr.hl7.rim.types.II)

getFocalActId

String getFocalActId()

Deprecated. Use getFocalActII().

Gets the identifier of the focal act.

Returns:

Identifier of the focal act.

setFocalActVersionNum

void setFocalActVersionNum(String versionNum)

Sets the version number of the focal act.

Parameters:

versionNum - Version number of the focal act.

See Also:

getFocalActVersionNum()

validated value

Comment:

Version number of the focal act.

getFocalActVersionNum

String getFocalActVersionNum()

Gets the version number of the focal act.

Returns:

versionNum Version number of the focal act.

See Also:

setFocalActVersionNum(java.lang.String)

setPersonId

void setPersonId(String personId)

Deprecated. Use setPersonII(II).

Sets the person identifier.

Parameters:

personId - Person identifier.

setPersonII

void setPersonII(II personId)

Sets the person identifier.

Parameters:

personId - Person II identifier.

See Also:

getPersonII()

validated value

Comment:

The identifier of the person who is the target of the focal act, typically (though not always) participating in the role of a patient.

getPersonId

String getPersonId()

Deprecated. Use getPersonII().

Gets the person identifier.

Returns:

String Person identifier.

getPersonII

II getPersonII()
        throws HDRRimException

Gets the person identifier.

Returns:

The person identifier.

Throws:

HDRRimException - If error occurs creating II datatype object.

See Also:

setPersonII(oracle.hsgbu.hdr.hl7.rim.types.II)

setResendFlag

void setResendFlag(Boolean resendFlag)

Sets the flag that indicates whether the message should be resent.

Parameters:

resendFlag - The flag that indicates whether the message should be resent.

See Also:

getResendFlag()

validated value

Comment:

Flag indicating whether the message should be resent.

getResendFlag

Boolean getResendFlag()

Gets the flag that indicates whether the message should be resent.

Returns:

The flag that indicates whether the message should be resent.

See Also:

setResendFlag(java.lang.Boolean)

setControlActII

void setControlActII(II controlActId)

Sets the ControlAct identifier.

Parameters:

controlActId - ControlAct identifier.

See Also:

getControlActII()

Comment:

The identifier of the act representing a change to the state of another class, a user event (example, a query), or a system event (example, time-based occurrences). This class corresponds to the concept of "Trigger Event", and as such, must be present as the focus of every messaging interaction.

getControlActII

II getControlActII()
            throws HDRRimException

Gets the ControlAct identifier. The ControlAct is part of a wrapper that contains payload of a message. The ControlAct is part of the HL7 messages that convey status for logical operations that are coordinated between healthcare applications.

For example, coordination of query specification or query response interactions.

Returns:

ControlAct root identifier.

Throws:

HDRRimException - If an error occurs while creating an object of II datatype.

See Also:

setControlActII(oracle.hsgbu.hdr.hl7.rim.types.II)

validated value

setSenderII

void setSenderII(II senderId)

Sets the sender identifier.

Parameters:

senderId - Sender identifier.

See Also:

getSenderII()

validated value

Comment:

Identifier of the entity to which this message was sent.

getSenderII

II getSenderII()
        throws HDRRimException

Gets the sender identifier.

Returns:

Message sender identifier.

Throws:

HDRRimException - If an error occurs while creating an object of II datatype.

See Also:

setSenderII(oracle.hsgbu.hdr.hl7.rim.types.II)

setReceiverII

void setReceiverII(II receiverId)

Sets the receiver identifier.

Parameters:

receiverId - Receiver identifier.

See Also:

getReceiverII()

validated value

Comment:

The identifier of the entity that will receive the HL7 message.

getReceiverII

II getReceiverII()
          throws HDRRimException

Gets the receiver identifier.

Returns:

Receiver identifier.

Throws:

HDRRimException - If an error occurs while creating an object of II datatype.

See Also:

setReceiverII(oracle.hsgbu.hdr.hl7.rim.types.II)