ca.uhn.hl7v2.model.v281.group

Class RDS_O13_ORDER_DETAIL_SUPPLEMENT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.RDS_O13_ORDER_DETAIL_SUPPLEMENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RDS_O13_ORDER_DETAIL_SUPPLEMENT
extends AbstractGroup

Represents a RDS_O13_ORDER_DETAIL_SUPPLEMENT 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: NTE (Notes and Comments) repeating
• 2: RXR (Pharmacy/Treatment Route) repeating
• 3: RDS_O13_COMPONENT (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
RDS_O13_ORDER_DETAIL_SUPPLEMENT(Group parent, ModelClassFactory factory) Creates a new RDS_O13_ORDER_DETAIL_SUPPLEMENT group

Method Summary

Modifier and Type	Method and Description
RDS_O13_COMPONENT	getCOMPONENT() Returns the first repetition of COMPONENT (a Group object) - creates it if necessary
RDS_O13_COMPONENT	getCOMPONENT(int rep) Returns a specific repetition of COMPONENT (a Group object) - creates it if necessary
List<RDS_O13_COMPONENT>	getCOMPONENTAll() Returns a non-modifiable List containing all current existing repetitions of COMPONENT.
int	getCOMPONENTReps() Returns the number of existing repetitions of COMPONENT
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
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"
RDS_O13_COMPONENT	insertCOMPONENT(int rep) Inserts a specific repetition of COMPONENT (a Group object)
void	insertCOMPONENT(RDS_O13_COMPONENT structure, int rep) Inserts a specific repetition of COMPONENT (a Group object)
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
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)
RDS_O13_COMPONENT	removeCOMPONENT(int rep) Removes a specific repetition of COMPONENT (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
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

RDS_O13_ORDER_DETAIL_SUPPLEMENT

public RDS_O13_ORDER_DETAIL_SUPPLEMENT(Group parent,
                                       ModelClassFactory factory)

Creates a new RDS_O13_ORDER_DETAIL_SUPPLEMENT group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

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)

getCOMPONENT

public RDS_O13_COMPONENT getCOMPONENT()

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

getCOMPONENT

public RDS_O13_COMPONENT getCOMPONENT(int rep)

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

getCOMPONENTReps

public int getCOMPONENTReps()

Returns the number of existing repetitions of COMPONENT

getCOMPONENTAll

public List<RDS_O13_COMPONENT> getCOMPONENTAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertCOMPONENT

public void insertCOMPONENT(RDS_O13_COMPONENT structure,
                            int rep)
                     throws HL7Exception

Inserts a specific repetition of COMPONENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCOMPONENT

public RDS_O13_COMPONENT insertCOMPONENT(int rep)
                                  throws HL7Exception

Inserts a specific repetition of COMPONENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCOMPONENT

public RDS_O13_COMPONENT removeCOMPONENT(int rep)
                                  throws HL7Exception

Removes a specific repetition of COMPONENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)