ca.infoway.messagebuilder.model.ab_mr2007_v02_r02.common.merged
Class HL7MessageBean

java.lang.Object
  ca.infoway.messagebuilder.model.MessagePartBean
      ca.infoway.messagebuilder.model.ab_mr2007_v02_r02.common.merged.HL7MessageBean

All Implemented Interfaces:

NullFlavorSupport, Serializable

Direct Known Subclasses:

AcceptAckBean, AcceptAckPollForNextMessageBean, ExceptionAckInResponseToPollRequestBean, RequestPollQueueStatusBean, ReturnPollQueueStatusBean, SendPollMessageAcceptAckBean, SendPollRequestBean

public class HL7MessageBean
extends MessagePartBean

Business Name: HL7Message

MCCI_MT102001CA.Message: HL7 Message

The root class of all messages.

Conveys information about the interaction and how it is to be processed

MCCI_MT002200CA.Message: HL7 Message

The root class of all messages.

Conveys information about the interaction and how it is to be processed

See Also:

Serialized Form

Constructor Summary

HL7MessageBean()

Method Summary

AcknowledgementCondition	getAcceptAckCode() Business Name: DesiredAcknowledgmentType
AcknowledgementBean	getAcknowledgement() Un-merged Business Name: (no business name specified)
List<RoutingInstructionLinesBean>	getAttentionLine() Un-merged Business Name: (no business name specified)
Date	getCreationTime() Business Name: MessageTimestamp
Identifier	getId() Business Name: MessageIdentifier
Identifier	getInteractionId() Business Name: InteractionType
ProcessingID	getProcessingCode() Business Name: ProcessingCode
List<Identifier>	getProfileId() Business Name: ConformanceProfileIdentifiers
ReceiverBean	getReceiver() Un-merged Business Name: (no business name specified)
ToBeRespondedToByBean	getRespondTo() Un-merged Business Name: (no business name specified)
ResponseMode	getResponseModeCode() Business Name: ResponseType
String	getSecurityText() Business Name: SecurityToken
SenderBean	getSender() Un-merged Business Name: (no business name specified)
HL7StandardVersionCode	getVersionCode() Business Name: HL7StandardVersion
void	setAcceptAckCode(AcknowledgementCondition acceptAckCode) Business Name: DesiredAcknowledgmentType
void	setAcknowledgement(AcknowledgementBean acknowledgement) Un-merged Business Name: (no business name specified)
void	setCreationTime(Date creationTime) Business Name: MessageTimestamp
void	setId(Identifier id) Business Name: MessageIdentifier
void	setInteractionId(Identifier interactionId) Business Name: InteractionType
void	setProcessingCode(ProcessingID processingCode) Business Name: ProcessingCode
void	setReceiver(ReceiverBean receiver) Un-merged Business Name: (no business name specified)
void	setRespondTo(ToBeRespondedToByBean respondTo) Un-merged Business Name: (no business name specified)
void	setResponseModeCode(ResponseMode responseModeCode) Business Name: ResponseType
void	setSecurityText(String securityText) Business Name: SecurityToken
void	setSender(SenderBean sender) Un-merged Business Name: (no business name specified)
void	setVersionCode(HL7StandardVersionCode versionCode) Business Name: HL7StandardVersion

Methods inherited from class ca.infoway.messagebuilder.model.MessagePartBean

getField, getNullFlavor, getNullFlavor, getSpecializationType, hasNullFlavor, hasNullFlavor, setNullFlavor, setNullFlavor, setSpecializationType

Methods inherited from class java.lang.Object

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

Constructor Detail

HL7MessageBean

public HL7MessageBean()

Method Detail

getId

public Identifier getId()

Business Name: MessageIdentifier

Un-merged Business Name: MessageIdentifier

Relationship: MCCI_MT102001CA.Message.id

Conformance/Cardinality: MANDATORY (1)

A unique identifier for the message.

soap:Header\wsa:MessageID

Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory.

Un-merged Business Name: MessageIdentifier

Relationship: MCCI_MT002200CA.Message.id

Conformance/Cardinality: MANDATORY (1)

A unique identifier for the message.

soap:Header\wsa:MessageID

Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory.

setId

public void setId(Identifier id)

Business Name: MessageIdentifier

Un-merged Business Name: MessageIdentifier

Relationship: MCCI_MT102001CA.Message.id

Conformance/Cardinality: MANDATORY (1)

A unique identifier for the message.

