MSH (HAPI - Java HL7 API - Generated Structures v2.1 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractSegment
  - - ca.uhn.hl7v2.model.v21.segment.MSH

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable
```
public class MSH
extends AbstractSegment
```
Represents an HL7 MSH message segment (MESSAGE HEADER). This segment has the following fields:
- MSH-1: FIELD SEPARATOR (ST)
- MSH-2: ENCODING CHARACTERS (ST)
- MSH-3: SENDING APPLICATION (ST) optional
- MSH-4: SENDING FACILITY (ST) optional
- MSH-5: RECEIVING APPLICATION (ST) optional
- MSH-6: RECEIVING FACILITY (ST) 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 (ID)
- MSH-12: VERSION ID (NM)
- MSH-13: SEQUENCE NUMBER (NM) optional
- MSH-14: CONTINUATION POINTER (ST) optional
See Also:

Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Type`	`createNewTypeWithoutReflection(int field)`
`ST`	`getCONTINUATIONPOINTER()` Returns MSH-14: "CONTINUATION POINTER" - 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
`ID`	`getMsh11_PROCESSINGID()` Returns MSH-11: "PROCESSING ID" - creates it if necessary
`NM`	`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
`ST`	`getMsh2_ENCODINGCHARACTERS()` Returns MSH-2: "ENCODING CHARACTERS" - creates it if necessary
`ST`	`getMsh3_SENDINGAPPLICATION()` Returns MSH-3: "SENDING APPLICATION" - creates it if necessary
`ST`	`getMsh4_SENDINGFACILITY()` Returns MSH-4: "SENDING FACILITY" - creates it if necessary
`ST`	`getMsh5_RECEIVINGAPPLICATION()` Returns MSH-5: "RECEIVING APPLICATION" - creates it if necessary
`ST`	`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
`ID`	`getPROCESSINGID()` Returns MSH-11: "PROCESSING ID" - creates it if necessary
`ST`	`getRECEIVINGAPPLICATION()` Returns MSH-5: "RECEIVING APPLICATION" - creates it if necessary
`ST`	`getRECEIVINGFACILITY()` Returns MSH-6: "RECEIVING FACILITY" - creates it if necessary
`ST`	`getSecurity()` Returns MSH-8: "Security" - creates it if necessary
`ST`	`getSENDINGAPPLICATION()` Returns MSH-3: "SENDING APPLICATION" - creates it if necessary
`ST`	`getSENDINGFACILITY()` Returns MSH-4: "SENDING FACILITY" - creates it if necessary
`NM`	`getSEQUENCENUMBER()` Returns MSH-13: "SEQUENCE NUMBER" - creates it if necessary
`NM`	`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 Detail
  - MSH
```
public MSH(Group parent,
           ModelClassFactory factory)
```
    Creates a new MSH segment
- Method Detail
  - 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 ST getSENDINGAPPLICATION()
```
    Returns MSH-3: "SENDING APPLICATION" - creates it if necessary
  - getMsh3_SENDINGAPPLICATION
```
public ST getMsh3_SENDINGAPPLICATION()
```
    Returns MSH-3: "SENDING APPLICATION" - creates it if necessary
  - getSENDINGFACILITY
```
public ST getSENDINGFACILITY()
```
    Returns MSH-4: "SENDING FACILITY" - creates it if necessary
  - getMsh4_SENDINGFACILITY
```
public ST getMsh4_SENDINGFACILITY()
```
    Returns MSH-4: "SENDING FACILITY" - creates it if necessary
  - getRECEIVINGAPPLICATION
```
public ST getRECEIVINGAPPLICATION()
```
    Returns MSH-5: "RECEIVING APPLICATION" - creates it if necessary
  - getMsh5_RECEIVINGAPPLICATION
```
public ST getMsh5_RECEIVINGAPPLICATION()
```
    Returns MSH-5: "RECEIVING APPLICATION" - creates it if necessary
  - getRECEIVINGFACILITY
```
public ST getRECEIVINGFACILITY()
```
    Returns MSH-6: "RECEIVING FACILITY" - creates it if necessary
  - getMsh6_RECEIVINGFACILITY
```
public ST 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 ID getPROCESSINGID()
```
    Returns MSH-11: "PROCESSING ID" - creates it if necessary
  - getMsh11_PROCESSINGID
```
public ID getMsh11_PROCESSINGID()
```
    Returns MSH-11: "PROCESSING ID" - creates it if necessary
  - getVERSIONID
```
public NM getVERSIONID()
```
    Returns MSH-12: "VERSION ID" - creates it if necessary
  - getMsh12_VERSIONID
```
public NM 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
  - createNewTypeWithoutReflection
```
protected Type createNewTypeWithoutReflection(int field)
```
    Overrides:
    
    createNewTypeWithoutReflection in class AbstractSegment

Class MSH

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MSH

Method Detail

getFIELDSEPARATOR

getMsh1_FIELDSEPARATOR

getENCODINGCHARACTERS

getMsh2_ENCODINGCHARACTERS

getSENDINGAPPLICATION

getMsh3_SENDINGAPPLICATION

getSENDINGFACILITY

getMsh4_SENDINGFACILITY

getRECEIVINGAPPLICATION

getMsh5_RECEIVINGAPPLICATION

getRECEIVINGFACILITY

getMsh6_RECEIVINGFACILITY

getDATETIMEOFMESSAGE

getMsh7_DATETIMEOFMESSAGE

getSecurity

getMsh8_Security

getMESSAGETYPE

getMsh9_MESSAGETYPE

getMESSAGECONTROLID

getMsh10_MESSAGECONTROLID

getPROCESSINGID

getMsh11_PROCESSINGID

getVERSIONID

getMsh12_VERSIONID

getSEQUENCENUMBER

getMsh13_SEQUENCENUMBER

getCONTINUATIONPOINTER

getMsh14_CONTINUATIONPOINTER

createNewTypeWithoutReflection