ca.uhn.hl7v2.model.v24.segment
Class MRG

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.MRG

All Implemented Interfaces:

Segment, Structure, Serializable

public class MRG
extends AbstractSegment

Represents an HL7 MRG message segment (Merge patient information). This segment has the following fields:

• MRG-1: Prior Patient Identifier List (CX) repeating
• MRG-2: Prior Alternate Patient ID (CX) optional repeating
• MRG-3: Prior Patient Account Number (CX) optional
• MRG-4: Prior Patient ID (CX) optional
• MRG-5: Prior Visit Number (CX) optional
• MRG-6: Prior Alternate Visit ID (CX) optional
• MRG-7: Prior Patient Name (XPN) optional repeating

See Also:

Serialized Form

Constructor Summary

MRG(Group parent, ModelClassFactory factory)
Creates a new MRG segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
CX	getMrg1_PriorPatientIdentifierList(int rep) Returns a specific repetition of MRG-1: "Prior Patient Identifier List" - creates it if necessary
int	getMrg1_PriorPatientIdentifierListReps() Returns a count of the current number of repetitions of Prior Patient Identifier List (MRG-1).
CX	getMrg2_PriorAlternatePatientID(int rep) Returns a specific repetition of MRG-2: "Prior Alternate Patient ID" - creates it if necessary
int	getMrg2_PriorAlternatePatientIDReps() Returns a count of the current number of repetitions of Prior Alternate Patient ID (MRG-2).
CX	getMrg3_PriorPatientAccountNumber() Returns MRG-3: "Prior Patient Account Number" - creates it if necessary
CX	getMrg4_PriorPatientID() Returns MRG-4: "Prior Patient ID" - creates it if necessary
CX	getMrg5_PriorVisitNumber() Returns MRG-5: "Prior Visit Number" - creates it if necessary
CX	getMrg6_PriorAlternateVisitID() Returns MRG-6: "Prior Alternate Visit ID" - creates it if necessary
XPN	getMrg7_PriorPatientName(int rep) Returns a specific repetition of MRG-7: "Prior Patient Name" - creates it if necessary
int	getMrg7_PriorPatientNameReps() Returns a count of the current number of repetitions of Prior Patient Name (MRG-7).
CX[]	getPriorAlternatePatientID() Returns all repetitions of Prior Alternate Patient ID (MRG-2).
CX	getPriorAlternatePatientID(int rep) Returns a specific repetition of MRG-2: "Prior Alternate Patient ID" - creates it if necessary
int	getPriorAlternatePatientIDReps() Returns a count of the current number of repetitions of Prior Alternate Patient ID (MRG-2).
CX	getPriorAlternateVisitID() Returns MRG-6: "Prior Alternate Visit ID" - creates it if necessary
CX	getPriorPatientAccountNumber() Returns MRG-3: "Prior Patient Account Number" - creates it if necessary
CX	getPriorPatientID() Returns MRG-4: "Prior Patient ID" - creates it if necessary
CX[]	getPriorPatientIdentifierList() Returns all repetitions of Prior Patient Identifier List (MRG-1).
CX	getPriorPatientIdentifierList(int rep) Returns a specific repetition of MRG-1: "Prior Patient Identifier List" - creates it if necessary
int	getPriorPatientIdentifierListReps() Returns a count of the current number of repetitions of Prior Patient Identifier List (MRG-1).
XPN[]	getPriorPatientName() Returns all repetitions of Prior Patient Name (MRG-7).
XPN	getPriorPatientName(int rep) Returns a specific repetition of MRG-7: "Prior Patient Name" - creates it if necessary
int	getPriorPatientNameReps() Returns a count of the current number of repetitions of Prior Patient Name (MRG-7).
CX	getPriorVisitNumber() Returns MRG-5: "Prior Visit Number" - creates it if necessary
CX	insertMrg1_PriorPatientIdentifierList(int rep) Inserts a repetition of MRG-1: "Prior Patient Identifier List" at a specific index
CX	insertMrg2_PriorAlternatePatientID(int rep) Inserts a repetition of MRG-2: "Prior Alternate Patient ID" at a specific index
XPN	insertMrg7_PriorPatientName(int rep) Inserts a repetition of MRG-7: "Prior Patient Name" at a specific index
CX	insertPriorAlternatePatientID(int rep) Inserts a repetition of MRG-2: "Prior Alternate Patient ID" at a specific index
CX	insertPriorPatientIdentifierList(int rep) Inserts a repetition of MRG-1: "Prior Patient Identifier List" at a specific index
XPN	insertPriorPatientName(int rep) Inserts a repetition of MRG-7: "Prior Patient Name" at a specific index
CX	removeMrg1_PriorPatientIdentifierList(int rep) Removes a repetition of MRG-1: "Prior Patient Identifier List" at a specific index
CX	removeMrg2_PriorAlternatePatientID(int rep) Removes a repetition of MRG-2: "Prior Alternate Patient ID" at a specific index
XPN	removeMrg7_PriorPatientName(int rep) Removes a repetition of MRG-7: "Prior Patient Name" at a specific index
CX	removePriorAlternatePatientID(int rep) Removes a repetition of MRG-2: "Prior Alternate Patient ID" at a specific index
CX	removePriorPatientIdentifierList(int rep) Removes a repetition of MRG-1: "Prior Patient Identifier List" at a specific index
XPN	removePriorPatientName(int rep) Removes a repetition of MRG-7: "Prior Patient Name" at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

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

