ca.uhn.hl7v2.model.v281.group

Class DFT_P03_FINANCIAL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.DFT_P03_FINANCIAL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class DFT_P03_FINANCIAL
extends AbstractGroup

Represents a DFT_P03_FINANCIAL 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: FT1 (Financial Transaction)
• 2: PRT (Participation Information) optional repeating
• 3: ROL (Role) optional repeating
• 4: NTE (Notes and Comments) optional
• 5: DFT_P03_FINANCIAL_PROCEDURE (a Group object) optional repeating
• 6: DFT_P03_FINANCIAL_COMMON_ORDER (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DFT_P03_FINANCIAL_COMMON_ORDER	getFINANCIAL_COMMON_ORDER() Returns the first repetition of FINANCIAL_COMMON_ORDER (a Group object) - creates it if necessary
DFT_P03_FINANCIAL_COMMON_ORDER	getFINANCIAL_COMMON_ORDER(int rep) Returns a specific repetition of FINANCIAL_COMMON_ORDER (a Group object) - creates it if necessary
List<DFT_P03_FINANCIAL_COMMON_ORDER>	getFINANCIAL_COMMON_ORDERAll() Returns a non-modifiable List containing all current existing repetitions of FINANCIAL_COMMON_ORDER.
int	getFINANCIAL_COMMON_ORDERReps() Returns the number of existing repetitions of FINANCIAL_COMMON_ORDER
DFT_P03_FINANCIAL_PROCEDURE	getFINANCIAL_PROCEDURE() Returns the first repetition of FINANCIAL_PROCEDURE (a Group object) - creates it if necessary
DFT_P03_FINANCIAL_PROCEDURE	getFINANCIAL_PROCEDURE(int rep) Returns a specific repetition of FINANCIAL_PROCEDURE (a Group object) - creates it if necessary
List<DFT_P03_FINANCIAL_PROCEDURE>	getFINANCIAL_PROCEDUREAll() Returns a non-modifiable List containing all current existing repetitions of FINANCIAL_PROCEDURE.
int	getFINANCIAL_PROCEDUREReps() Returns the number of existing repetitions of FINANCIAL_PROCEDURE
FT1	getFT1() Returns FT1 (Financial Transaction) - creates it if necessary
NTE	getNTE() Returns NTE (Notes and Comments) - creates it if necessary
PRT	getPRT() Returns the first repetition of PRT (Participation Information) - creates it if necessary
PRT	getPRT(int rep) Returns a specific repetition of PRT (Participation Information) - creates it if necessary
List<PRT>	getPRTAll() Returns a non-modifiable List containing all current existing repetitions of PRT.
int	getPRTReps() Returns the number of existing repetitions of PRT
ROL	getROL() Returns the first repetition of ROL (Role) - creates it if necessary
ROL	getROL(int rep) Returns a specific repetition of ROL (Role) - creates it if necessary
List<ROL>	getROLAll() Returns a non-modifiable List containing all current existing repetitions of ROL.
int	getROLReps() Returns the number of existing repetitions of ROL
String	getVersion() Returns "2.8.1"
void	insertFINANCIAL_COMMON_ORDER(DFT_P03_FINANCIAL_COMMON_ORDER structure, int rep) Inserts a specific repetition of FINANCIAL_COMMON_ORDER (a Group object)
DFT_P03_FINANCIAL_COMMON_ORDER	insertFINANCIAL_COMMON_ORDER(int rep) Inserts a specific repetition of FINANCIAL_COMMON_ORDER (a Group object)
void	insertFINANCIAL_PROCEDURE(DFT_P03_FINANCIAL_PROCEDURE structure, int rep) Inserts a specific repetition of FINANCIAL_PROCEDURE (a Group object)
DFT_P03_FINANCIAL_PROCEDURE	insertFINANCIAL_PROCEDURE(int rep) Inserts a specific repetition of FINANCIAL_PROCEDURE (a Group object)
PRT	insertPRT(int rep) Inserts a specific repetition of PRT (Participation Information)
void	insertPRT(PRT structure, int rep) Inserts a specific repetition of PRT (Participation Information)
ROL	insertROL(int rep) Inserts a specific repetition of ROL (Role)
void	insertROL(ROL structure, int rep) Inserts a specific repetition of ROL (Role)
DFT_P03_FINANCIAL_COMMON_ORDER	removeFINANCIAL_COMMON_ORDER(int rep) Removes a specific repetition of FINANCIAL_COMMON_ORDER (a Group object)
DFT_P03_FINANCIAL_PROCEDURE	removeFINANCIAL_PROCEDURE(int rep) Removes a specific repetition of FINANCIAL_PROCEDURE (a Group object)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)
ROL	removeROL(int rep) Removes a specific repetition of ROL (Role)

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

