Package ca.uhn.hl7v2.model.v24.message

Class MFR_M01

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

Represents a MFR_M01 message structure (see chapter 8). 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: QRF (Original Style Query Filter) optional
  • 7: MFI (Master File Identification)
  • 8: MFR_M01_MF_QUERY (a Group object) repeating
  • 9: DSC (Continuation Pointer) optional
See Also:

  • Constructor Details

    • MFR_M01

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

    • MFR_M01

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

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.4"
      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

    • getQRF

      public QRF getQRF()

      Returns QRF (Original Style Query Filter) - creates it if necessary

    • getMFI

      public MFI getMFI()

      Returns MFI (Master File Identification) - creates it if necessary

    • getMF_QUERY

      public MFR_M01_MF_QUERY getMF_QUERY()

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

    • getMF_QUERY

      public MFR_M01_MF_QUERY getMF_QUERY(int rep)

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

    • getMF_QUERYReps

      public int getMF_QUERYReps()

      Returns the number of existing repetitions of MF_QUERY

    • getMF_QUERYAll

      public List<MFR_M01_MF_QUERY> getMF_QUERYAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertMF_QUERY

      public void insertMF_QUERY(MFR_M01_MF_QUERY structure, int rep) throws HL7Exception

      Inserts a specific repetition of MF_QUERY (a Group object)

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

    • insertMF_QUERY

      public MFR_M01_MF_QUERY insertMF_QUERY(int rep) throws HL7Exception

      Inserts a specific repetition of MF_QUERY (a Group object)

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

    • removeMF_QUERY

      public MFR_M01_MF_QUERY removeMF_QUERY(int rep) throws HL7Exception

      Removes a specific repetition of MF_QUERY (a Group object)

      Throws:
      HL7Exception
      See Also:

    • getDSC

      public DSC getDSC()

      Returns DSC (Continuation Pointer) - creates it if necessary