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

Class DOC_T12

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

Represents a DOC_T12 message structure (see chapter 9.8.1). This structure contains the following elements:

  • 1: MSH (Message Header)
  • 2: MSA (Message Acknowledgment)
  • 3: ERR (Error) optional
  • 4: QAK (Query Acknowledgment) optional
  • 5: QRD (Original-Style Query Definition)
  • 6: DOC_T12_RESULT (a Group object) repeating
  • 7: DSC (Continuation Pointer) optional
See Also:

  • Constructor Details

    • DOC_T12

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

    • DOC_T12

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

    • 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

    • getQRD

      public QRD getQRD()

      Returns QRD (Original-Style Query Definition) - creates it if necessary

    • getRESULT

      public DOC_T12_RESULT getRESULT()

      Returns the first repetition of RESULT (a Group object) - creates it if necessary

    • getRESULT

      public DOC_T12_RESULT getRESULT(int rep)

      Returns a specific repetition of RESULT (a Group object) - 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.

    • getRESULTReps

      public int getRESULTReps()

      Returns the number of existing repetitions of RESULT

    • getRESULTAll

      public List<DOC_T12_RESULT> getRESULTAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertRESULT

      public void insertRESULT(DOC_T12_RESULT structure, int rep) throws HL7Exception

      Inserts a specific repetition of RESULT (a Group object)

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

    • insertRESULT

      public DOC_T12_RESULT insertRESULT(int rep) throws HL7Exception

      Inserts a specific repetition of RESULT (a Group object)

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

    • removeRESULT

      public DOC_T12_RESULT removeRESULT(int rep) throws HL7Exception

      Removes a specific repetition of RESULT (a Group object)

      Throws:
      HL7Exception
      See Also:

    • getDSC

      public DSC getDSC()

      Returns DSC (Continuation Pointer) - creates it if necessary