Package org.dellroad.hl7

Class MSHSegment

    • Constructor Detail

      • MSHSegment

        public MSHSegment​(HL7Seps seps)
        Constructor. This constructor initializes only MSH.1 and MSH.2.
        Parameters:
        seps - separator and escape characters for this message

      • MSHSegment

        public MSHSegment()
        Convenience constructor. Equivalent to:
        MSHSegment(HL7Seps.DEFAULT)

      • MSHSegment

        public MSHSegment​(MSHSegment msh)
        Copy constructor.
        Parameters:
        msh - MSH segment to copy

    • Method Detail

      • getSendingApplication

        public HL7Field getSendingApplication()
        Returns sending application from MSH.3.
        Returns:
        MSH.3, or null if there is none

      • setSendingApplication

        public void setSendingApplication​(HL7Field field)

      • getSendingFacility

        public HL7Field getSendingFacility()
        Returns sending facility from MSH.4.
        Returns:
        MSH.4, or null if there is none

      • setSendingFacility

        public void setSendingFacility​(HL7Field field)

      • getReceivingApplication

        public HL7Field getReceivingApplication()
        Returns receiving application from MSH.5.
        Returns:
        MSH.5, or null if there is none

      • setReceivingApplication

        public void setReceivingApplication​(HL7Field field)

      • getReceivingFacility

        public HL7Field getReceivingFacility()
        Returns receiving facility from MSH.6.
        Returns:
        MSH.6, or null if there is none

      • setReceivingFacility

        public void setReceivingFacility​(HL7Field field)

      • getTimestamp

        public HL7Field getTimestamp()
        Returns message timestamp from MSH.7.
        Returns:
        MSH.7, or null if there is none

      • setTimestamp

        public void setTimestamp​(HL7Field field)

      • getMessageType

        public HL7Field getMessageType()
        Returns message type from MSH.9.
        Returns:
        MSH.9, or null if there is none

      • setMessageType

        public void setMessageType​(HL7Field field)

      • getControlID

        public HL7Field getControlID()
        Returns control ID from MSH.10.
        Returns:
        MSH.10, or null if there is none

      • setControlID

        public void setControlID​(HL7Field field)

      • getProcessingID

        public HL7Field getProcessingID()
        Returns processing ID from MSH.11.
        Returns:
        MSH.11, or null if there is none

      • setProcessingID

        public void setProcessingID​(HL7Field field)

      • getVersionID

        public HL7Field getVersionID()
        Returns HL7 version from MSH.12.
        Returns:
        MSH.12, or null if there is none

      • setVersionID

        public void setVersionID​(HL7Field field)

      • getHL7Seps

        public HL7Seps getHL7Seps()
        Get the separator and escape characters defined by MSH.1 and MSH.2.
        Returns:
        HL7 separators

      • setHL7Seps

        public void setHL7Seps​(HL7Seps seps)
        Set MSH.1 and MSH.2 based on the provided separator and escape characters.
        Parameters:
        seps - HL7 separators

      • trimTo

        public void trimTo​(int size)
        This subclass version disallows trimming away MSH.1 or MSH.2.
        Overrides:
        trimTo in class HL7Segment
        Parameters:
        size - maximum number of fields
        Throws:
        IllegalArgumentException - if size is less than three

      • setField

        public void setField​(int index,
                     HL7Field field)
        This subclass version disallows setting MSH.1 or MSH.2 directly.
        Overrides:
        setField in class HL7Segment
        Parameters:
        index - index of the field in the segment (where zero is the segment name); must be at least one
        field - field to set
        Throws:
        IllegalArgumentException - if index is less than three
        IllegalArgumentException - if field is null

      • createACK

        public HL7Message createACK​(long serno)
                     throws HL7ContentException
        Create an acknowlegement message for this message.
        Parameters:
        serno - next local HL7 serial number
        Returns:
        an acknowlegement of this message
        Throws:
        HL7ContentException - if the required fields are not present in this instance

      • isACK

        public boolean isACK​(HL7Message ack)
              throws HL7ContentException
        Check whether the given message is an acknowlegement of this MSH.
        Parameters:
        ack - putative acknowlegement of this message
        Returns:
        true if ack is an acknowlegement of this MSH
        Throws:
        HL7ContentException - if the required fields are not present in this instance
        IllegalArgumentException - if ack is null

      • append

        public void append​(StringBuilder buf,
                   HL7Seps seps)
        Append string encoding of this segment to the provided buffer.

        This overridden version ensures that MSH.1 and MSH.2 are not escaped.

        Overrides:
        append in class HL7Segment
        Parameters:
        buf - string buffer
        seps - HL7 separator and escape characters

      • toString

        public String toString​(HL7Seps seps)
        Convert to a string using the provided separators.

        This overridden version ensures that MSH.1 and MSH.2 are consistent with seps in the generated string. This separators configured in this instance are not affected regardless.

        Overrides:
        toString in class HL7Segment
        Parameters:
        seps - HL7 separator and escape characters
        Returns:
        string form of this segment
        Throws:
        IllegalArgumentException - if seps is null