Package ca.uhn.hl7v2.model.v251.group

Class BPS_O29_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.BPS_O29_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class BPS_O29_ORDER
extends AbstractGroup

Represents a BPS_O29_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: BPS_O29_TIMING (a Group object) optional repeating
• 3: BPO (Blood product order)
• 4: NTE (Notes and Comments) optional repeating
• 5: BPS_O29_PRODUCT (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
BPS_O29_ORDER(Group parent, ModelClassFactory factory)	Creates a new BPS_O29_ORDER group

Method Summary

Modifier and Type	Method	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
BPS_O29_PRODUCT	getPRODUCT()	Returns the first repetition of PRODUCT (a Group object) - creates it if necessary
BPS_O29_PRODUCT	getPRODUCT(int rep)	Returns a specific repetition of PRODUCT (a Group object) - creates it if necessary
List<BPS_O29_PRODUCT>	getPRODUCTAll()	Returns a non-modifiable List containing all current existing repetitions of PRODUCT.
int	getPRODUCTReps()	Returns the number of existing repetitions of PRODUCT
BPS_O29_TIMING	getTIMING()	Returns the first repetition of TIMING (a Group object) - creates it if necessary
BPS_O29_TIMING	getTIMING(int rep)	Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<BPS_O29_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.5.1"
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)
BPS_O29_PRODUCT	insertPRODUCT(int rep)	Inserts a specific repetition of PRODUCT (a Group object)
void	insertPRODUCT(BPS_O29_PRODUCT structure, int rep)	Inserts a specific repetition of PRODUCT (a Group object)
BPS_O29_TIMING	insertTIMING(int rep)	Inserts a specific repetition of TIMING (a Group object)
void	insertTIMING(BPS_O29_TIMING structure, int rep)	Inserts a specific repetition of TIMING (a Group object)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and Comments)
BPS_O29_PRODUCT	removePRODUCT(int rep)	Removes a specific repetition of PRODUCT (a Group object)
BPS_O29_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 Details

BPS_O29_ORDER

public BPS_O29_ORDER(Group parent,
 ModelClassFactory factory)

Creates a new BPS_O29_ORDER group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getTIMING

public BPS_O29_TIMING getTIMING()

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

getTIMING

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

public BPS_O29_PRODUCT getPRODUCT()

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

getPRODUCT

public BPS_O29_PRODUCT getPRODUCT(int rep)

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

getPRODUCTReps

public int getPRODUCTReps()

Returns the number of existing repetitions of PRODUCT

getPRODUCTAll

public List<BPS_O29_PRODUCT> getPRODUCTAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRODUCT

public void insertPRODUCT(BPS_O29_PRODUCT structure,
 int rep)
                   throws HL7Exception

Inserts a specific repetition of PRODUCT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPRODUCT

public BPS_O29_PRODUCT insertPRODUCT(int rep)
                              throws HL7Exception

Inserts a specific repetition of PRODUCT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePRODUCT

public BPS_O29_PRODUCT removePRODUCT(int rep)
                              throws HL7Exception

Removes a specific repetition of PRODUCT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)