ca.uhn.hl7v2.model.v281.group

Class MFN_M04_MF_CDM

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.MFN_M04_MF_CDM

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class MFN_M04_MF_CDM
extends AbstractGroup

Represents a MFN_M04_MF_CDM group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: MFE (Master File Entry)
• 2: NTE (Notes and Comments) optional repeating
• 3: CDM (Charge Description Master)
• 4: NTE (Notes and Comments) optional repeating
• 5: PRC (Pricing) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
MFN_M04_MF_CDM(Group parent, ModelClassFactory factory) Creates a new MFN_M04_MF_CDM group

Method Summary

Modifier and Type	Method and Description
CDM	getCDM() Returns CDM (Charge Description Master) - creates it if necessary
MFE	getMFE() Returns MFE (Master File Entry) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE2() Returns the first repetition of NTE2 (Notes and Comments) - creates it if necessary
NTE	getNTE2(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTE2All() Returns a non-modifiable List containing all current existing repetitions of NTE2.
int	getNTE2Reps() Returns the number of existing repetitions of NTE2
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
PRC	getPRC() Returns the first repetition of PRC (Pricing) - creates it if necessary
PRC	getPRC(int rep) Returns a specific repetition of PRC (Pricing) - creates it if necessary
List<PRC>	getPRCAll() Returns a non-modifiable List containing all current existing repetitions of PRC.
int	getPRCReps() Returns the number of existing repetitions of PRC
String	getVersion() Returns "2.8.1"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
NTE	insertNTE2(int rep) Inserts a specific repetition of NTE2 (Notes and Comments)
void	insertNTE2(NTE structure, int rep) Inserts a specific repetition of NTE2 (Notes and Comments)
PRC	insertPRC(int rep) Inserts a specific repetition of PRC (Pricing)
void	insertPRC(PRC structure, int rep) Inserts a specific repetition of PRC (Pricing)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
NTE	removeNTE2(int rep) Removes a specific repetition of NTE2 (Notes and Comments)
PRC	removePRC(int rep) Removes a specific repetition of PRC (Pricing)

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

accept, 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 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

MFN_M04_MF_CDM

public MFN_M04_MF_CDM(Group parent,
                      ModelClassFactory factory)

Creates a new MFN_M04_MF_CDM group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getMFE

public MFE getMFE()

Returns MFE (Master File Entry) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getCDM

public CDM getCDM()

Returns CDM (Charge Description Master) - creates it if necessary

getNTE2

public NTE getNTE2()

Returns the first repetition of NTE2 (Notes and Comments) - creates it if necessary

getNTE2

public NTE getNTE2(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTE2Reps

public int getNTE2Reps()

Returns the number of existing repetitions of NTE2

getNTE2All

public List<NTE> getNTE2All()
                     throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE2

public void insertNTE2(NTE structure,
                       int rep)
                throws HL7Exception

Inserts a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE2

public NTE insertNTE2(int rep)
               throws HL7Exception

Inserts a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE2

public NTE removeNTE2(int rep)
               throws HL7Exception

Removes a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPRC

public PRC getPRC()

Returns the first repetition of PRC (Pricing) - creates it if necessary

getPRC

public PRC getPRC(int rep)

Returns a specific repetition of PRC (Pricing) - 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.

getPRCReps

public int getPRCReps()

Returns the number of existing repetitions of PRC

getPRCAll

public List<PRC> getPRCAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRC

public void insertPRC(PRC structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of PRC (Pricing)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRC

public PRC insertPRC(int rep)
              throws HL7Exception

Inserts a specific repetition of PRC (Pricing)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRC

public PRC removePRC(int rep)
              throws HL7Exception

Removes a specific repetition of PRC (Pricing)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)