ca.uhn.hl7v2.model.v26.group

Class BRT_O32_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.BRT_O32_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class BRT_O32_ORDER
extends AbstractGroup

Represents a BRT_O32_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: BRT_O32_TIMING (a Group object) optional repeating
• 3: BPO (Blood product order) optional
• 4: BTX (Blood Product Transfusion/Disposition) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
BPO	getBPO() Returns BPO (Blood product order) - creates it if necessary
BTX	getBTX() Returns the first repetition of BTX (Blood Product Transfusion/Disposition) - creates it if necessary
BTX	getBTX(int rep) Returns a specific repetition of BTX (Blood Product Transfusion/Disposition) - creates it if necessary
List<BTX>	getBTXAll() Returns a non-modifiable List containing all current existing repetitions of BTX.
int	getBTXReps() Returns the number of existing repetitions of BTX
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
BRT_O32_TIMING	getTIMING() Returns the first repetition of TIMING (a Group object) - creates it if necessary
BRT_O32_TIMING	getTIMING(int rep) Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<BRT_O32_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.6"
void	insertBTX(BTX structure, int rep) Inserts a specific repetition of BTX (Blood Product Transfusion/Disposition)
BTX	insertBTX(int rep) Inserts a specific repetition of BTX (Blood Product Transfusion/Disposition)
void	insertTIMING(BRT_O32_TIMING structure, int rep) Inserts a specific repetition of TIMING (a Group object)
BRT_O32_TIMING	insertTIMING(int rep) Inserts a specific repetition of TIMING (a Group object)
BTX	removeBTX(int rep) Removes a specific repetition of BTX (Blood Product Transfusion/Disposition)
BRT_O32_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

BRT_O32_ORDER

public BRT_O32_ORDER(Group parent,
             ModelClassFactory factory)

Creates a new BRT_O32_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.6"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getTIMING

public BRT_O32_TIMING getTIMING()

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

getTIMING

public BRT_O32_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<BRT_O32_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(BRT_O32_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 BRT_O32_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 BRT_O32_TIMING removeTIMING(int rep)
                            throws HL7Exception

Removes a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getBPO

public BPO getBPO()

Returns BPO (Blood product order) - creates it if necessary

getBTX

public BTX getBTX()

Returns the first repetition of BTX (Blood Product Transfusion/Disposition) - creates it if necessary

getBTX

public BTX getBTX(int rep)

Returns a specific repetition of BTX (Blood Product Transfusion/Disposition) - 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.

getBTXReps

public int getBTXReps()

Returns the number of existing repetitions of BTX

getBTXAll

public List<BTX> getBTXAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertBTX

public void insertBTX(BTX structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of BTX (Blood Product Transfusion/Disposition)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertBTX

public BTX insertBTX(int rep)
              throws HL7Exception

Inserts a specific repetition of BTX (Blood Product Transfusion/Disposition)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeBTX

public BTX removeBTX(int rep)
              throws HL7Exception

Removes a specific repetition of BTX (Blood Product Transfusion/Disposition)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)