org.hl7.rim

Interface Message

public interface Message extends RimObject, Transmission

Interface for RIM class Message.

The Message class is the parent class of all HL7 Version 3 messages.

Method Summary
void	addAcknowledgedBy(Acknowledgement value) Adds an association 'acknowledgedBy' to RIM class Acknowledgement.
CS	getAcceptAckCode() Gets attribute acceptAckCode of type CS and cardinality 0..1.
AssociationSet<Acknowledgement>	getAcknowledgedBy() Gets association 'acknowledgedBy' to RIM classes Acknowledgement with cardinality (0..*).
SET<ED>	getAttachmentText() Gets attribute attachmentText of type SET and cardinality 0..*.
ControlAct	getControlAct() Gets association 'controlAct' to RIM class ControlAct with cardinality (0..1).
Acknowledgement	getConveyedAcknowledgement() Gets association 'conveyedAcknowledgement' to RIM class Acknowledgement with cardinality (0..1).
II	getInteractionId() Gets attribute interactionId of type II and cardinality 0..1.
CS	getProcessingCode() Gets attribute processingCode of type CS and cardinality 0..1.
CS	getProcessingModeCode() Gets attribute processingModeCode of type CS and cardinality 0..1.
SET<II>	getProfileId() Gets attribute profileId of type SET and cardinality 0..*.
CS	getResponseCode() Gets attribute responseCode of type CS and cardinality 0..1.
INT	getSequenceNumber() Gets attribute sequenceNumber of type INT and cardinality 0..1.
CS	getVersionCode() Gets attribute versionCode of type CS and cardinality 0..1.
void	setAcceptAckCode(CS value) Sets attribute acceptAckCode of type CS and cardinality 0..1.
void	setAcknowledgedBy(AssociationSet<Acknowledgement> value) Sets associations 'acknowledgedBy' to RIM classes Acknowledgement with cardinality (0..*).
void	setAttachmentText(SET<ED> value) Sets attribute attachmentText of type SET and cardinality 0..*.
void	setControlAct(ControlAct value) Sets association 'controlAct' to RIM class ControlAct with cardinality (0..1).
void	setConveyedAcknowledgement(Acknowledgement value) Sets association 'conveyedAcknowledgement' to RIM class Acknowledgement with cardinality (0..1).
void	setInteractionId(II value) Sets attribute interactionId of type II and cardinality 0..1.
void	setProcessingCode(CS value) Sets attribute processingCode of type CS and cardinality 0..1.
void	setProcessingModeCode(CS value) Sets attribute processingModeCode of type CS and cardinality 0..1.
void	setProfileId(SET<II> value) Sets attribute profileId of type SET and cardinality 0..*.
void	setResponseCode(CS value) Sets attribute responseCode of type CS and cardinality 0..1.
void	setSequenceNumber(INT value) Sets attribute sequenceNumber of type INT and cardinality 0..1.
void	setVersionCode(CS value) Sets attribute versionCode of type CS and cardinality 0..1.

Method Detail

addAcknowledgedBy

public void addAcknowledgedBy(Acknowledgement value)

Adds an association 'acknowledgedBy' to RIM class Acknowledgement.

Identifies the relationship between a message and the acknowledgements that acknowledge that message.

Parameters: value the added association value

getAcceptAckCode

public CS getAcceptAckCode()

Gets attribute acceptAckCode of type CS and cardinality 0..1.

The attribute identifies the conditions under which accept acknowledgements are required to be returned in response to this message.

Returns: the attribute value

getAcknowledgedBy

public AssociationSet<Acknowledgement> getAcknowledgedBy()

Gets association 'acknowledgedBy' to RIM classes Acknowledgement with cardinality (0..*).

Identifies the relationship between a message and the acknowledgements that acknowledge that message.

Returns: the references to the linked classes

getAttachmentText

public SET<ED> getAttachmentText()

Gets attribute attachmentText of type SET and cardinality 0..*.

Contains arbitrary attachments of data blocks to which can be referred to from the interior of the message. Any ITS is advised to represent the attachments behind the main message body. Attachments are referred to from the message body using the reference functionality of the ED data type.

Returns: the attribute value

getControlAct

public ControlAct getControlAct()

Gets association 'controlAct' to RIM class ControlAct with cardinality (0..1).

Returns: the reference to the linked class

getConveyedAcknowledgement

public Acknowledgement getConveyedAcknowledgement()

Gets association 'conveyedAcknowledgement' to RIM class Acknowledgement with cardinality (0..1).

