public class MSH extends AbstractSegment
Represents an HL7 MSH message segment (Message Header). This segment has the following fields:
log
Constructor and Description |
---|
MSH(Group parent,
ModelClassFactory factory)
Creates a new MSH segment
|
Modifier and Type | Method and Description |
---|---|
protected Type |
createNewTypeWithoutReflection(int field) |
ID |
getAcceptAcknowledgmentType()
Returns
MSH-15: "Accept Acknowledgment Type" - creates it if necessary
|
ID |
getAlternateCharacterSetHandlingScheme()
Returns
MSH-20: "Alternate Character Set Handling Scheme" - creates it if necessary
|
ID |
getApplicationAcknowledgmentType()
Returns
MSH-16: "Application Acknowledgment Type" - creates it if necessary
|
ID[] |
getCharacterSet()
Returns all repetitions of Character Set (MSH-18).
|
ID |
getCharacterSet(int rep)
Returns a specific repetition of
MSH-18: "Character Set" - creates it if necessary
|
int |
getCharacterSetReps()
Returns a count of the current number of repetitions of Character Set (MSH-18).
|
ST |
getContinuationPointer()
Returns
MSH-14: "Continuation Pointer" - creates it if necessary
|
ID |
getCountryCode()
Returns
MSH-17: "Country Code" - creates it if necessary
|
DTM |
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
|
EI[] |
getMessageProfileIdentifier()
Returns all repetitions of Message Profile Identifier (MSH-21).
|
EI |
getMessageProfileIdentifier(int rep)
Returns a specific repetition of
MSH-21: "Message Profile Identifier" - creates it if necessary
|
int |
getMessageProfileIdentifierReps()
Returns a count of the current number of repetitions of Message Profile Identifier (MSH-21).
|
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
|
VID |
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_AcceptAcknowledgmentType()
Returns
MSH-15: "Accept Acknowledgment Type" - creates it if necessary
|
ID |
getMsh16_ApplicationAcknowledgmentType()
Returns
MSH-16: "Application Acknowledgment Type" - creates it if necessary
|
ID |
getMsh17_CountryCode()
Returns
MSH-17: "Country Code" - creates it if necessary
|
ID[] |
getMsh18_CharacterSet()
Returns all repetitions of Character Set (MSH-18).
|
ID |
getMsh18_CharacterSet(int rep)
Returns a specific repetition of
MSH-18: "Character Set" - creates it if necessary
|
int |
getMsh18_CharacterSetReps()
Returns a count of the current number of repetitions of Character Set (MSH-18).
|
CWE |
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
|
ID |
getMsh20_AlternateCharacterSetHandlingScheme()
Returns
MSH-20: "Alternate Character Set Handling Scheme" - creates it if necessary
|
EI[] |
getMsh21_MessageProfileIdentifier()
Returns all repetitions of Message Profile Identifier (MSH-21).
|
EI |
getMsh21_MessageProfileIdentifier(int rep)
Returns a specific repetition of
MSH-21: "Message Profile Identifier" - creates it if necessary
|
int |
getMsh21_MessageProfileIdentifierReps()
Returns a count of the current number of repetitions of Message Profile Identifier (MSH-21).
|
XON |
getMsh22_SendingResponsibleOrganization()
Returns
MSH-22: "Sending Responsible Organization" - creates it if necessary
|
XON |
getMsh23_ReceivingResponsibleOrganization()
Returns
MSH-23: "Receiving Responsible Organization" - creates it if necessary
|
HD |
getMsh24_SendingNetworkAddress()
Returns
MSH-24: "Sending Network Address" - creates it if necessary
|
HD |
getMsh25_ReceivingNetworkAddress()
Returns
MSH-25: "Receiving Network Address" - 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
|
DTM |
getMsh7_DateTimeOfMessage()
Returns
MSH-7: "Date/Time of Message" - creates it if necessary
|
ST |
getMsh8_Security()
Returns
MSH-8: "Security" - creates it if necessary
|
MSG |
getMsh9_MessageType()
Returns
MSH-9: "Message Type" - creates it if necessary
|
CWE |
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
|
HD |
getReceivingNetworkAddress()
Returns
MSH-25: "Receiving Network Address" - creates it if necessary
|
XON |
getReceivingResponsibleOrganization()
Returns
MSH-23: "Receiving Responsible Organization" - 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
|
HD |
getSendingNetworkAddress()
Returns
MSH-24: "Sending Network Address" - creates it if necessary
|
XON |
getSendingResponsibleOrganization()
Returns
MSH-22: "Sending Responsible Organization" - creates it if necessary
|
NM |
getSequenceNumber()
Returns
MSH-13: "Sequence Number" - creates it if necessary
|
VID |
getVersionID()
Returns
MSH-12: "Version ID" - creates it if necessary
|
ID |
insertCharacterSet(int rep)
Inserts a repetition of
MSH-18: "Character Set" at a specific index
|
EI |
insertMessageProfileIdentifier(int rep)
Inserts a repetition of
MSH-21: "Message Profile Identifier" at a specific index
|
ID |
insertMsh18_CharacterSet(int rep)
Inserts a repetition of
MSH-18: "Character Set" at a specific index
|
EI |
insertMsh21_MessageProfileIdentifier(int rep)
Inserts a repetition of
MSH-21: "Message Profile Identifier" at a specific index
|
ID |
removeCharacterSet(int rep)
Removes a repetition of
MSH-18: "Character Set" at a specific index
|
EI |
removeMessageProfileIdentifier(int rep)
Removes a repetition of
MSH-21: "Message Profile Identifier" at a specific index
|
ID |
removeMsh18_CharacterSet(int rep)
Removes a repetition of
MSH-18: "Character Set" at a specific index
|
EI |
removeMsh21_MessageProfileIdentifier(int rep)
Removes a repetition of
MSH-21: "Message Profile Identifier" at a specific index
|
accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition
getMessage, getParent
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMessage, getParent
public MSH(Group parent, ModelClassFactory factory)
public ST getFieldSeparator()
public ST getMsh1_FieldSeparator()
public ST getEncodingCharacters()
public ST getMsh2_EncodingCharacters()
public HD getSendingApplication()
public HD getMsh3_SendingApplication()
public HD getSendingFacility()
public HD getMsh4_SendingFacility()
public HD getReceivingApplication()
public HD getMsh5_ReceivingApplication()
public HD getReceivingFacility()
public HD getMsh6_ReceivingFacility()
public DTM getDateTimeOfMessage()
public DTM getMsh7_DateTimeOfMessage()
public ST getSecurity()
public ST getMsh8_Security()
public MSG getMessageType()
public MSG getMsh9_MessageType()
public ST getMessageControlID()
public ST getMsh10_MessageControlID()
public PT getProcessingID()
public PT getMsh11_ProcessingID()
public VID getVersionID()
public VID getMsh12_VersionID()
public NM getSequenceNumber()
public NM getMsh13_SequenceNumber()
public ST getContinuationPointer()
public ST getMsh14_ContinuationPointer()
public ID getAcceptAcknowledgmentType()
public ID getMsh15_AcceptAcknowledgmentType()
public ID getApplicationAcknowledgmentType()
public ID getMsh16_ApplicationAcknowledgmentType()
public ID getCountryCode()
public ID getMsh17_CountryCode()
public ID[] getCharacterSet()
public ID[] getMsh18_CharacterSet()
public int getCharacterSetReps()
public ID getCharacterSet(int rep)
rep
- The repetition index (0-indexed)public ID getMsh18_CharacterSet(int rep)
rep
- The repetition index (0-indexed)public int getMsh18_CharacterSetReps()
public ID insertCharacterSet(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public ID insertMsh18_CharacterSet(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public ID removeCharacterSet(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public ID removeMsh18_CharacterSet(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public CWE getPrincipalLanguageOfMessage()
public CWE getMsh19_PrincipalLanguageOfMessage()
public ID getAlternateCharacterSetHandlingScheme()
public ID getMsh20_AlternateCharacterSetHandlingScheme()
public EI[] getMessageProfileIdentifier()
public EI[] getMsh21_MessageProfileIdentifier()
public int getMessageProfileIdentifierReps()
public EI getMessageProfileIdentifier(int rep)
rep
- The repetition index (0-indexed)public EI getMsh21_MessageProfileIdentifier(int rep)
rep
- The repetition index (0-indexed)public int getMsh21_MessageProfileIdentifierReps()
public EI insertMessageProfileIdentifier(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public EI insertMsh21_MessageProfileIdentifier(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public EI removeMessageProfileIdentifier(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public EI removeMsh21_MessageProfileIdentifier(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XON getSendingResponsibleOrganization()
public XON getMsh22_SendingResponsibleOrganization()
public XON getReceivingResponsibleOrganization()
public XON getMsh23_ReceivingResponsibleOrganization()
public HD getSendingNetworkAddress()
public HD getMsh24_SendingNetworkAddress()
public HD getReceivingNetworkAddress()
public HD getMsh25_ReceivingNetworkAddress()
protected Type createNewTypeWithoutReflection(int field)
createNewTypeWithoutReflection
in class AbstractSegment
Copyright © 2001–2017 University Health Network. All rights reserved.