ca.uhn.hl7v2.model.v28.group

Class BRP_O30_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v28.group.BRP_O30_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class BRP_O30_ORDER
extends AbstractGroup

Represents a BRP_O30_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: BRP_O30_TIMING (a Group object) optional repeating
• 4: BPO (Blood product order) optional
• 5: BPX (Blood product dispense status) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
BPO	getBPO() Returns BPO (Blood product order) - creates it if necessary
BPX	getBPX() Returns the first repetition of BPX (Blood product dispense status) - creates it if necessary
BPX	getBPX(int rep) Returns a specific repetition of BPX (Blood product dispense status) - creates it if necessary
List<BPX>	getBPXAll() Returns a non-modifiable List containing all current existing repetitions of BPX.
int	getBPXReps() Returns the number of existing repetitions of BPX
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
BRP_O30_TIMING	getTIMING() Returns the first repetition of TIMING (a Group object) - creates it if necessary
BRP_O30_TIMING	getTIMING(int rep) Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<BRP_O30_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	insertBPX(BPX structure, int rep) Inserts a specific repetition of BPX (Blood product dispense status)
BPX	insertBPX(int rep) Inserts a specific repetition of BPX (Blood product dispense status)
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(BRP_O30_TIMING structure, int rep) Inserts a specific repetition of TIMING (a Group object)
BRP_O30_TIMING	insertTIMING(int rep) Inserts a specific repetition of TIMING (a Group object)
BPX	removeBPX(int rep) Removes a specific repetition of BPX (Blood product dispense status)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)
BRP_O30_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

BRP_O30_ORDER

public BRP_O30_ORDER(Group parent,
                     ModelClassFactory factory)

Creates a new BRP_O30_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 BRP_O30_TIMING getTIMING()

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

getTIMING

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

getBPX

public BPX getBPX()

Returns the first repetition of BPX (Blood product dispense status) - creates it if necessary

getBPX

public BPX getBPX(int rep)

Returns a specific repetition of BPX (Blood product dispense status) - 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.

getBPXReps

public int getBPXReps()

Returns the number of existing repetitions of BPX

getBPXAll

public List<BPX> getBPXAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertBPX

public void insertBPX(BPX structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of BPX (Blood product dispense status)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertBPX

public BPX insertBPX(int rep)
              throws HL7Exception

Inserts a specific repetition of BPX (Blood product dispense status)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeBPX

public BPX removeBPX(int rep)
              throws HL7Exception

Removes a specific repetition of BPX (Blood product dispense status)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)