ca.uhn.hl7v2.model.v28.group

Class BTS_O31_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v28.group.BTS_O31_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class BTS_O31_ORDER
extends AbstractGroup

Represents a BTS_O31_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: BTS_O31_TIMING (a Group object) optional repeating
• 4: BPO (Blood product order)
• 5: NTE (Notes and Comments) optional repeating
• 6: BTS_O31_PRODUCT_STATUS (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
BTS_O31_ORDER(Group parent, ModelClassFactory factory) Creates a new BTS_O31_ORDER group

Method Summary

Modifier and Type	Method and Description
BPO	getBPO() Returns BPO (Blood product order) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
BTS_O31_PRODUCT_STATUS	getPRODUCT_STATUS() Returns the first repetition of PRODUCT_STATUS (a Group object) - creates it if necessary
BTS_O31_PRODUCT_STATUS	getPRODUCT_STATUS(int rep) Returns a specific repetition of PRODUCT_STATUS (a Group object) - creates it if necessary
List<BTS_O31_PRODUCT_STATUS>	getPRODUCT_STATUSAll() Returns a non-modifiable List containing all current existing repetitions of PRODUCT_STATUS.
int	getPRODUCT_STATUSReps() Returns the number of existing repetitions of PRODUCT_STATUS
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
BTS_O31_TIMING	getTIMING() Returns the first repetition of TIMING (a Group object) - creates it if necessary
BTS_O31_TIMING	getTIMING(int rep) Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<BTS_O31_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"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertPRODUCT_STATUS(BTS_O31_PRODUCT_STATUS structure, int rep) Inserts a specific repetition of PRODUCT_STATUS (a Group object)
BTS_O31_PRODUCT_STATUS	insertPRODUCT_STATUS(int rep) Inserts a specific repetition of PRODUCT_STATUS (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)
void	insertTIMING(BTS_O31_TIMING structure, int rep) Inserts a specific repetition of TIMING (a Group object)
BTS_O31_TIMING	insertTIMING(int rep) Inserts a specific repetition of TIMING (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
BTS_O31_PRODUCT_STATUS	removePRODUCT_STATUS(int rep) Removes a specific repetition of PRODUCT_STATUS (a Group object)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)
BTS_O31_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

BTS_O31_ORDER

public BTS_O31_ORDER(Group parent,
                     ModelClassFactory factory)

Creates a new BTS_O31_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 BTS_O31_TIMING getTIMING()

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

getTIMING

public BTS_O31_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<BTS_O31_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(BTS_O31_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 BTS_O31_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 BTS_O31_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

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPRODUCT_STATUS

public BTS_O31_PRODUCT_STATUS getPRODUCT_STATUS()

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

getPRODUCT_STATUS

public BTS_O31_PRODUCT_STATUS getPRODUCT_STATUS(int rep)

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

getPRODUCT_STATUSReps

public int getPRODUCT_STATUSReps()

Returns the number of existing repetitions of PRODUCT_STATUS

getPRODUCT_STATUSAll

public List<BTS_O31_PRODUCT_STATUS> getPRODUCT_STATUSAll()
                                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertPRODUCT_STATUS

public void insertPRODUCT_STATUS(BTS_O31_PRODUCT_STATUS structure,
                                 int rep)
                          throws HL7Exception

Inserts a specific repetition of PRODUCT_STATUS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRODUCT_STATUS

public BTS_O31_PRODUCT_STATUS insertPRODUCT_STATUS(int rep)
                                            throws HL7Exception

Inserts a specific repetition of PRODUCT_STATUS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRODUCT_STATUS

public BTS_O31_PRODUCT_STATUS removePRODUCT_STATUS(int rep)
                                            throws HL7Exception

Removes a specific repetition of PRODUCT_STATUS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)