Package ca.uhn.hl7v2.model.v251.group

Class MFR_M06_MF_QUERY

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractGroup
ca.uhn.hl7v2.model.v251.group.MFR_M06_MF_QUERY
All Implemented Interfaces:
Group, Structure, Visitable, Serializable
public class MFR_M06_MF_QUERY extends AbstractGroup

Represents a MFR_M06_MF_QUERY group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

  • 1: MFE (Master File Entry)
  • 2: CM0 (Clinical Study Master)
  • 3: CM1 (Clinical Study Phase Master) optional repeating
  • 4: CM2 (Clinical Study Schedule Master) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.5.1"

    • getMFE

      public MFE getMFE()
      Returns MFE (Master File Entry) - creates it if necessary

    • getCM0

      public CM0 getCM0()
      Returns CM0 (Clinical Study Master) - creates it if necessary

    • getCM1

      public CM1 getCM1()
      Returns the first repetition of CM1 (Clinical Study Phase Master) - creates it if necessary

    • getCM1

      public CM1 getCM1(int rep)
      Returns a specific repetition of CM1 (Clinical Study Phase Master) - 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.

    • getCM1Reps

      public int getCM1Reps()
      Returns the number of existing repetitions of CM1

    • getCM1All

      public List<CM1> getCM1All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertCM1

      public void insertCM1(CM1 structure, int rep) throws HL7Exception
      Inserts a specific repetition of CM1 (Clinical Study Phase Master)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertCM1

      public CM1 insertCM1(int rep) throws HL7Exception
      Inserts a specific repetition of CM1 (Clinical Study Phase Master)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeCM1

      public CM1 removeCM1(int rep) throws HL7Exception
      Removes a specific repetition of CM1 (Clinical Study Phase Master)
      Throws:
      HL7Exception
      See Also:

    • getCM2

      public CM2 getCM2()
      Returns the first repetition of CM2 (Clinical Study Schedule Master) - creates it if necessary

    • getCM2

      public CM2 getCM2(int rep)
      Returns a specific repetition of CM2 (Clinical Study Schedule Master) - 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.

    • getCM2Reps

      public int getCM2Reps()
      Returns the number of existing repetitions of CM2

    • getCM2All

      public List<CM2> getCM2All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertCM2

      public void insertCM2(CM2 structure, int rep) throws HL7Exception
      Inserts a specific repetition of CM2 (Clinical Study Schedule Master)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertCM2

      public CM2 insertCM2(int rep) throws HL7Exception
      Inserts a specific repetition of CM2 (Clinical Study Schedule Master)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeCM2

      public CM2 removeCM2(int rep) throws HL7Exception
      Removes a specific repetition of CM2 (Clinical Study Schedule Master)
      Throws:
      HL7Exception
      See Also: