Package ca.uhn.hl7v2.model.v23.message

Class DSR_Q01

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractGroup
ca.uhn.hl7v2.model.AbstractMessage
ca.uhn.hl7v2.model.v23.message.DSR_Q01
All Implemented Interfaces:
Group, Message, Structure, Visitable, Serializable
public class DSR_Q01 extends AbstractMessage

Represents a DSR_Q01 message structure (see chapter ?). This structure contains the following elements:

  • 1: MSH (Message header segment)
  • 2: MSA (Message acknowledgement segment)
  • 3: ERR (Error segment) optional
  • 4: QAK (Query Acknowledgement) optional
  • 5: QRD (Query definition segment)
  • 6: QRF (Query filter segment) optional
  • 7: DSP (Display data segment) repeating
  • 8: DSC (Continuation pointer segment) optional
See Also:

  • Constructor Details

    • DSR_Q01

      public DSR_Q01()
      Creates a new DSR_Q01 message with DefaultModelClassFactory.

    • DSR_Q01

      public DSR_Q01(ModelClassFactory factory)
      Creates a new DSR_Q01 message with custom ModelClassFactory.

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.3"
      Specified by:
      getVersion in interface Message
      Overrides:
      getVersion in class AbstractMessage

    • getMSH

      public MSH getMSH()

      Returns MSH (Message header segment) - creates it if necessary

    • getMSA

      public MSA getMSA()

      Returns MSA (Message acknowledgement segment) - creates it if necessary

    • getERR

      public ERR getERR()

      Returns ERR (Error segment) - creates it if necessary

    • getQAK

      public QAK getQAK()

      Returns QAK (Query Acknowledgement) - creates it if necessary

    • getQRD

      public QRD getQRD()

      Returns QRD (Query definition segment) - creates it if necessary

    • getQRF

      public QRF getQRF()

      Returns QRF (Query filter segment) - creates it if necessary

    • getDSP

      public DSP getDSP()

      Returns the first repetition of DSP (Display data segment) - creates it if necessary

    • getDSP

      public DSP getDSP(int rep)

      Returns a specific repetition of DSP (Display data segment) - creates it if necessary

      Parameters:
      rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
      Throws:
      HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

    • getDSPReps

      public int getDSPReps()

      Returns the number of existing repetitions of DSP

    • getDSPAll

      public List<DSP> getDSPAll() throws HL7Exception

      Returns a non-modifiable List containing all current existing repetitions of DSP.

      Note that unlike getDSP(), this method will not create any reps if none are already present, so an empty list may be returned.

      Throws:
      HL7Exception

    • insertDSP

      public void insertDSP(DSP structure, int rep) throws HL7Exception

      Inserts a specific repetition of DSP (Display data segment)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertDSP

      public DSP insertDSP(int rep) throws HL7Exception

      Inserts a specific repetition of DSP (Display data segment)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeDSP

      public DSP removeDSP(int rep) throws HL7Exception

      Removes a specific repetition of DSP (Display data segment)

      Throws:
      HL7Exception
      See Also:

    • getDSC

      public DSC getDSC()

      Returns DSC (Continuation pointer segment) - creates it if necessary