ca.uhn.hl7v2.model.v28.group

Class OML_O35_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v28.group.OML_O35_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OML_O35_ORDER
extends AbstractGroup

Represents a OML_O35_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)
• 2: PRT (Participation Information) optional repeating
• 3: OML_O35_TIMING (a Group object) optional repeating
• 4: OML_O35_OBSERVATION_REQUEST (a Group object) optional
• 5: FT1 (Financial Transaction) optional repeating
• 6: CTI (Clinical Trial Identification) optional repeating
• 7: BLG (Billing) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
BLG	getBLG() Returns BLG (Billing) - creates it if necessary
CTI	getCTI() Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary
CTI	getCTI(int rep) Returns a specific repetition of CTI (Clinical Trial Identification) - creates it if necessary
List<CTI>	getCTIAll() Returns a non-modifiable List containing all current existing repetitions of CTI.
int	getCTIReps() Returns the number of existing repetitions of CTI
FT1	getFT1() Returns the first repetition of FT1 (Financial Transaction) - creates it if necessary
FT1	getFT1(int rep) Returns a specific repetition of FT1 (Financial Transaction) - creates it if necessary
List<FT1>	getFT1All() Returns a non-modifiable List containing all current existing repetitions of FT1.
int	getFT1Reps() Returns the number of existing repetitions of FT1
OML_O35_OBSERVATION_REQUEST	getOBSERVATION_REQUEST() Returns OBSERVATION_REQUEST (a Group object) - creates it if necessary
ORC	getORC() Returns ORC (Common Order) - 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
OML_O35_TIMING	getTIMING() Returns the first repetition of TIMING (a Group object) - creates it if necessary
OML_O35_TIMING	getTIMING(int rep) Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<OML_O35_TIMING>	getTIMINGAll() Returns a non-modifiable List containing all current existing repetitions of TIMING.
int	getTIMINGReps() Returns the number of existing repetitions of TIMING
String	getVersion() Returns "2.8"
void	insertCTI(CTI structure, int rep) Inserts a specific repetition of CTI (Clinical Trial Identification)
CTI	insertCTI(int rep) Inserts a specific repetition of CTI (Clinical Trial Identification)
void	insertFT1(FT1 structure, int rep) Inserts a specific repetition of FT1 (Financial Transaction)
FT1	insertFT1(int rep) Inserts a specific repetition of FT1 (Financial Transaction)
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)
OML_O35_TIMING	insertTIMING(int rep) Inserts a specific repetition of TIMING (a Group object)
void	insertTIMING(OML_O35_TIMING structure, int rep) Inserts a specific repetition of TIMING (a Group object)
CTI	removeCTI(int rep) Removes a specific repetition of CTI (Clinical Trial Identification)
FT1	removeFT1(int rep) Removes a specific repetition of FT1 (Financial Transaction)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)
OML_O35_TIMING	removeTIMING(int rep) Removes a specific repetition of TIMING (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 Detail

OML_O35_ORDER

public OML_O35_ORDER(Group parent,
                     ModelClassFactory factory)

Creates a new OML_O35_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.8"

getORC

public ORC getORC()

Returns ORC (Common Order) - 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)

getTIMING

public OML_O35_TIMING getTIMING()

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

getTIMING

public OML_O35_TIMING getTIMING(int rep)

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

getTIMINGReps

public int getTIMINGReps()

Returns the number of existing repetitions of TIMING

getTIMINGAll

public List<OML_O35_TIMING> getTIMINGAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertTIMING

public void insertTIMING(OML_O35_TIMING structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertTIMING

public OML_O35_TIMING insertTIMING(int rep)
                            throws HL7Exception

Inserts a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeTIMING

public OML_O35_TIMING removeTIMING(int rep)
                            throws HL7Exception

Removes a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBSERVATION_REQUEST

public OML_O35_OBSERVATION_REQUEST getOBSERVATION_REQUEST()

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

getFT1

public FT1 getFT1()

Returns the first repetition of FT1 (Financial Transaction) - creates it if necessary

getFT1

public FT1 getFT1(int rep)

Returns a specific repetition of FT1 (Financial Transaction) - 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.

getFT1Reps

public int getFT1Reps()

Returns the number of existing repetitions of FT1

getFT1All

public List<FT1> getFT1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertFT1

public void insertFT1(FT1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of FT1 (Financial Transaction)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertFT1

public FT1 insertFT1(int rep)
              throws HL7Exception

Inserts a specific repetition of FT1 (Financial Transaction)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeFT1

public FT1 removeFT1(int rep)
              throws HL7Exception

Removes a specific repetition of FT1 (Financial Transaction)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getCTI

public CTI getCTI()

Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary

getCTI

public CTI getCTI(int rep)

Returns a specific repetition of CTI (Clinical Trial Identification) - 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.

getCTIReps

public int getCTIReps()

Returns the number of existing repetitions of CTI

getCTIAll

public List<CTI> getCTIAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertCTI

public void insertCTI(CTI structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCTI

public CTI insertCTI(int rep)
              throws HL7Exception

Inserts a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCTI

public CTI removeCTI(int rep)
              throws HL7Exception

Removes a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getBLG

public BLG getBLG()

Returns BLG (Billing) - creates it if necessary