soap:Header\wsa:MessageID

Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory.

Un-merged Business Name: MessageIdentifier

Relationship: MCCI_MT002200CA.Message.id

Conformance/Cardinality: MANDATORY (1)

A unique identifier for the message.

soap:Header\wsa:MessageID

Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory.

getCreationTime

public Date getCreationTime()

Business Name: MessageTimestamp

Un-merged Business Name: MessageTimestamp

Relationship: MCCI_MT102001CA.Message.creationTime

Conformance/Cardinality: MANDATORY (1)

Indicates the time this particular message instance was constructed.

Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory.

Un-merged Business Name: MessageTimestamp

Relationship: MCCI_MT002200CA.Message.creationTime

Conformance/Cardinality: MANDATORY (1)

Indicates the time this particular message instance was constructed.

Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory.

setCreationTime

public void setCreationTime(Date creationTime)

Business Name: MessageTimestamp

Un-merged Business Name: MessageTimestamp

Relationship: MCCI_MT102001CA.Message.creationTime

Conformance/Cardinality: MANDATORY (1)

Indicates the time this particular message instance was constructed.

Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory.

Un-merged Business Name: MessageTimestamp

Relationship: MCCI_MT002200CA.Message.creationTime

Conformance/Cardinality: MANDATORY (1)

Indicates the time this particular message instance was constructed.

Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory.

getSecurityText

public String getSecurityText()

Business Name: SecurityToken

Un-merged Business Name: SecurityToken

Relationship: MCCI_MT102001CA.Message.securityText

Conformance/Cardinality: OPTIONAL (0-1)

A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source.

Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability.

Un-merged Business Name: SecurityToken

Relationship: MCCI_MT002200CA.Message.securityText

Conformance/Cardinality: OPTIONAL (0-1)

A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source.

Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability.

setSecurityText

public void setSecurityText(String securityText)

Business Name: SecurityToken

Un-merged Business Name: SecurityToken

Relationship: MCCI_MT102001CA.Message.securityText

Conformance/Cardinality: OPTIONAL (0-1)

A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source.

Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability.

Un-merged Business Name: SecurityToken

Relationship: MCCI_MT002200CA.Message.securityText

Conformance/Cardinality: OPTIONAL (0-1)

A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source.

Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability.

getResponseModeCode

public ResponseMode getResponseModeCode()

Business Name: ResponseType

Un-merged Business Name: ResponseType

Relationship: MCCI_MT102001CA.Message.responseModeCode

Conformance/Cardinality: MANDATORY (1)

Identifies whether the response is desired immediately (as a direct acknowledgement), on a deferred basis (as a subsequent independent interaction) or via queue using polling.

soap:Header\wsa:Action (after the second underscore, if any, “D” otherwise)

Essential to determining receiver behavior and therefore mandatory.

Un-merged Business Name: ResponseType

Relationship: MCCI_MT002200CA.Message.responseModeCode

Conformance/Cardinality: MANDATORY (1)

Identifies whether the response is desired immediately (as a direct acknowledgement), on a deferred basis (as a subsequent independent interaction) or via queue using polling.

soap:Header\wsa:Action (after the second underscore, if any, “D” otherwise)

Essential to determining receiver behavior and therefore mandatory.

setResponseModeCode

public void setResponseModeCode(ResponseMode responseModeCode)

Business Name: ResponseType

Un-merged Business Name: ResponseType

Relationship: MCCI_MT102001CA.Message.responseModeCode

Conformance/Cardinality: MANDATORY (1)

Identifies whether the response is desired immediately (as a direct acknowledgement), on a deferred basis (as a subsequent independent interaction) or via queue using polling.

soap:Header\wsa:Action (after the second underscore, if any, “D” otherwise)

Essential to determining receiver behavior and therefore mandatory.

Un-merged Business Name: ResponseType

Relationship: MCCI_MT002200CA.Message.responseModeCode

Conformance/Cardinality: MANDATORY (1)

Identifies whether the response is desired immediately (as a direct acknowledgement), on a deferred basis (as a subsequent independent interaction) or via queue using polling.

soap:Header\wsa:Action (after the second underscore, if any, “D” otherwise)

Essential to determining receiver behavior and therefore mandatory.

getVersionCode

public HL7StandardVersionCode getVersionCode()

Business Name: HL7StandardVersion

Un-merged Business Name: HL7StandardVersion

Relationship: MCCI_MT102001CA.Message.versionCode

