ca.uhn.hl7v2.model.v24.group
Class RSP_Z82_ORDER_DETAIL

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v24.group.RSP_Z82_ORDER_DETAIL

All Implemented Interfaces:

Group, Structure, Serializable

public class RSP_Z82_ORDER_DETAIL
extends AbstractGroup

Represents a RSP_Z82_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_Z82_TREATMENT (a Group object) optional

See Also:

Serialized Form

Constructor Summary

RSP_Z82_ORDER_DETAIL(Group parent, ModelClassFactory factory)
Creates a new RSP_Z82_ORDER_DETAIL group

Method Summary

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
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
int	getRXRReps() Returns the number of existing repetitions of RXR
RSP_Z82_TREATMENT	getTREATMENT() Returns TREATMENT (a Group object) - creates it if necessary
String	getVersion() Returns "2.4"
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)
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, getClass, getMessage, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RSP_Z82_ORDER_DETAIL

public RSP_Z82_ORDER_DETAIL(Group parent,
                            ModelClassFactory factory)

Creates a new RSP_Z82_ORDER_DETAIL group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

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

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

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)

getTREATMENT

public RSP_Z82_TREATMENT getTREATMENT()

Returns TREATMENT (a Group object) - creates it if necessary