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

Class MFA

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

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

  • MFA-1: Record-level event code (ID)
  • MFA-2: MFN control ID (ST) optional
  • MFA-3: Event completion date / time (TS) optional
  • MFA-4: Error return code and/or text (CE)
  • MFA-5: Primary key value (CE) repeating
See Also:

  • Constructor Details

  • Method Details

    • getRecordLevelEventCode

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

    • getMfa1_RecordLevelEventCode

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

    • getMFNControlID

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

    • getMfa2_MFNControlID

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

    • getEventCompletionDateTime

      public TS getEventCompletionDateTime()
      Returns MFA-3: "Event completion date / time" - creates it if necessary

    • getMfa3_EventCompletionDateTime

      public TS getMfa3_EventCompletionDateTime()
      Returns MFA-3: "Event completion date / time" - creates it if necessary

    • getErrorReturnCodeAndOrText

      public CE getErrorReturnCodeAndOrText()
      Returns MFA-4: "Error return code and/or text" - creates it if necessary

    • getMfa4_ErrorReturnCodeAndOrText

      public CE getMfa4_ErrorReturnCodeAndOrText()
      Returns MFA-4: "Error return code and/or text" - creates it if necessary

    • getPrimaryKeyValue

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

    • getMfa5_PrimaryKeyValue

      public CE[] getMfa5_PrimaryKeyValue()
      Returns all repetitions of Primary key value (MFA-5).

    • getPrimaryKeyValueReps

      public int getPrimaryKeyValueReps()
      Returns a count of the current number of repetitions of Primary key value (MFA-5). 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 MFA-5: "Primary key value" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getMfa5_PrimaryKeyValue

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

    • getMfa5_PrimaryKeyValueReps

      public int getMfa5_PrimaryKeyValueReps()
      Returns a count of the current number of repetitions of Primary key value (MFA-5). 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 MFA-5: "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)

    • insertMfa5_PrimaryKeyValue

      public CE insertMfa5_PrimaryKeyValue(int rep) throws HL7Exception
      Inserts a repetition of MFA-5: "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 MFA-5: "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)

    • removeMfa5_PrimaryKeyValue

      public CE removeMfa5_PrimaryKeyValue(int rep) throws HL7Exception
      Removes a repetition of MFA-5: "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