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

Class RAS_O17_ADMINISTRATION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.RAS_O17_ADMINISTRATION

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RAS_O17_ADMINISTRATION
extends AbstractGroup

Represents a RAS_O17_ADMINISTRATION 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: RAS_O17_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	Description
RAS_O17_ADMINISTRATION(Group parent, ModelClassFactory factory)	Creates a new RAS_O17_ADMINISTRATION group

Method Summary

Modifier and Type	Method	Description
RAS_O17_OBSERVATION	getOBSERVATION()	Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
RAS_O17_OBSERVATION	getOBSERVATION(int rep)	Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<RAS_O17_OBSERVATION>	getOBSERVATIONAll()	Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
int	getOBSERVATIONReps()	Returns the number of existing repetitions of 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.5.1"
RAS_O17_OBSERVATION	insertOBSERVATION(int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(RAS_O17_OBSERVATION structure, int rep)	Inserts a specific repetition of 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)
RAS_O17_OBSERVATION	removeOBSERVATION(int rep)	Removes a specific repetition of 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 Details

RAS_O17_ADMINISTRATION

public RAS_O17_ADMINISTRATION(Group parent,
 ModelClassFactory factory)

Creates a new RAS_O17_ADMINISTRATION group

Method Details

getVersion

public String getVersion()

Returns "2.5.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

getOBSERVATION

public RAS_O17_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public RAS_O17_OBSERVATION getOBSERVATION(int rep)

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

getOBSERVATIONReps

public int getOBSERVATIONReps()

Returns the number of existing repetitions of OBSERVATION

getOBSERVATIONAll

public List<RAS_O17_OBSERVATION> getOBSERVATIONAll()
                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertOBSERVATION

public void insertOBSERVATION(RAS_O17_OBSERVATION structure,
 int rep)
                       throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION

public RAS_O17_OBSERVATION insertOBSERVATION(int rep)
                                      throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION

public RAS_O17_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)