org.vmdb.hl7
Class MSHSegment

java.lang.Object
  |
  +--org.vmdb.hl7.HL7Object
        |
        +--org.vmdb.hl7.HL7Segment
              |
              +--org.vmdb.hl7.MSHSegment

public class MSHSegment

extends HL7Segment

Message Header (MSH) Segment.

Description: HL7 Network Connectivity For VMDB.

Copyright: Copyright (c) 2002-2003.

Company: Veterinary Medical Database (VMDB).

The MSH segment defines the intent, source, destination, and some specifics of the syntax of a message. Because this information is needed by the program in order to properly construct the segments that follow, the MSH should be populated before any additional segments are added.

See HL7 Standard Chapter 2 for details.

Constructor Summary

MSHSegment()
Construct an empty header segment.

MSHSegment(HL7SegmentContainer msgParent)
Construct an empty header segment, setting its containing message object.

Method Summary

java.lang.String	getMessageControlId() Get the message control ID as a string.
java.lang.String	getMessageDateTime() Get the date/time as a string.
java.lang.String	getMessageName() The message name is a concatenation of the message type and version.
java.lang.String	getProcessingId() Get just the processing Id
PTElement	getProcessingIdElement() Get the processing Id as PT Element.
java.lang.String	getProcessingMode() Get just the processing mode.
HDElement	getReceivingFacility() Get the Receiving facility as the complete HDElement.
java.lang.String	getReceivingFacilityId() Get just the universal id of the Receiving facility, the VMDB identifier in this case.
java.lang.String	getReceivingFacilityName() Get just the namespace id of the Receiving facility, the text string for the facility name in this case.
HDElement	getSendingFacility() Get the sending facility as the complete HDElement.
java.lang.String	getSendingFacilityId() Get just the universal id of the sending facility, the VMDB identifier in this case.
java.lang.String	getSendingFacilityName() Get just the namespace id of the sending facility, the text string for the facility name in this case.
java.lang.String	getVersionId() Get the HL7 Version number.
void	setMessageControlId(java.lang.String sMessageControlId) Set the message control ID.
void	setMessageDateTime() Set the date/time of the message to the time now.
void	setMessageDateTime(java.lang.String sDateTime) Set the date/time of the message to string formatted date/time.
void	setMessageName(java.lang.String sMsgType, java.lang.String sEventType, java.lang.String sMsgStructure) Set the message type and version.
void	setProcessingId(java.lang.String sProcessingId) Set the processing ID.
void	setProcessingId(java.lang.String sProcessingId, java.lang.String sProcessingMode) Set the processing ID from the individual components of a PT Element
void	setProcessingMode(java.lang.String sProcessingMode) Set the processing mode.
void	setReceivingFacility(HDElement hdFacility) Set the sending facility.
void	setReceivingFacility(java.lang.String sName) Set the Receiving facility.
void	setReceivingFacility(java.lang.String sName, java.lang.String sId) Set the Receiving facility.
void	setReceivingFacility(java.lang.String sNamespaceId, java.lang.String sId, java.lang.String sIdType) Set the Receiving facility.
void	setSendingFacility(HDElement hdFacility) Set the sending facility.
void	setSendingFacility(java.lang.String sName) Set the sending facility.
void	setSendingFacility(java.lang.String sName, java.lang.String sId) Set the sending facility.
void	setSendingFacility(java.lang.String sNamespaceId, java.lang.String sId, java.lang.String sIdType) Set the sending facility.
void	setSeparators(java.lang.String sSeparators) Set separators for the message and all its segments.
void	setVersionId(java.lang.String sVersionId) Set the HL7 Version number.
java.lang.String	toString() Output segment as HL7.

Methods inherited from class org.vmdb.hl7.HL7Segment

clearField, getField, getFieldValue, iterator, listFields, setField, setField, setField, setField, setField, setField, setField, toXML

Methods inherited from class org.vmdb.hl7.HL7Object

getRule

Methods inherited from class java.lang.Object

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

Constructor Detail

MSHSegment

public MSHSegment()

Construct an empty header segment.

MSHSegment

public MSHSegment(HL7SegmentContainer msgParent)

Construct an empty header segment, setting its containing message object.

Parameters:

msgParent - HL7Message object that contains this header. While declared as an HL7SegmentContainer for consistency with other segments, The parent of MSH is always a Message object rather than a loop.

Method Detail

getMessageName

public java.lang.String getMessageName()

The message name is a concatenation of the message type and version.

In the segment structure, these are held in two components of the message name field, but for display and importantly in the XML tag labels it is displayed with an underscore between the type and version. "ORU_R01"

Returns:

String representation of message type and version.

setMessageName

public void setMessageName(java.lang.String sMsgType,
                           java.lang.String sEventType,
                           java.lang.String sMsgStructure)

Set the message type and version.

This should be called automatically with no valid reason for the calling system to change it.
Message structure is often but not always name_event. Where messages for various events share structure, they use the first event.

Parameters:

sMsgType - String with message type abbreviation such as "ORU"

sEventType - String with message event such as "R01"

sMsgStructure - String with message event such as "ORU_R01"

toString

public java.lang.String toString()

Output segment as HL7. We have to override HL7Segment because the first two fields are so weird

Overrides:

toString in class HL7Segment

Returns:

String HL7 properly delimited.

setSeparators

public void setSeparators(java.lang.String sSeparators)

Set separators for the message and all its segments.

It is strongly suggested that you leave the default separator set as is. That said, HL7 does allow different separators so this is how they can be set. This method is also used within the package to set the default separators.

Overrides:

setSeparators in class HL7Object

Parameters:

sSeparators - string with separators.

setSendingFacility

public void setSendingFacility(java.lang.String sName)

Set the sending facility.

This version takes only the facility ID

Parameters:

sName - Facility name as listed by VMDB

setSendingFacility

public void setSendingFacility(HDElement hdFacility)

Set the sending facility.

This version takes a full HD element (mainly for copying)

setSendingFacility

public void setSendingFacility(java.lang.String sName,
                               java.lang.String sId)

Set the sending facility.

This version takes only the facility ID

Parameters:

sName - Facility name as listed by VMDB

setSendingFacility

public void setSendingFacility(java.lang.String sNamespaceId,
                               java.lang.String sId,
                               java.lang.String sIdType)

Set the sending facility.

This version takes the fully qualified HD elements

getSendingFacility

public HDElement getSendingFacility()

Get the sending facility as the complete HDElement.

Returns:

HDElement with sending facility

getSendingFacilityName

public java.lang.String getSendingFacilityName()

Get just the namespace id of the sending facility, the text string for the facility name in this case.

Returns:

String with id

getSendingFacilityId

public java.lang.String getSendingFacilityId()

Get just the universal id of the sending facility, the VMDB identifier in this case.

Returns:

String with id

setReceivingFacility

public void setReceivingFacility(java.lang.String sName)

Set the Receiving facility.

This version takes only the facility ID

Parameters:

sName - Facility name as listed by VMDB

setReceivingFacility

public void setReceivingFacility(java.lang.String sName,
                                 java.lang.String sId)

Set the Receiving facility.

This version takes only the facility ID

Parameters:

sName - Facility name as listed by VMDB

setReceivingFacility

public void setReceivingFacility(HDElement hdFacility)

Set the sending facility.

This version takes a full HD element (mainly for copying)

setReceivingFacility

public void setReceivingFacility(java.lang.String sNamespaceId,
                                 java.lang.String sId,
                                 java.lang.String sIdType)

Set the Receiving facility.

This version takes the fully qualified HD elements

getReceivingFacility

public HDElement getReceivingFacility()

Get the Receiving facility as the complete HDElement.

Returns:

HDElement with Receiving facility

getReceivingFacilityName

public java.lang.String getReceivingFacilityName()

Get just the namespace id of the Receiving facility, the text string for the facility name in this case.

Returns:

String with id

getReceivingFacilityId

public java.lang.String getReceivingFacilityId()

Get just the universal id of the Receiving facility, the VMDB identifier in this case.

Returns:

String with id

setMessageDateTime

public void setMessageDateTime()

Set the date/time of the message to the time now.

setMessageDateTime

public void setMessageDateTime(java.lang.String sDateTime)

Set the date/time of the message to string formatted date/time.

Parameters:

sDateTime - String with date/time in yyyyMMddHHmmss format

getMessageDateTime

public java.lang.String getMessageDateTime()

Get the date/time as a string.

Returns:

String date/time

setMessageControlId

public void setMessageControlId(java.lang.String sMessageControlId)

Set the message control ID.

This identifier is used to uniquely identify this message in returned acknowlegements, etc.

Parameters:

sMessageControlId - a String up to 20 characters usually a random unique sequence.

getMessageControlId

public java.lang.String getMessageControlId()

Get the message control ID as a string.

Returns:

String

setProcessingId

public void setProcessingId(java.lang.String sProcessingId)

Set the processing ID.

This version just the id string

setProcessingMode

public void setProcessingMode(java.lang.String sProcessingMode)

Set the processing mode.

This version takes just the mode string

Parameters:

sProcessingMode - A-archive, R-restore from archive, I-initial load (default) T-current processing.

setProcessingId

public void setProcessingId(java.lang.String sProcessingId,
                            java.lang.String sProcessingMode)

Set the processing ID from the individual components of a PT Element

Parameters:

sProcessingMode - A-archive, R-restore from archive, I-initial load (default) T-current processing.

getProcessingIdElement

public PTElement getProcessingIdElement()

Get the processing Id as PT Element.

Returns:

PTElement with sending facility

getProcessingId

public java.lang.String getProcessingId()

Get just the processing Id

Returns:

String with id

getProcessingMode

public java.lang.String getProcessingMode()

Get just the processing mode.

Returns:

String with mode

setVersionId

public void setVersionId(java.lang.String sVersionId)

Set the HL7 Version number.

You don't want to do this because it will be wrong if not the constant included here. But there may be future exceptions.

Parameters:

sVersionId - String with version number

getVersionId

public java.lang.String getVersionId()

Get the HL7 Version number.

Returns:

sVersionId String with version number