Package ca.uhn.hl7v2.model.v24.group

Class DFT_P03_FINANCIAL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.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: DFT_P03_FINANCIAL_PROCEDURE (a Group object) optional repeating
• 3: DFT_P03_FINANCIAL_COMMON_ORDER (a Group object) optional repeating
• 4: DG1 (Diagnosis) optional repeating
• 5: DRG (Diagnosis Related Group) optional
• 6: GT1 (Guarantor) optional repeating
• 7: DFT_P03_INSURANCE (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	Description
DFT_P03_FINANCIAL(Group parent, ModelClassFactory factory)	Creates a new DFT_P03_FINANCIAL group

Method Summary

Modifier and Type	Method	Description
DG1	getDG1()	Returns the first repetition of DG1 (Diagnosis) - creates it if necessary
DG1	getDG1(int rep)	Returns a specific repetition of DG1 (Diagnosis) - creates it if necessary
List<DG1>	getDG1All()	Returns a non-modifiable List containing all current existing repetitions of DG1.
int	getDG1Reps()	Returns the number of existing repetitions of DG1
DRG	getDRG()	Returns DRG (Diagnosis Related Group) - creates it if necessary
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
GT1	getGT1()	Returns the first repetition of GT1 (Guarantor) - creates it if necessary
GT1	getGT1(int rep)	Returns a specific repetition of GT1 (Guarantor) - creates it if necessary
List<GT1>	getGT1All()	Returns a non-modifiable List containing all current existing repetitions of GT1.
int	getGT1Reps()	Returns the number of existing repetitions of GT1
DFT_P03_INSURANCE	getINSURANCE()	Returns the first repetition of INSURANCE (a Group object) - creates it if necessary
DFT_P03_INSURANCE	getINSURANCE(int rep)	Returns a specific repetition of INSURANCE (a Group object) - creates it if necessary
List<DFT_P03_INSURANCE>	getINSURANCEAll()	Returns a non-modifiable List containing all current existing repetitions of INSURANCE.
int	getINSURANCEReps()	Returns the number of existing repetitions of INSURANCE
String	getVersion()	Returns "2.4"
DG1	insertDG1(int rep)	Inserts a specific repetition of DG1 (Diagnosis)
void	insertDG1(DG1 structure, int rep)	Inserts a specific repetition of DG1 (Diagnosis)
DFT_P03_FINANCIAL_COMMON_ORDER	insertFINANCIAL_COMMON_ORDER(int rep)	Inserts a specific repetition of FINANCIAL_COMMON_ORDER (a Group object)
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_PROCEDURE	insertFINANCIAL_PROCEDURE(int rep)	Inserts a specific repetition of FINANCIAL_PROCEDURE (a Group object)
void	insertFINANCIAL_PROCEDURE(DFT_P03_FINANCIAL_PROCEDURE structure, int rep)	Inserts a specific repetition of FINANCIAL_PROCEDURE (a Group object)
GT1	insertGT1(int rep)	Inserts a specific repetition of GT1 (Guarantor)
void	insertGT1(GT1 structure, int rep)	Inserts a specific repetition of GT1 (Guarantor)
DFT_P03_INSURANCE	insertINSURANCE(int rep)	Inserts a specific repetition of INSURANCE (a Group object)
void	insertINSURANCE(DFT_P03_INSURANCE structure, int rep)	Inserts a specific repetition of INSURANCE (a Group object)
DG1	removeDG1(int rep)	Removes a specific repetition of DG1 (Diagnosis)
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)
GT1	removeGT1(int rep)	Removes a specific repetition of GT1 (Guarantor)
DFT_P03_INSURANCE	removeINSURANCE(int rep)	Removes a specific repetition of INSURANCE (a Group object)

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 Details

DFT_P03_FINANCIAL

public DFT_P03_FINANCIAL(Group parent,
 ModelClassFactory factory)

Creates a new DFT_P03_FINANCIAL group

Method Details

getVersion

public String getVersion()

Returns "2.4"

getFT1

public FT1 getFT1()

Returns FT1 (Financial Transaction) - 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)

getDG1

public DG1 getDG1()

Returns the first repetition of DG1 (Diagnosis) - creates it if necessary

getDG1

public DG1 getDG1(int rep)

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

getDG1Reps

public int getDG1Reps()

Returns the number of existing repetitions of DG1

getDG1All

public List<DG1> getDG1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertDG1

public void insertDG1(DG1 structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDG1

public DG1 insertDG1(int rep)
              throws HL7Exception

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDG1

public DG1 removeDG1(int rep)
              throws HL7Exception

Removes a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDRG

public DRG getDRG()

Returns DRG (Diagnosis Related Group) - creates it if necessary

getGT1

public GT1 getGT1()

Returns the first repetition of GT1 (Guarantor) - creates it if necessary

getGT1

public GT1 getGT1(int rep)

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

getGT1Reps

public int getGT1Reps()

Returns the number of existing repetitions of GT1

getGT1All

public List<GT1> getGT1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertGT1

public void insertGT1(GT1 structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertGT1

public GT1 insertGT1(int rep)
              throws HL7Exception

Inserts a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeGT1

public GT1 removeGT1(int rep)
              throws HL7Exception

Removes a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getINSURANCE

public DFT_P03_INSURANCE getINSURANCE()

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

getINSURANCE

public DFT_P03_INSURANCE getINSURANCE(int rep)

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

getINSURANCEReps

public int getINSURANCEReps()

Returns the number of existing repetitions of INSURANCE

getINSURANCEAll

public List<DFT_P03_INSURANCE> getINSURANCEAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertINSURANCE

public void insertINSURANCE(DFT_P03_INSURANCE structure,
 int rep)
                     throws HL7Exception

Inserts a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertINSURANCE

public DFT_P03_INSURANCE insertINSURANCE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeINSURANCE

public DFT_P03_INSURANCE removeINSURANCE(int rep)
                                  throws HL7Exception

Removes a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)