Package ca.uhn.hl7v2.model.v22.segment

Class MFE

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v22.segment.MFE
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class MFE extends AbstractSegment

Represents an HL7 MFE message segment (MASTER FILE ENTRY). This segment has the following fields:

  • MFE-1: Record-level event code (ID)
  • MFE-2: MFN control ID (ST) optional
  • MFE-3: Effective date / time (TS) optional
  • MFE-4: Primary key value (CE) repeating
See Also:

  • Constructor Details

  • Method Details

    • getRecordLevelEventCode

      public ID getRecordLevelEventCode()
      Returns MFE-1: "Record-level event code" - creates it if necessary

    • getMfe1_RecordLevelEventCode

      public ID getMfe1_RecordLevelEventCode()
      Returns MFE-1: "Record-level event code" - creates it if necessary

    • getMFNControlID

      public ST getMFNControlID()
      Returns MFE-2: "MFN control ID" - creates it if necessary

    • getMfe2_MFNControlID

      public ST getMfe2_MFNControlID()
      Returns MFE-2: "MFN control ID" - creates it if necessary

    • getEffectiveDateTime

      public TS getEffectiveDateTime()
      Returns MFE-3: "Effective date / time" - creates it if necessary

    • getMfe3_EffectiveDateTime

      public TS getMfe3_EffectiveDateTime()
      Returns MFE-3: "Effective date / time" - creates it if necessary

    • getPrimaryKeyValue

      public CE[] getPrimaryKeyValue()
      Returns all repetitions of Primary key value (MFE-4).

    • getMfe4_PrimaryKeyValue

      public CE[] getMfe4_PrimaryKeyValue()
      Returns all repetitions of Primary key value (MFE-4).

    • getPrimaryKeyValueReps

      public int getPrimaryKeyValueReps()
      Returns a count of the current number of repetitions of Primary key value (MFE-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getPrimaryKeyValue

      public CE getPrimaryKeyValue(int rep)
      Returns a specific repetition of MFE-4: "Primary key value" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getMfe4_PrimaryKeyValue

      public CE getMfe4_PrimaryKeyValue(int rep)
      Returns a specific repetition of MFE-4: "Primary key value" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getMfe4_PrimaryKeyValueReps

      public int getMfe4_PrimaryKeyValueReps()
      Returns a count of the current number of repetitions of Primary key value (MFE-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertPrimaryKeyValue

      public CE insertPrimaryKeyValue(int rep) throws HL7Exception
      Inserts a repetition of MFE-4: "Primary key value" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertMfe4_PrimaryKeyValue

      public CE insertMfe4_PrimaryKeyValue(int rep) throws HL7Exception
      Inserts a repetition of MFE-4: "Primary key value" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removePrimaryKeyValue

      public CE removePrimaryKeyValue(int rep) throws HL7Exception
      Removes a repetition of MFE-4: "Primary key value" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeMfe4_PrimaryKeyValue

      public CE removeMfe4_PrimaryKeyValue(int rep) throws HL7Exception
      Removes a repetition of MFE-4: "Primary key value" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment