Package ca.uhn.hl7v2.model.v23.segment

Class MSH

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v23.segment.MSH

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class MSH
extends AbstractSegment

Represents an HL7 MSH message segment (Message header segment). This segment has the following fields:

• MSH-1: Field Separator (ST)
• MSH-2: Encoding Characters (ST)
• MSH-3: Sending Application (HD) optional
• MSH-4: Sending Facility (HD) optional
• MSH-5: Receiving Application (HD) optional
• MSH-6: Receiving Facility (HD) optional
• MSH-7: Date / Time of Message (TS) optional
• MSH-8: Security (ST) optional
• MSH-9: Message Type (CM_MSG)
• MSH-10: Message Control ID (ST)
• MSH-11: Processing ID (PT)
• MSH-12: Version ID (ID)
• MSH-13: Sequence Number (NM) optional
• MSH-14: Continuation Pointer (ST) optional
• MSH-15: Accept Acknowledgement Type (ID) optional
• MSH-16: Application Acknowledgement Type (ID) optional
• MSH-17: Country Code (ID) optional
• MSH-18: Character Set (ID) optional
• MSH-19: Principal Language of Message (CE) optional

See Also:

• Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor	Description
MSH(Group parent, ModelClassFactory factory)	Creates a new MSH segment

Method Summary

Modifier and Type	Method	Description
protected Type	createNewTypeWithoutReflection(int field)
ID	getAcceptAcknowledgementType()	Returns MSH-15: "Accept Acknowledgement Type" - creates it if necessary
ID	getApplicationAcknowledgementType()	Returns MSH-16: "Application Acknowledgement Type" - creates it if necessary
ID	getCharacterSet()	Returns MSH-18: "Character Set" - creates it if necessary
ST	getContinuationPointer()	Returns MSH-14: "Continuation Pointer" - creates it if necessary
ID	getCountryCode()	Returns MSH-17: "Country Code" - creates it if necessary
TS	getDateTimeOfMessage()	Returns MSH-7: "Date / Time of Message" - creates it if necessary
ST	getEncodingCharacters()	Returns MSH-2: "Encoding Characters" - creates it if necessary
ST	getFieldSeparator()	Returns MSH-1: "Field Separator" - creates it if necessary
ST	getMessageControlID()	Returns MSH-10: "Message Control ID" - creates it if necessary
CM_MSG	getMessageType()	Returns MSH-9: "Message Type" - creates it if necessary
ST	getMsh1_FieldSeparator()	Returns MSH-1: "Field Separator" - creates it if necessary
ST	getMsh10_MessageControlID()	Returns MSH-10: "Message Control ID" - creates it if necessary
PT	getMsh11_ProcessingID()	Returns MSH-11: "Processing ID" - creates it if necessary
ID	getMsh12_VersionID()	Returns MSH-12: "Version ID" - creates it if necessary
NM	getMsh13_SequenceNumber()	Returns MSH-13: "Sequence Number" - creates it if necessary
ST	getMsh14_ContinuationPointer()	Returns MSH-14: "Continuation Pointer" - creates it if necessary
ID	getMsh15_AcceptAcknowledgementType()	Returns MSH-15: "Accept Acknowledgement Type" - creates it if necessary
ID	getMsh16_ApplicationAcknowledgementType()	Returns MSH-16: "Application Acknowledgement Type" - creates it if necessary
ID	getMsh17_CountryCode()	Returns MSH-17: "Country Code" - creates it if necessary
ID	getMsh18_CharacterSet()	Returns MSH-18: "Character Set" - creates it if necessary
CE	getMsh19_PrincipalLanguageOfMessage()	Returns MSH-19: "Principal Language of Message" - creates it if necessary
ST	getMsh2_EncodingCharacters()	Returns MSH-2: "Encoding Characters" - creates it if necessary
HD	getMsh3_SendingApplication()	Returns MSH-3: "Sending Application" - creates it if necessary
HD	getMsh4_SendingFacility()	Returns MSH-4: "Sending Facility" - creates it if necessary
HD	getMsh5_ReceivingApplication()	Returns MSH-5: "Receiving Application" - creates it if necessary
HD	getMsh6_ReceivingFacility()	Returns MSH-6: "Receiving Facility" - creates it if necessary
TS	getMsh7_DateTimeOfMessage()	Returns MSH-7: "Date / Time of Message" - creates it if necessary
ST	getMsh8_Security()	Returns MSH-8: "Security" - creates it if necessary
CM_MSG	getMsh9_MessageType()	Returns MSH-9: "Message Type" - creates it if necessary
CE	getPrincipalLanguageOfMessage()	Returns MSH-19: "Principal Language of Message" - creates it if necessary
PT	getProcessingID()	Returns MSH-11: "Processing ID" - creates it if necessary
HD	getReceivingApplication()	Returns MSH-5: "Receiving Application" - creates it if necessary
HD	getReceivingFacility()	Returns MSH-6: "Receiving Facility" - creates it if necessary
ST	getSecurity()	Returns MSH-8: "Security" - creates it if necessary
HD	getSendingApplication()	Returns MSH-3: "Sending Application" - creates it if necessary
HD	getSendingFacility()	Returns MSH-4: "Sending Facility" - creates it if necessary
NM	getSequenceNumber()	Returns MSH-13: "Sequence Number" - creates it if necessary
ID	getVersionID()	Returns MSH-12: "Version ID" - creates it if necessary

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Details

MSH

public MSH(Group parent,
 ModelClassFactory factory)

Creates a new MSH segment

Method Details

getFieldSeparator

public ST getFieldSeparator()

Returns MSH-1: "Field Separator" - creates it if necessary

getMsh1_FieldSeparator

public ST getMsh1_FieldSeparator()

Returns MSH-1: "Field Separator" - creates it if necessary

getEncodingCharacters

public ST getEncodingCharacters()

Returns MSH-2: "Encoding Characters" - creates it if necessary

getMsh2_EncodingCharacters

public ST getMsh2_EncodingCharacters()

Returns MSH-2: "Encoding Characters" - creates it if necessary

getSendingApplication

public HD getSendingApplication()

Returns MSH-3: "Sending Application" - creates it if necessary

getMsh3_SendingApplication

public HD getMsh3_SendingApplication()

Returns MSH-3: "Sending Application" - creates it if necessary

getSendingFacility

public HD getSendingFacility()

Returns MSH-4: "Sending Facility" - creates it if necessary

getMsh4_SendingFacility

public HD getMsh4_SendingFacility()

Returns MSH-4: "Sending Facility" - creates it if necessary

getReceivingApplication

public HD getReceivingApplication()

Returns MSH-5: "Receiving Application" - creates it if necessary

getMsh5_ReceivingApplication

public HD getMsh5_ReceivingApplication()

Returns MSH-5: "Receiving Application" - creates it if necessary

getReceivingFacility

public HD getReceivingFacility()

Returns MSH-6: "Receiving Facility" - creates it if necessary

getMsh6_ReceivingFacility

public HD getMsh6_ReceivingFacility()

Returns MSH-6: "Receiving Facility" - creates it if necessary

getDateTimeOfMessage

public TS getDateTimeOfMessage()

Returns MSH-7: "Date / Time of Message" - creates it if necessary

getMsh7_DateTimeOfMessage

public TS getMsh7_DateTimeOfMessage()

Returns MSH-7: "Date / Time of Message" - creates it if necessary

getSecurity

public ST getSecurity()

Returns MSH-8: "Security" - creates it if necessary

getMsh8_Security

public ST getMsh8_Security()

Returns MSH-8: "Security" - creates it if necessary

getMessageType

public CM_MSG getMessageType()

Returns MSH-9: "Message Type" - creates it if necessary

getMsh9_MessageType

public CM_MSG getMsh9_MessageType()

Returns MSH-9: "Message Type" - creates it if necessary

getMessageControlID

public ST getMessageControlID()

Returns MSH-10: "Message Control ID" - creates it if necessary

getMsh10_MessageControlID

public ST getMsh10_MessageControlID()

Returns MSH-10: "Message Control ID" - creates it if necessary

getProcessingID

public PT getProcessingID()

Returns MSH-11: "Processing ID" - creates it if necessary

getMsh11_ProcessingID

public PT getMsh11_ProcessingID()

Returns MSH-11: "Processing ID" - creates it if necessary

getVersionID

public ID getVersionID()

Returns MSH-12: "Version ID" - creates it if necessary

getMsh12_VersionID

public ID getMsh12_VersionID()

Returns MSH-12: "Version ID" - creates it if necessary

getSequenceNumber

public NM getSequenceNumber()

Returns MSH-13: "Sequence Number" - creates it if necessary

getMsh13_SequenceNumber

public NM getMsh13_SequenceNumber()

Returns MSH-13: "Sequence Number" - creates it if necessary

getContinuationPointer

public ST getContinuationPointer()

Returns MSH-14: "Continuation Pointer" - creates it if necessary

getMsh14_ContinuationPointer

public ST getMsh14_ContinuationPointer()

Returns MSH-14: "Continuation Pointer" - creates it if necessary

getAcceptAcknowledgementType

public ID getAcceptAcknowledgementType()

Returns MSH-15: "Accept Acknowledgement Type" - creates it if necessary

getMsh15_AcceptAcknowledgementType

public ID getMsh15_AcceptAcknowledgementType()

Returns MSH-15: "Accept Acknowledgement Type" - creates it if necessary

getApplicationAcknowledgementType

public ID getApplicationAcknowledgementType()

Returns MSH-16: "Application Acknowledgement Type" - creates it if necessary

getMsh16_ApplicationAcknowledgementType

public ID getMsh16_ApplicationAcknowledgementType()

Returns MSH-16: "Application Acknowledgement Type" - creates it if necessary

getCountryCode

public ID getCountryCode()

Returns MSH-17: "Country Code" - creates it if necessary

getMsh17_CountryCode

public ID getMsh17_CountryCode()

Returns MSH-17: "Country Code" - creates it if necessary

getCharacterSet

public ID getCharacterSet()

Returns MSH-18: "Character Set" - creates it if necessary

getMsh18_CharacterSet

public ID getMsh18_CharacterSet()

Returns MSH-18: "Character Set" - creates it if necessary

getPrincipalLanguageOfMessage

public CE getPrincipalLanguageOfMessage()

Returns MSH-19: "Principal Language of Message" - creates it if necessary

getMsh19_PrincipalLanguageOfMessage

public CE getMsh19_PrincipalLanguageOfMessage()

Returns MSH-19: "Principal Language of Message" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment