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

Class DFT_P11_FINANCIAL_COMMON_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.DFT_P11_FINANCIAL_COMMON_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class DFT_P11_FINANCIAL_COMMON_ORDER
extends AbstractGroup

Represents a DFT_P11_FINANCIAL_COMMON_ORDER 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: ORC (Common Order) optional
• 2: DFT_P11_FINANCIAL_ORDER (a Group object) optional
• 3: DFT_P11_FINANCIAL_OBSERVATION (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_P11_FINANCIAL_COMMON_ORDER(Group parent, ModelClassFactory factory)	Creates a new DFT_P11_FINANCIAL_COMMON_ORDER group

Method Summary

Modifier and Type	Method	Description
DFT_P11_FINANCIAL_OBSERVATION	getFINANCIAL_OBSERVATION()	Returns the first repetition of FINANCIAL_OBSERVATION (a Group object) - creates it if necessary
DFT_P11_FINANCIAL_OBSERVATION	getFINANCIAL_OBSERVATION(int rep)	Returns a specific repetition of FINANCIAL_OBSERVATION (a Group object) - creates it if necessary
List<DFT_P11_FINANCIAL_OBSERVATION>	getFINANCIAL_OBSERVATIONAll()	Returns a non-modifiable List containing all current existing repetitions of FINANCIAL_OBSERVATION.
int	getFINANCIAL_OBSERVATIONReps()	Returns the number of existing repetitions of FINANCIAL_OBSERVATION
DFT_P11_FINANCIAL_ORDER	getFINANCIAL_ORDER()	Returns FINANCIAL_ORDER (a Group object) - creates it if necessary
ORC	getORC()	Returns ORC (Common Order) - creates it if necessary
String	getVersion()	Returns "2.4"
DFT_P11_FINANCIAL_OBSERVATION	insertFINANCIAL_OBSERVATION(int rep)	Inserts a specific repetition of FINANCIAL_OBSERVATION (a Group object)
void	insertFINANCIAL_OBSERVATION(DFT_P11_FINANCIAL_OBSERVATION structure, int rep)	Inserts a specific repetition of FINANCIAL_OBSERVATION (a Group object)
DFT_P11_FINANCIAL_OBSERVATION	removeFINANCIAL_OBSERVATION(int rep)	Removes a specific repetition of FINANCIAL_OBSERVATION (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_P11_FINANCIAL_COMMON_ORDER

public DFT_P11_FINANCIAL_COMMON_ORDER(Group parent,
 ModelClassFactory factory)

Creates a new DFT_P11_FINANCIAL_COMMON_ORDER group

Method Details

getVersion

public String getVersion()

Returns "2.4"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getFINANCIAL_ORDER

public DFT_P11_FINANCIAL_ORDER getFINANCIAL_ORDER()

Returns FINANCIAL_ORDER (a Group object) - creates it if necessary

getFINANCIAL_OBSERVATION

public DFT_P11_FINANCIAL_OBSERVATION getFINANCIAL_OBSERVATION()

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

getFINANCIAL_OBSERVATION

public DFT_P11_FINANCIAL_OBSERVATION getFINANCIAL_OBSERVATION(int rep)

Returns a specific repetition of FINANCIAL_OBSERVATION (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_OBSERVATIONReps

public int getFINANCIAL_OBSERVATIONReps()

Returns the number of existing repetitions of FINANCIAL_OBSERVATION

getFINANCIAL_OBSERVATIONAll

public List<DFT_P11_FINANCIAL_OBSERVATION> getFINANCIAL_OBSERVATIONAll()
                                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertFINANCIAL_OBSERVATION

public void insertFINANCIAL_OBSERVATION(DFT_P11_FINANCIAL_OBSERVATION structure,
 int rep)
                                 throws HL7Exception

Inserts a specific repetition of FINANCIAL_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertFINANCIAL_OBSERVATION

public DFT_P11_FINANCIAL_OBSERVATION insertFINANCIAL_OBSERVATION(int rep)
                                                          throws HL7Exception

Inserts a specific repetition of FINANCIAL_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeFINANCIAL_OBSERVATION

public DFT_P11_FINANCIAL_OBSERVATION removeFINANCIAL_OBSERVATION(int rep)
                                                          throws HL7Exception

Removes a specific repetition of FINANCIAL_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)