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

Class MFN_M01

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

Represents a MFN_M01 message structure (see chapter 8.4.1). This structure contains the following elements:

  • 1: MSH (Message Header)
  • 2: SFT (Software Segment) optional repeating
  • 3: MFI (Master File Identification)
  • 4: MFN_M01_MF (a Group object) repeating
See Also:

  • Constructor Details

    • MFN_M01

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

    • MFN_M01

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

    • getMFI

      public MFI getMFI()

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

    • getMF

      public MFN_M01_MF getMF()

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

    • getMF

      public MFN_M01_MF getMF(int rep)

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

    • getMFReps

      public int getMFReps()

      Returns the number of existing repetitions of MF

    • getMFAll

      public List<MFN_M01_MF> getMFAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertMF

      public void insertMF(MFN_M01_MF structure, int rep) throws HL7Exception

      Inserts a specific repetition of MF (a Group object)

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

    • insertMF

      public MFN_M01_MF insertMF(int rep) throws HL7Exception

      Inserts a specific repetition of MF (a Group object)

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

    • removeMF

      public MFN_M01_MF removeMF(int rep) throws HL7Exception

      Removes a specific repetition of MF (a Group object)

      Throws:
      HL7Exception
      See Also: