Package ca.uhn.hl7v2.model.v251.message

Class RTB_Knn

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

Represents a RTB_Knn message structure (see chapter 5.3.2.4). This structure contains the following elements:

  • 1: MSH (Message Header)
  • 2: SFT (Software Segment) optional repeating
  • 3: MSA (Message Acknowledgment)
  • 4: ERR (Error) optional
  • 5: QAK (Query Acknowledgment)
  • 6: QPD (Query Parameter Definition)
  • 7: Hxx (any HL7 segment) optional
  • 8: Hxx (any HL7 segment) optional
  • 9: DSC (Continuation Pointer) optional
See Also:

  • Constructor Details

    • RTB_Knn

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

    • RTB_Knn

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

  • Method Details

    • getVersion

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

    • getMSH

      public MSH getMSH()

      Returns MSH (Message Header) - creates it if necessary

    • getSFT

      public SFT getSFT()

      Returns the first repetition of SFT (Software Segment) - creates it if necessary

    • getSFT

      public SFT getSFT(int rep)

      Returns a specific repetition of SFT (Software 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.

    • getSFTReps

      public int getSFTReps()

      Returns the number of existing repetitions of SFT

    • getSFTAll

      public List<SFT> getSFTAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertSFT

      public void insertSFT(SFT structure, int rep) throws HL7Exception

      Inserts a specific repetition of SFT (Software Segment)

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

    • insertSFT

      public SFT insertSFT(int rep) throws HL7Exception

      Inserts a specific repetition of SFT (Software Segment)

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

    • removeSFT

      public SFT removeSFT(int rep) throws HL7Exception

      Removes a specific repetition of SFT (Software Segment)

      Throws:
      HL7Exception
      See Also:

    • getMSA

      public MSA getMSA()

      Returns MSA (Message Acknowledgment) - creates it if necessary

    • getERR

      public ERR getERR()

      Returns ERR (Error) - creates it if necessary

    • getQAK

      public QAK getQAK()

      Returns QAK (Query Acknowledgment) - creates it if necessary

    • getQPD

      public QPD getQPD()

      Returns QPD (Query Parameter Definition) - creates it if necessary

    • getHxx

      public Hxx getHxx()

      Returns Hxx (any HL7 segment) - creates it if necessary

    • getHxx2

      public Hxx getHxx2()

      Returns Hxx2 (any HL7 segment) - creates it if necessary

    • getDSC

      public DSC getDSC()

      Returns DSC (Continuation Pointer) - creates it if necessary