ca.uhn.hl7v2.model.v251.group

Class RSP_K31_ORDER_DETAIL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.RSP_K31_ORDER_DETAIL

All Implemented Interfaces:

Group, Structure, Serializable

public class RSP_K31_ORDER_DETAIL
extends AbstractGroup

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

Method Summary

Methods

Modifier and Type	Method and Description
RSP_K31_COMPONENTS	getCOMPONENTS() Returns the first repetition of COMPONENTS (a Group object) - creates it if necessary
RSP_K31_COMPONENTS	getCOMPONENTS(int rep) Returns a specific repetition of COMPONENTS (a Group object) - creates it if necessary
List<RSP_K31_COMPONENTS>	getCOMPONENTSAll() Returns a non-modifiable List containing all current existing repetitions of COMPONENTS.
int	getCOMPONENTSReps() Returns the number of existing repetitions of COMPONENTS
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
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.5.1"
RSP_K31_COMPONENTS	insertCOMPONENTS(int rep) Inserts a specific repetition of COMPONENTS (a Group object)
void	insertCOMPONENTS(RSP_K31_COMPONENTS structure, int rep) Inserts a specific repetition of COMPONENTS (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)
RSP_K31_COMPONENTS	removeCOMPONENTS(int rep) Removes a specific repetition of COMPONENTS (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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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

RSP_K31_ORDER_DETAIL

public RSP_K31_ORDER_DETAIL(Group parent,
                    ModelClassFactory factory)

Creates a new RSP_K31_ORDER_DETAIL group

Method Detail

getVersion

public String getVersion()

Returns "2.5.1"

getRXO

public RXO getRXO()

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

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)

getCOMPONENTS

public RSP_K31_COMPONENTS getCOMPONENTS()

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

getCOMPONENTS

public RSP_K31_COMPONENTS getCOMPONENTS(int rep)

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

getCOMPONENTSReps

public int getCOMPONENTSReps()

Returns the number of existing repetitions of COMPONENTS

getCOMPONENTSAll

public List<RSP_K31_COMPONENTS> getCOMPONENTSAll()
                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertCOMPONENTS

public void insertCOMPONENTS(RSP_K31_COMPONENTS structure,
                    int rep)
                      throws HL7Exception

Inserts a specific repetition of COMPONENTS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCOMPONENTS

public RSP_K31_COMPONENTS insertCOMPONENTS(int rep)
                                    throws HL7Exception

Inserts a specific repetition of COMPONENTS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCOMPONENTS

public RSP_K31_COMPONENTS removeCOMPONENTS(int rep)
                                    throws HL7Exception

Removes a specific repetition of COMPONENTS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)