DFT_P03_FINANCIAL

public DFT_P03_FINANCIAL(Group parent,
                         ModelClassFactory factory)

Creates a new DFT_P03_FINANCIAL group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getFT1

public FT1 getFT1()

Returns FT1 (Financial Transaction) - creates it if necessary

getPRT

public PRT getPRT()

Returns the first repetition of PRT (Participation Information) - creates it if necessary

getPRT

public PRT getPRT(int rep)

Returns a specific repetition of PRT (Participation Information) - 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.

getPRTReps

public int getPRTReps()

Returns the number of existing repetitions of PRT

getPRTAll

public List<PRT> getPRTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRT

public void insertPRT(PRT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRT

public PRT insertPRT(int rep)
              throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRT

public PRT removePRT(int rep)
              throws HL7Exception

Removes a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getROL

public ROL getROL()

Returns the first repetition of ROL (Role) - creates it if necessary

getROL

public ROL getROL(int rep)

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

getROLReps

public int getROLReps()

Returns the number of existing repetitions of ROL

getROLAll

public List<ROL> getROLAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertROL

public void insertROL(ROL structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertROL

public ROL insertROL(int rep)
              throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeROL

public ROL removeROL(int rep)
              throws HL7Exception

Removes a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getNTE

public NTE getNTE()

Returns NTE (Notes and Comments) - creates it if necessary

getFINANCIAL_PROCEDURE

public DFT_P03_FINANCIAL_PROCEDURE getFINANCIAL_PROCEDURE()

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

getFINANCIAL_PROCEDURE

public DFT_P03_FINANCIAL_PROCEDURE getFINANCIAL_PROCEDURE(int rep)

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

getFINANCIAL_PROCEDUREReps

public int getFINANCIAL_PROCEDUREReps()

Returns the number of existing repetitions of FINANCIAL_PROCEDURE

getFINANCIAL_PROCEDUREAll

public List<DFT_P03_FINANCIAL_PROCEDURE> getFINANCIAL_PROCEDUREAll()
                                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertFINANCIAL_PROCEDURE

public void insertFINANCIAL_PROCEDURE(DFT_P03_FINANCIAL_PROCEDURE structure,
                                      int rep)
                               throws HL7Exception

Inserts a specific repetition of FINANCIAL_PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertFINANCIAL_PROCEDURE

public DFT_P03_FINANCIAL_PROCEDURE insertFINANCIAL_PROCEDURE(int rep)
                                                      throws HL7Exception

Inserts a specific repetition of FINANCIAL_PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeFINANCIAL_PROCEDURE

public DFT_P03_FINANCIAL_PROCEDURE removeFINANCIAL_PROCEDURE(int rep)
                                                      throws HL7Exception

Removes a specific repetition of FINANCIAL_PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getFINANCIAL_COMMON_ORDER

public DFT_P03_FINANCIAL_COMMON_ORDER getFINANCIAL_COMMON_ORDER()

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

getFINANCIAL_COMMON_ORDER

public DFT_P03_FINANCIAL_COMMON_ORDER getFINANCIAL_COMMON_ORDER(int rep)

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

getFINANCIAL_COMMON_ORDERReps

public int getFINANCIAL_COMMON_ORDERReps()

Returns the number of existing repetitions of FINANCIAL_COMMON_ORDER

getFINANCIAL_COMMON_ORDERAll

public List<DFT_P03_FINANCIAL_COMMON_ORDER> getFINANCIAL_COMMON_ORDERAll()
                                                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertFINANCIAL_COMMON_ORDER

public void insertFINANCIAL_COMMON_ORDER(DFT_P03_FINANCIAL_COMMON_ORDER structure,
                                         int rep)
                                  throws HL7Exception

Inserts a specific repetition of FINANCIAL_COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertFINANCIAL_COMMON_ORDER

public DFT_P03_FINANCIAL_COMMON_ORDER insertFINANCIAL_COMMON_ORDER(int rep)
                                                            throws HL7Exception

Inserts a specific repetition of FINANCIAL_COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeFINANCIAL_COMMON_ORDER

public DFT_P03_FINANCIAL_COMMON_ORDER removeFINANCIAL_COMMON_ORDER(int rep)
                                                            throws HL7Exception

Removes a specific repetition of FINANCIAL_COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)