Package ca.uhn.hl7v2.model.v22.message

Class MFR_M02

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v22.message.MFR_M02

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class MFR_M02
extends AbstractMessage

Represents a MFR_M02 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (MESSAGE HEADER)
• 2: MSA (MESSAGE ACKNOWLEDGMENT)
• 3: ERR (ERROR) optional
• 4: QRD (QUERY DEFINITION)
• 5: QRF (QUERY FILTER) optional
• 6: MFI (MASTER FILE IDENTIFICATION)
• 7: MFR_M02_MF_STAFF (a Group object) repeating
• 8: DSC (CONTINUATION POINTER) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
MFR_M02()	Creates a new MFR_M02 message with DefaultModelClassFactory.
MFR_M02(ModelClassFactory factory)	Creates a new MFR_M02 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
DSC	getDSC()	Returns DSC (CONTINUATION POINTER) - creates it if necessary
ERR	getERR()	Returns ERR (ERROR) - creates it if necessary
MFR_M02_MF_STAFF	getMF_STAFF()	Returns the first repetition of MF_STAFF (a Group object) - creates it if necessary
MFR_M02_MF_STAFF	getMF_STAFF(int rep)	Returns a specific repetition of MF_STAFF (a Group object) - creates it if necessary
List<MFR_M02_MF_STAFF>	getMF_STAFFAll()	Returns a non-modifiable List containing all current existing repetitions of MF_STAFF.
int	getMF_STAFFReps()	Returns the number of existing repetitions of MF_STAFF
MFI	getMFI()	Returns MFI (MASTER FILE IDENTIFICATION) - creates it if necessary
MSA	getMSA()	Returns MSA (MESSAGE ACKNOWLEDGMENT) - creates it if necessary
MSH	getMSH()	Returns MSH (MESSAGE HEADER) - creates it if necessary
QRD	getQRD()	Returns QRD (QUERY DEFINITION) - creates it if necessary
QRF	getQRF()	Returns QRF (QUERY FILTER) - creates it if necessary
String	getVersion()	Returns "2.2"
MFR_M02_MF_STAFF	insertMF_STAFF(int rep)	Inserts a specific repetition of MF_STAFF (a Group object)
void	insertMF_STAFF(MFR_M02_MF_STAFF structure, int rep)	Inserts a specific repetition of MF_STAFF (a Group object)
MFR_M02_MF_STAFF	removeMF_STAFF(int rep)	Removes a specific repetition of MF_STAFF (a Group object)

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

accept, copy, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

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

add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

Methods inherited from class java.lang.Object

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

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

addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isChoiceElement, isGroup, isRepeating, isRequired

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

getName

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

isEmpty, provideLocation

Constructor Details

MFR_M02

public MFR_M02()

Creates a new MFR_M02 message with DefaultModelClassFactory.

MFR_M02

public MFR_M02(ModelClassFactory factory)

Creates a new MFR_M02 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.2"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (MESSAGE HEADER) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (MESSAGE ACKNOWLEDGMENT) - creates it if necessary

getERR

public ERR getERR()

Returns ERR (ERROR) - creates it if necessary

getQRD

public QRD getQRD()

Returns QRD (QUERY DEFINITION) - creates it if necessary

getQRF

public QRF getQRF()

Returns QRF (QUERY FILTER) - creates it if necessary

getMFI

public MFI getMFI()

Returns MFI (MASTER FILE IDENTIFICATION) - creates it if necessary

getMF_STAFF

public MFR_M02_MF_STAFF getMF_STAFF()

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

getMF_STAFF

public MFR_M02_MF_STAFF getMF_STAFF(int rep)

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

getMF_STAFFReps

public int getMF_STAFFReps()

Returns the number of existing repetitions of MF_STAFF

getMF_STAFFAll

public List<MFR_M02_MF_STAFF> getMF_STAFFAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertMF_STAFF

public void insertMF_STAFF(MFR_M02_MF_STAFF structure,
 int rep)
                    throws HL7Exception

Inserts a specific repetition of MF_STAFF (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertMF_STAFF

public MFR_M02_MF_STAFF insertMF_STAFF(int rep)
                                throws HL7Exception

Inserts a specific repetition of MF_STAFF (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeMF_STAFF

public MFR_M02_MF_STAFF removeMF_STAFF(int rep)
                                throws HL7Exception

Removes a specific repetition of MF_STAFF (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (CONTINUATION POINTER) - creates it if necessary