Constructor Detail

MRG

public MRG(Group parent,
           ModelClassFactory factory)

Creates a new MRG segment

Method Detail

getPriorPatientIdentifierList

public CX[] getPriorPatientIdentifierList()

Returns all repetitions of Prior Patient Identifier List (MRG-1).

getPriorPatientIdentifierListReps

public int getPriorPatientIdentifierListReps()

Returns a count of the current number of repetitions of Prior Patient Identifier List (MRG-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getPriorPatientIdentifierList

public CX getPriorPatientIdentifierList(int rep)

Returns a specific repetition of MRG-1: "Prior Patient Identifier List" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMrg1_PriorPatientIdentifierList

public CX getMrg1_PriorPatientIdentifierList(int rep)

Returns a specific repetition of MRG-1: "Prior Patient Identifier List" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMrg1_PriorPatientIdentifierListReps

public int getMrg1_PriorPatientIdentifierListReps()

Returns a count of the current number of repetitions of Prior Patient Identifier List (MRG-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertPriorPatientIdentifierList

public CX insertPriorPatientIdentifierList(int rep)
                                    throws HL7Exception

Inserts a repetition of MRG-1: "Prior Patient Identifier List" 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)

insertMrg1_PriorPatientIdentifierList

public CX insertMrg1_PriorPatientIdentifierList(int rep)
                                         throws HL7Exception

Inserts a repetition of MRG-1: "Prior Patient Identifier List" 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)

removePriorPatientIdentifierList

public CX removePriorPatientIdentifierList(int rep)
                                    throws HL7Exception

Removes a repetition of MRG-1: "Prior Patient Identifier List" 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)

removeMrg1_PriorPatientIdentifierList

public CX removeMrg1_PriorPatientIdentifierList(int rep)
                                         throws HL7Exception

Removes a repetition of MRG-1: "Prior Patient Identifier List" 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)

getPriorAlternatePatientID

public CX[] getPriorAlternatePatientID()

Returns all repetitions of Prior Alternate Patient ID (MRG-2).

getPriorAlternatePatientIDReps

public int getPriorAlternatePatientIDReps()

