ca.uhn.hl7v2.model.v281.group

Class CQU_I19_MEDICATION_ORDER_DETAIL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.CQU_I19_MEDICATION_ORDER_DETAIL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class CQU_I19_MEDICATION_ORDER_DETAIL
extends AbstractGroup

Represents a CQU_I19_MEDICATION_ORDER_DETAIL 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: RXO (Pharmacy/Treatment Order)
• 2: RXR (Pharmacy/Treatment Route) repeating
• 3: RXC (Pharmacy/Treatment Component Order) optional repeating
• 4: CQU_I19_MEDICATION_ORDER_OBSERVATION (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
CQU_I19_MEDICATION_ORDER_DETAIL(Group parent, ModelClassFactory factory) Creates a new CQU_I19_MEDICATION_ORDER_DETAIL group

Method Summary

Modifier and Type	Method and Description
CQU_I19_MEDICATION_ORDER_OBSERVATION	getMEDICATION_ORDER_OBSERVATION() Returns the first repetition of MEDICATION_ORDER_OBSERVATION (a Group object) - creates it if necessary
CQU_I19_MEDICATION_ORDER_OBSERVATION	getMEDICATION_ORDER_OBSERVATION(int rep) Returns a specific repetition of MEDICATION_ORDER_OBSERVATION (a Group object) - creates it if necessary
List<CQU_I19_MEDICATION_ORDER_OBSERVATION>	getMEDICATION_ORDER_OBSERVATIONAll() Returns a non-modifiable List containing all current existing repetitions of MEDICATION_ORDER_OBSERVATION.
int	getMEDICATION_ORDER_OBSERVATIONReps() Returns the number of existing repetitions of MEDICATION_ORDER_OBSERVATION
RXC	getRXC() Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
RXC	getRXC(int rep) Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
List<RXC>	getRXCAll() Returns a non-modifiable List containing all current existing repetitions of RXC.
int	getRXCReps() Returns the number of existing repetitions of RXC
RXO	getRXO() Returns RXO (Pharmacy/Treatment 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.8.1"
void	insertMEDICATION_ORDER_OBSERVATION(CQU_I19_MEDICATION_ORDER_OBSERVATION structure, int rep) Inserts a specific repetition of MEDICATION_ORDER_OBSERVATION (a Group object)
CQU_I19_MEDICATION_ORDER_OBSERVATION	insertMEDICATION_ORDER_OBSERVATION(int rep) Inserts a specific repetition of MEDICATION_ORDER_OBSERVATION (a Group object)
RXC	insertRXC(int rep) Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
void	insertRXC(RXC structure, int rep) Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
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)
CQU_I19_MEDICATION_ORDER_OBSERVATION	removeMEDICATION_ORDER_OBSERVATION(int rep) Removes a specific repetition of MEDICATION_ORDER_OBSERVATION (a Group object)
RXC	removeRXC(int rep) Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
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

CQU_I19_MEDICATION_ORDER_DETAIL

public CQU_I19_MEDICATION_ORDER_DETAIL(Group parent,
                                       ModelClassFactory factory)

Creates a new CQU_I19_MEDICATION_ORDER_DETAIL group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getRXO

public RXO getRXO()

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

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)

getRXC

public RXC getRXC()

Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary

getRXC

public RXC getRXC(int rep)

Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - 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.

getRXCReps

public int getRXCReps()

Returns the number of existing repetitions of RXC

getRXCAll

public List<RXC> getRXCAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertRXC

public void insertRXC(RXC structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXC

public RXC insertRXC(int rep)
              throws HL7Exception

Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXC

public RXC removeRXC(int rep)
              throws HL7Exception

Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getMEDICATION_ORDER_OBSERVATION

public CQU_I19_MEDICATION_ORDER_OBSERVATION getMEDICATION_ORDER_OBSERVATION()

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

getMEDICATION_ORDER_OBSERVATION

public CQU_I19_MEDICATION_ORDER_OBSERVATION getMEDICATION_ORDER_OBSERVATION(int rep)

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

getMEDICATION_ORDER_OBSERVATIONReps

public int getMEDICATION_ORDER_OBSERVATIONReps()

Returns the number of existing repetitions of MEDICATION_ORDER_OBSERVATION

getMEDICATION_ORDER_OBSERVATIONAll

public List<CQU_I19_MEDICATION_ORDER_OBSERVATION> getMEDICATION_ORDER_OBSERVATIONAll()
                                                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertMEDICATION_ORDER_OBSERVATION

public void insertMEDICATION_ORDER_OBSERVATION(CQU_I19_MEDICATION_ORDER_OBSERVATION structure,
                                               int rep)
                                        throws HL7Exception

Inserts a specific repetition of MEDICATION_ORDER_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertMEDICATION_ORDER_OBSERVATION

public CQU_I19_MEDICATION_ORDER_OBSERVATION insertMEDICATION_ORDER_OBSERVATION(int rep)
                                                                        throws HL7Exception

Inserts a specific repetition of MEDICATION_ORDER_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeMEDICATION_ORDER_OBSERVATION

public CQU_I19_MEDICATION_ORDER_OBSERVATION removeMEDICATION_ORDER_OBSERVATION(int rep)
                                                                        throws HL7Exception

Removes a specific repetition of MEDICATION_ORDER_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)