Identifies the relationship between an acknowledgment and the message conveying that acknowledgement.

Returns: the reference to the linked class

getInteractionId

public II getInteractionId()

Gets attribute interactionId of type II and cardinality 0..1.

The interaction identifier is a reference to the unique information interchange derived from the V3 MDF for specifying a message.

Returns: the attribute value

getProcessingCode

public CS getProcessingCode()

Gets attribute processingCode of type CS and cardinality 0..1.

This attribute defines whether the message is part of a production, training, or debugging system.

Returns: the attribute value

getProcessingModeCode

public CS getProcessingModeCode()

Gets attribute processingModeCode of type CS and cardinality 0..1.

This attribute defines whether the message is being sent in current processing, archive mode, initial load mode, restore from archive mode, etc.

Returns: the attribute value

getProfileId

public SET<II> getProfileId()

Gets attribute profileId of type SET and cardinality 0..*.

The message profile identifier allows a given implementation to explicitly state how it varies from the standard message definition.

Returns: the attribute value

getResponseCode

public CS getResponseCode()

Gets attribute responseCode of type CS and cardinality 0..1.

Specifies whether an application response is expected from the addressee of this interaction and what level of detail that response should include. This attribute restricts the default response options specified by the receiver responsibilities for the interaction. For example, if an interaction has receiver responsibilities to send either an accept interaction or a refuse interaction, and the responseCode is set to 'E' - Exception, the receiver should only respond if they refuse.

Returns: the attribute value

getSequenceNumber

public INT getSequenceNumber()

Gets attribute sequenceNumber of type INT and cardinality 0..1.

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

Returns: the attribute value

getVersionCode

public CS getVersionCode()

Gets attribute versionCode of type CS and cardinality 0..1.

This attribute is matched by the receiving system to its own version to be sure the message will be interpreted correctly.

Returns: the attribute value

setAcceptAckCode

public void setAcceptAckCode(CS value)

Sets attribute acceptAckCode of type CS and cardinality 0..1.

The attribute identifies the conditions under which accept acknowledgements are required to be returned in response to this message.

Parameters: value the new attribute value

setAcknowledgedBy

public void setAcknowledgedBy(AssociationSet<Acknowledgement> value)

Sets associations 'acknowledgedBy' to RIM classes Acknowledgement with cardinality (0..*).

Identifies the relationship between a message and the acknowledgements that acknowledge that message.

Parameters: value the new association values

setAttachmentText

public void setAttachmentText(SET<ED> value)

Sets attribute attachmentText of type SET and cardinality 0..*.

Parameters: value the new attribute value

setControlAct

public void setControlAct(ControlAct value)

Sets association 'controlAct' to RIM class ControlAct with cardinality (0..1).

Parameters: value the new association value

setConveyedAcknowledgement

public void setConveyedAcknowledgement(Acknowledgement value)

Sets association 'conveyedAcknowledgement' to RIM class Acknowledgement with cardinality (0..1).

Identifies the relationship between an acknowledgment and the message conveying that acknowledgement.

Parameters: value the new association value

setInteractionId

public void setInteractionId(II value)

Sets attribute interactionId of type II and cardinality 0..1.

The interaction identifier is a reference to the unique information interchange derived from the V3 MDF for specifying a message.

Parameters: value the new attribute value

setProcessingCode

public void setProcessingCode(CS value)

Sets attribute processingCode of type CS and cardinality 0..1.

This attribute defines whether the message is part of a production, training, or debugging system.

Parameters: value the new attribute value

setProcessingModeCode

public void setProcessingModeCode(CS value)

Sets attribute processingModeCode of type CS and cardinality 0..1.

This attribute defines whether the message is being sent in current processing, archive mode, initial load mode, restore from archive mode, etc.

Parameters: value the new attribute value

setProfileId

public void setProfileId(SET<II> value)

Sets attribute profileId of type SET and cardinality 0..*.

The message profile identifier allows a given implementation to explicitly state how it varies from the standard message definition.

Parameters: value the new attribute value

setResponseCode

public void setResponseCode(CS value)

Sets attribute responseCode of type CS and cardinality 0..1.

Parameters: value the new attribute value

setSequenceNumber

public void setSequenceNumber(INT value)

Sets attribute sequenceNumber of type INT and cardinality 0..1.

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

Parameters: value the new attribute value

setVersionCode

public void setVersionCode(CS value)

Sets attribute versionCode of type CS and cardinality 0..1.

This attribute is matched by the receiving system to its own version to be sure the message will be interpreted correctly.

Parameters: value the new attribute value