Conformance/Cardinality: MANDATORY (1)

Indicates the version of the messaging standard being referenced.

soap:Header\wsa:To\ (portion between last “\” and second-last “\”)

Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory.

Un-merged Business Name: HL7StandardVersion

Relationship: MCCI_MT002200CA.Message.versionCode

Conformance/Cardinality: MANDATORY (1)

Indicates the version of the messaging standard being referenced.

soap:Header\wsa:To\ (portion between last “\” and second-last “\”)

Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory.

setVersionCode

public void setVersionCode(HL7StandardVersionCode versionCode)

Business Name: HL7StandardVersion

Un-merged Business Name: HL7StandardVersion

Relationship: MCCI_MT102001CA.Message.versionCode

Conformance/Cardinality: MANDATORY (1)

Indicates the version of the messaging standard being referenced.

soap:Header\wsa:To\ (portion between last “\” and second-last “\”)

Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory.

Un-merged Business Name: HL7StandardVersion

Relationship: MCCI_MT002200CA.Message.versionCode

Conformance/Cardinality: MANDATORY (1)

Indicates the version of the messaging standard being referenced.

soap:Header\wsa:To\ (portion between last “\” and second-last “\”)

Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory.

getInteractionId

public Identifier getInteractionId()

Business Name: InteractionType

Un-merged Business Name: InteractionType

Relationship: MCCI_MT102001CA.Message.interactionId

Conformance/Cardinality: MANDATORY (1)

Indicates the interaction conveyed by this message.

soap:Header\wsa:Action (after “urn:hl7-org:v3:” and before the second underscore, if any)

Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory.

Un-merged Business Name: InteractionType

Relationship: MCCI_MT002200CA.Message.interactionId

Conformance/Cardinality: MANDATORY (1)

Indicates the interaction conveyed by this message.

soap:Header\wsa:Action (after “urn:hl7-org:v3:” and before the second underscore, if any)

Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory.

setInteractionId

public void setInteractionId(Identifier interactionId)

Business Name: InteractionType

Un-merged Business Name: InteractionType

Relationship: MCCI_MT102001CA.Message.interactionId

Conformance/Cardinality: MANDATORY (1)

Indicates the interaction conveyed by this message.

soap:Header\wsa:Action (after “urn:hl7-org:v3:” and before the second underscore, if any)

Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory.

Un-merged Business Name: InteractionType

Relationship: MCCI_MT002200CA.Message.interactionId

Conformance/Cardinality: MANDATORY (1)

Indicates the interaction conveyed by this message.

soap:Header\wsa:Action (after “urn:hl7-org:v3:” and before the second underscore, if any)

Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory.

getProfileId

public List<Identifier> getProfileId()

Business Name: ConformanceProfileIdentifiers

Un-merged Business Name: ConformanceProfileIdentifiers

Relationship: MCCI_MT102001CA.Message.profileId

Conformance/Cardinality: REQUIRED (0-10)

Identifies the conformance profile(s) this message complies with.

Indicates any additional validation that may be appropriate. Also influences what extensions can be processed.

Un-merged Business Name: ConformanceProfileIdentifiers

Relationship: MCCI_MT002200CA.Message.profileId

Conformance/Cardinality: REQUIRED (0-10)

Identifies the conformance profile(s) this message complies with.

Indicates any additional validation that may be appropriate. Also influences what extensions can be processed.

getProcessingCode

public ProcessingID getProcessingCode()

Business Name: ProcessingCode

Un-merged Business Name: ProcessingCode

Relationship: MCCI_MT102001CA.Message.processingCode

Conformance/Cardinality: MANDATORY (1)

Indicates whether this message is intended to be processed as production, test or debug message.

soap:Header\wsa:To\(portion between second-last “\” and third-last “\”)

Indicates how the message should be handled and is therefore mandatory.

Un-merged Business Name: ProcessingCode

Relationship: MCCI_MT002200CA.Message.processingCode

Conformance/Cardinality: MANDATORY (1)

Indicates whether this message is intended to be processed as production, test or debug message.

soap:Header\wsa:To\(portion between second-last “\” and third-last “\”)

Indicates how the message should be handled and is therefore mandatory.

setProcessingCode

public void setProcessingCode(ProcessingID processingCode)

Business Name: ProcessingCode

Un-merged Business Name: ProcessingCode

Relationship: MCCI_MT102001CA.Message.processingCode

