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

Class RSP_K23

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

Represents a RSP_K23 message structure (see chapter 3.3.58). 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: RSP_K23_QUERY_RESPONSE (a Group object) optional
  • 8: DSC (Continuation Pointer) optional
See Also:

  • Constructor Details

    • RSP_K23

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

    • RSP_K23

      public RSP_K23(ModelClassFactory factory)
      Creates a new RSP_K23 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

    • getQUERY_RESPONSE

      public RSP_K23_QUERY_RESPONSE getQUERY_RESPONSE()

      Returns QUERY_RESPONSE (a Group object) - creates it if necessary

    • getDSC

      public DSC getDSC()

      Returns DSC (Continuation Pointer) - creates it if necessary