Returns a count of the current number of repetitions of Prior Alternate Patient ID (MRG-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getPriorAlternatePatientID

public CX getPriorAlternatePatientID(int rep)

Returns a specific repetition of MRG-2: "Prior Alternate Patient ID" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMrg2_PriorAlternatePatientID

public CX getMrg2_PriorAlternatePatientID(int rep)

Returns a specific repetition of MRG-2: "Prior Alternate Patient ID" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMrg2_PriorAlternatePatientIDReps

public int getMrg2_PriorAlternatePatientIDReps()

Returns a count of the current number of repetitions of Prior Alternate Patient ID (MRG-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertPriorAlternatePatientID

public CX insertPriorAlternatePatientID(int rep)
                                 throws HL7Exception

Inserts a repetition of MRG-2: "Prior Alternate Patient ID" 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)

insertMrg2_PriorAlternatePatientID

public CX insertMrg2_PriorAlternatePatientID(int rep)
                                      throws HL7Exception

Inserts a repetition of MRG-2: "Prior Alternate Patient ID" 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)

removePriorAlternatePatientID

public CX removePriorAlternatePatientID(int rep)
                                 throws HL7Exception

Removes a repetition of MRG-2: "Prior Alternate Patient ID" 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)

removeMrg2_PriorAlternatePatientID

public CX removeMrg2_PriorAlternatePatientID(int rep)
                                      throws HL7Exception

Removes a repetition of MRG-2: "Prior Alternate Patient ID" 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)

getPriorPatientAccountNumber

public CX getPriorPatientAccountNumber()

Returns MRG-3: "Prior Patient Account Number" - creates it if necessary

getMrg3_PriorPatientAccountNumber

public CX getMrg3_PriorPatientAccountNumber()

Returns MRG-3: "Prior Patient Account Number" - creates it if necessary

getPriorPatientID

public CX getPriorPatientID()

Returns MRG-4: "Prior Patient ID" - creates it if necessary

getMrg4_PriorPatientID

public CX getMrg4_PriorPatientID()

Returns MRG-4: "Prior Patient ID" - creates it if necessary

getPriorVisitNumber

public CX getPriorVisitNumber()

Returns MRG-5: "Prior Visit Number" - creates it if necessary

getMrg5_PriorVisitNumber

public CX getMrg5_PriorVisitNumber()

Returns MRG-5: "Prior Visit Number" - creates it if necessary

getPriorAlternateVisitID

public CX getPriorAlternateVisitID()

Returns MRG-6: "Prior Alternate Visit ID" - creates it if necessary

getMrg6_PriorAlternateVisitID

public CX getMrg6_PriorAlternateVisitID()

Returns MRG-6: "Prior Alternate Visit ID" - creates it if necessary

getPriorPatientName

public XPN[] getPriorPatientName()

Returns all repetitions of Prior Patient Name (MRG-7).

getPriorPatientNameReps

public int getPriorPatientNameReps()

Returns a count of the current number of repetitions of Prior Patient Name (MRG-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getPriorPatientName

public XPN getPriorPatientName(int rep)

Returns a specific repetition of MRG-7: "Prior Patient Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMrg7_PriorPatientName

public XPN getMrg7_PriorPatientName(int rep)

Returns a specific repetition of MRG-7: "Prior Patient Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMrg7_PriorPatientNameReps

public int getMrg7_PriorPatientNameReps()

Returns a count of the current number of repetitions of Prior Patient Name (MRG-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertPriorPatientName

public XPN insertPriorPatientName(int rep)
                           throws HL7Exception

Inserts a repetition of MRG-7: "Prior Patient Name" 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)

insertMrg7_PriorPatientName

public XPN insertMrg7_PriorPatientName(int rep)
                                throws HL7Exception

Inserts a repetition of MRG-7: "Prior Patient Name" 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)

removePriorPatientName

public XPN removePriorPatientName(int rep)
                           throws HL7Exception

Removes a repetition of MRG-7: "Prior Patient Name" 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)

removeMrg7_PriorPatientName

public XPN removeMrg7_PriorPatientName(int rep)
                                throws HL7Exception

Removes a repetition of MRG-7: "Prior Patient Name" 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