Conformance/Cardinality: MANDATORY (1)

Indicates whether this message is intended to be processed as production, test or debug message.

soap:Header\wsa:To\(portion between second-last “\” and third-last “\”)

Indicates how the message should be handled and is therefore mandatory.

Un-merged Business Name: ProcessingCode

Relationship: MCCI_MT002200CA.Message.processingCode

Conformance/Cardinality: MANDATORY (1)

Indicates whether this message is intended to be processed as production, test or debug message.

soap:Header\wsa:To\(portion between second-last “\” and third-last “\”)

Indicates how the message should be handled and is therefore mandatory.

getAcceptAckCode

public AcknowledgementCondition getAcceptAckCode()

Business Name: DesiredAcknowledgmentType

Un-merged Business Name: DesiredAcknowledgmentType

Relationship: MCCI_MT102001CA.Message.acceptAckCode

Conformance/Cardinality: MANDATORY (1)

Indicates how the message is expected to be acknowledged.

Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory.

When using SOAP, this attribute MUST be set to NE (Never). (Accept acknowledgements are handled via the transport protocol, not HL7.)

Un-merged Business Name: DesiredAcknowledgmentType

Relationship: MCCI_MT002200CA.Message.acceptAckCode

Conformance/Cardinality: MANDATORY (1)

Indicates how the message is expected to be acknowledged.

Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory.

When using SOAP, this attribute MUST be set to NE (Never). (Accept acknowledgements are handled via the transport protocol, not HL7.)

setAcceptAckCode

public void setAcceptAckCode(AcknowledgementCondition acceptAckCode)

Business Name: DesiredAcknowledgmentType

Un-merged Business Name: DesiredAcknowledgmentType

Relationship: MCCI_MT102001CA.Message.acceptAckCode

Conformance/Cardinality: MANDATORY (1)

Indicates how the message is expected to be acknowledged.

Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory.

When using SOAP, this attribute MUST be set to NE (Never). (Accept acknowledgements are handled via the transport protocol, not HL7.)

Un-merged Business Name: DesiredAcknowledgmentType

Relationship: MCCI_MT002200CA.Message.acceptAckCode

Conformance/Cardinality: MANDATORY (1)

Indicates how the message is expected to be acknowledged.

Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory.

When using SOAP, this attribute MUST be set to NE (Never). (Accept acknowledgements are handled via the transport protocol, not HL7.)

getReceiver

public ReceiverBean getReceiver()

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT102001CA.Message.receiver

Conformance/Cardinality: MANDATORY (1)

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT002200CA.Message.receiver

Conformance/Cardinality: MANDATORY (1)

setReceiver

public void setReceiver(ReceiverBean receiver)

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT102001CA.Message.receiver

Conformance/Cardinality: MANDATORY (1)

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT002200CA.Message.receiver

Conformance/Cardinality: MANDATORY (1)

getRespondTo

public ToBeRespondedToByBean getRespondTo()

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT102001CA.Message.respondTo

Conformance/Cardinality: OPTIONAL (0-1)

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT002200CA.Message.respondTo

Conformance/Cardinality: OPTIONAL (0-1)

setRespondTo

public void setRespondTo(ToBeRespondedToByBean respondTo)

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT102001CA.Message.respondTo

Conformance/Cardinality: OPTIONAL (0-1)

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT002200CA.Message.respondTo

Conformance/Cardinality: OPTIONAL (0-1)

getSender

public SenderBean getSender()

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT102001CA.Message.sender

Conformance/Cardinality: MANDATORY (1)

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT002200CA.Message.sender

Conformance/Cardinality: MANDATORY (1)

setSender

public void setSender(SenderBean sender)

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT102001CA.Message.sender

Conformance/Cardinality: MANDATORY (1)

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT002200CA.Message.sender

Conformance/Cardinality: MANDATORY (1)

getAttentionLine

public List<RoutingInstructionLinesBean> getAttentionLine()

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT102001CA.Message.attentionLine

Conformance/Cardinality: OPTIONAL (0-5)

getAcknowledgement

public AcknowledgementBean getAcknowledgement()

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT002200CA.Message.acknowledgement

Conformance/Cardinality: MANDATORY (1)

setAcknowledgement

public void setAcknowledgement(AcknowledgementBean acknowledgement)

Un-merged Business Name: (no business name specified)

Relationship: MCCI_MT002200CA.Message.acknowledgement

Conformance/Cardinality: MANDATORY (1)