ca.uhn.hl7v2.model.v281.group

Class CQU_I19_MEDICATION_ADMINISTRATION_DETAIL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.CQU_I19_MEDICATION_ADMINISTRATION_DETAIL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class CQU_I19_MEDICATION_ADMINISTRATION_DETAIL
extends AbstractGroup

Represents a CQU_I19_MEDICATION_ADMINISTRATION_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: RXA (Pharmacy/Treatment Administration) repeating
• 2: RXR (Pharmacy/Treatment Route)
• 3: CQU_I19_MEDICATION_ADMINISTRATION_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_ADMINISTRATION_DETAIL(Group parent, ModelClassFactory factory) Creates a new CQU_I19_MEDICATION_ADMINISTRATION_DETAIL group

Method Summary

Modifier and Type	Method and Description
CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION	getMEDICATION_ADMINISTRATION_OBSERVATION() Returns the first repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object) - creates it if necessary
CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION	getMEDICATION_ADMINISTRATION_OBSERVATION(int rep) Returns a specific repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object) - creates it if necessary
List<CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION>	getMEDICATION_ADMINISTRATION_OBSERVATIONAll() Returns a non-modifiable List containing all current existing repetitions of MEDICATION_ADMINISTRATION_OBSERVATION.
int	getMEDICATION_ADMINISTRATION_OBSERVATIONReps() Returns the number of existing repetitions of MEDICATION_ADMINISTRATION_OBSERVATION
RXA	getRXA() Returns the first repetition of RXA (Pharmacy/Treatment Administration) - creates it if necessary
RXA	getRXA(int rep) Returns a specific repetition of RXA (Pharmacy/Treatment Administration) - creates it if necessary
List<RXA>	getRXAAll() Returns a non-modifiable List containing all current existing repetitions of RXA.
int	getRXAReps() Returns the number of existing repetitions of RXA
RXR	getRXR() Returns RXR (Pharmacy/Treatment Route) - creates it if necessary
String	getVersion() Returns "2.8.1"
void	insertMEDICATION_ADMINISTRATION_OBSERVATION(CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION structure, int rep) Inserts a specific repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object)
CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION	insertMEDICATION_ADMINISTRATION_OBSERVATION(int rep) Inserts a specific repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object)
RXA	insertRXA(int rep) Inserts a specific repetition of RXA (Pharmacy/Treatment Administration)
void	insertRXA(RXA structure, int rep) Inserts a specific repetition of RXA (Pharmacy/Treatment Administration)
CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION	removeMEDICATION_ADMINISTRATION_OBSERVATION(int rep) Removes a specific repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object)
RXA	removeRXA(int rep) Removes a specific repetition of RXA (Pharmacy/Treatment Administration)

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_ADMINISTRATION_DETAIL

public CQU_I19_MEDICATION_ADMINISTRATION_DETAIL(Group parent,
                                                ModelClassFactory factory)

Creates a new CQU_I19_MEDICATION_ADMINISTRATION_DETAIL group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getRXA

public RXA getRXA()

Returns the first repetition of RXA (Pharmacy/Treatment Administration) - creates it if necessary

getRXA

public RXA getRXA(int rep)

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

getRXAReps

public int getRXAReps()

Returns the number of existing repetitions of RXA

getRXAAll

public List<RXA> getRXAAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertRXA

public void insertRXA(RXA structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of RXA (Pharmacy/Treatment Administration)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXA

public RXA insertRXA(int rep)
              throws HL7Exception

Inserts a specific repetition of RXA (Pharmacy/Treatment Administration)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXA

public RXA removeRXA(int rep)
              throws HL7Exception

Removes a specific repetition of RXA (Pharmacy/Treatment Administration)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRXR

public RXR getRXR()

Returns RXR (Pharmacy/Treatment Route) - creates it if necessary

getMEDICATION_ADMINISTRATION_OBSERVATION

public CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION getMEDICATION_ADMINISTRATION_OBSERVATION()

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

getMEDICATION_ADMINISTRATION_OBSERVATION

public CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION getMEDICATION_ADMINISTRATION_OBSERVATION(int rep)

Returns a specific repetition of MEDICATION_ADMINISTRATION_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_ADMINISTRATION_OBSERVATIONReps

public int getMEDICATION_ADMINISTRATION_OBSERVATIONReps()

Returns the number of existing repetitions of MEDICATION_ADMINISTRATION_OBSERVATION

getMEDICATION_ADMINISTRATION_OBSERVATIONAll

public List<CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION> getMEDICATION_ADMINISTRATION_OBSERVATIONAll()
                                                                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertMEDICATION_ADMINISTRATION_OBSERVATION

public void insertMEDICATION_ADMINISTRATION_OBSERVATION(CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION structure,
                                                        int rep)
                                                 throws HL7Exception

Inserts a specific repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertMEDICATION_ADMINISTRATION_OBSERVATION

public CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION insertMEDICATION_ADMINISTRATION_OBSERVATION(int rep)
                                                                                          throws HL7Exception

Inserts a specific repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeMEDICATION_ADMINISTRATION_OBSERVATION

public CQU_I19_MEDICATION_ADMINISTRATION_OBSERVATION removeMEDICATION_ADMINISTRATION_OBSERVATION(int rep)
                                                                                          throws HL7Exception

Removes a specific repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)