ca.uhn.hl7v2.model.v23.segment

Class MFE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v23.segment.MFE

All Implemented Interfaces:

Segment, Structure, Serializable

public class MFE
extends AbstractSegment

Represents an HL7 MFE message segment (Master file entry segment). 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:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
MFE(Group parent, ModelClassFactory factory) Creates a new MFE segment

Method Summary

Methods

Modifier and Type	Method and Description
protected Type	createNewTypeWithoutReflection(int field)
TS	getEffectiveDateTime() Returns MFE-3: "Effective Date/Time" - creates it if necessary
ID	getMfe1_RecordLevelEventCode() Returns MFE-1: "Record-Level Event Code" - creates it if necessary
ST	getMfe2_MFNControlID() Returns MFE-2: "MFN Control ID" - creates it if necessary
TS	getMfe3_EffectiveDateTime() Returns MFE-3: "Effective Date/Time" - creates it if necessary
CE[]	getMfe4_PrimaryKeyValue() Returns all repetitions of Primary Key Value (MFE-4).
CE	getMfe4_PrimaryKeyValue(int rep) Returns a specific repetition of MFE-4: "Primary Key Value" - creates it if necessary
int	getMfe4_PrimaryKeyValueReps() Returns a count of the current number of repetitions of Primary Key Value (MFE-4).
ST	getMFNControlID() Returns MFE-2: "MFN Control ID" - creates it if necessary
CE[]	getPrimaryKeyValue() Returns all repetitions of Primary Key Value (MFE-4).
CE	getPrimaryKeyValue(int rep) Returns a specific repetition of MFE-4: "Primary Key Value" - creates it if necessary
int	getPrimaryKeyValueReps() Returns a count of the current number of repetitions of Primary Key Value (MFE-4).
ID	getRecordLevelEventCode() Returns MFE-1: "Record-Level Event Code" - creates it if necessary
CE	insertMfe4_PrimaryKeyValue(int rep) Inserts a repetition of MFE-4: "Primary Key Value" at a specific index
CE	insertPrimaryKeyValue(int rep) Inserts a repetition of MFE-4: "Primary Key Value" at a specific index
CE	removeMfe4_PrimaryKeyValue(int rep) Removes a repetition of MFE-4: "Primary Key Value" at a specific index
CE	removePrimaryKeyValue(int rep) Removes a repetition of MFE-4: "Primary Key Value" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Detail

MFE

public MFE(Group parent,
   ModelClassFactory factory)

Creates a new MFE segment

Method Detail

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