ca.uhn.hl7v2.model.v25.group

Class PEX_P07_ASSOCIATED_RX_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v25.group.PEX_P07_ASSOCIATED_RX_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class PEX_P07_ASSOCIATED_RX_ORDER
extends AbstractGroup

Represents a PEX_P07_ASSOCIATED_RX_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: RXE (Pharmacy/Treatment Encoded Order)
• 2: PEX_P07_NK1_TIMING_QTY (a Group object) repeating
• 3: RXR (Pharmacy/Treatment Route) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PEX_P07_NK1_TIMING_QTY	getNK1_TIMING_QTY() Returns the first repetition of NK1_TIMING_QTY (a Group object) - creates it if necessary
PEX_P07_NK1_TIMING_QTY	getNK1_TIMING_QTY(int rep) Returns a specific repetition of NK1_TIMING_QTY (a Group object) - creates it if necessary
List<PEX_P07_NK1_TIMING_QTY>	getNK1_TIMING_QTYAll() Returns a non-modifiable List containing all current existing repetitions of NK1_TIMING_QTY.
int	getNK1_TIMING_QTYReps() Returns the number of existing repetitions of NK1_TIMING_QTY
RXE	getRXE() Returns RXE (Pharmacy/Treatment Encoded Order) - creates it if necessary
RXR	getRXR() Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
RXR	getRXR(int rep) Returns a specific repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
List<RXR>	getRXRAll() Returns a non-modifiable List containing all current existing repetitions of RXR.
int	getRXRReps() Returns the number of existing repetitions of RXR
String	getVersion() Returns "2.5"
PEX_P07_NK1_TIMING_QTY	insertNK1_TIMING_QTY(int rep) Inserts a specific repetition of NK1_TIMING_QTY (a Group object)
void	insertNK1_TIMING_QTY(PEX_P07_NK1_TIMING_QTY structure, int rep) Inserts a specific repetition of NK1_TIMING_QTY (a Group object)
RXR	insertRXR(int rep) Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
void	insertRXR(RXR structure, int rep) Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
PEX_P07_NK1_TIMING_QTY	removeNK1_TIMING_QTY(int rep) Removes a specific repetition of NK1_TIMING_QTY (a Group object)
RXR	removeRXR(int rep) Removes a specific repetition of RXR (Pharmacy/Treatment Route)

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

PEX_P07_ASSOCIATED_RX_ORDER

public PEX_P07_ASSOCIATED_RX_ORDER(Group parent,
                                   ModelClassFactory factory)

Creates a new PEX_P07_ASSOCIATED_RX_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.5"

getRXE

public RXE getRXE()

Returns RXE (Pharmacy/Treatment Encoded Order) - creates it if necessary

getNK1_TIMING_QTY

public PEX_P07_NK1_TIMING_QTY getNK1_TIMING_QTY()

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

getNK1_TIMING_QTY

public PEX_P07_NK1_TIMING_QTY getNK1_TIMING_QTY(int rep)

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

getNK1_TIMING_QTYReps

public int getNK1_TIMING_QTYReps()

Returns the number of existing repetitions of NK1_TIMING_QTY

getNK1_TIMING_QTYAll

public List<PEX_P07_NK1_TIMING_QTY> getNK1_TIMING_QTYAll()
                                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertNK1_TIMING_QTY

public void insertNK1_TIMING_QTY(PEX_P07_NK1_TIMING_QTY structure,
                                 int rep)
                          throws HL7Exception

Inserts a specific repetition of NK1_TIMING_QTY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNK1_TIMING_QTY

public PEX_P07_NK1_TIMING_QTY insertNK1_TIMING_QTY(int rep)
                                            throws HL7Exception

Inserts a specific repetition of NK1_TIMING_QTY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNK1_TIMING_QTY

public PEX_P07_NK1_TIMING_QTY removeNK1_TIMING_QTY(int rep)
                                            throws HL7Exception

Removes a specific repetition of NK1_TIMING_QTY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRXR

public RXR getRXR()

Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary

getRXR

public RXR getRXR(int rep)

Returns a specific repetition of RXR (Pharmacy/Treatment Route) - 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.

getRXRReps

public int getRXRReps()

Returns the number of existing repetitions of RXR

getRXRAll

public List<RXR> getRXRAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertRXR

public void insertRXR(RXR structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of RXR (Pharmacy/Treatment Route)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXR

public RXR insertRXR(int rep)
              throws HL7Exception

Inserts a specific repetition of RXR (Pharmacy/Treatment Route)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXR

public RXR removeRXR(int rep)
              throws HL7Exception

Removes a specific repetition of RXR (Pharmacy/Treatment Route)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)