RSP_Z88_ORDER_ENCODED (HAPI - Java HL7 API - Generated Structures v2.7 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v27.group.RSP_Z88_ORDER_ENCODED

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class RSP_Z88_ORDER_ENCODED
extends AbstractGroup
```
Represents a RSP_Z88_ORDER_ENCODED 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: RXE (Pharmacy/Treatment Encoded Order)
- 2: RSP_Z88_TIMING_ENCODED (a Group object) optional repeating
- 3: RXR (Pharmacy/Treatment Route) repeating
- 4: RXC (Pharmacy/Treatment Component Order) 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_Z88_ORDER_ENCODED(Group parent, ModelClassFactory factory)
Creates a new RSP_Z88_ORDER_ENCODED group

Constructors
Constructor and Description
`RSP_Z88_ORDER_ENCODED(Group parent, ModelClassFactory factory)` Creates a new RSP_Z88_ORDER_ENCODED group

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RXC`	`getRXC()` Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
`RXC`	`getRXC(int rep)` Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
`List<RXC>`	`getRXCAll()` Returns a non-modifiable List containing all current existing repetitions of RXC.
`int`	`getRXCReps()` Returns the number of existing repetitions of RXC
`RXE`	`getRXE()` Returns RXE (Pharmacy/Treatment Encoded 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
`RSP_Z88_TIMING_ENCODED`	`getTIMING_ENCODED()` Returns the first repetition of TIMING_ENCODED (a Group object) - creates it if necessary
`RSP_Z88_TIMING_ENCODED`	`getTIMING_ENCODED(int rep)` Returns a specific repetition of TIMING_ENCODED (a Group object) - creates it if necessary
`List<RSP_Z88_TIMING_ENCODED>`	`getTIMING_ENCODEDAll()` Returns a non-modifiable List containing all current existing repetitions of TIMING_ENCODED.
`int`	`getTIMING_ENCODEDReps()` Returns the number of existing repetitions of TIMING_ENCODED
`String`	`getVersion()` Returns "2.7"
`RXC`	`insertRXC(int rep)` Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
`void`	`insertRXC(RXC structure, int rep)` Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
`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_Z88_TIMING_ENCODED`	`insertTIMING_ENCODED(int rep)` Inserts a specific repetition of TIMING_ENCODED (a Group object)
`void`	`insertTIMING_ENCODED(RSP_Z88_TIMING_ENCODED structure, int rep)` Inserts a specific repetition of TIMING_ENCODED (a Group object)
`RXC`	`removeRXC(int rep)` Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
`RXR`	`removeRXR(int rep)` Removes a specific repetition of RXR (Pharmacy/Treatment Route)
`RSP_Z88_TIMING_ENCODED`	`removeTIMING_ENCODED(int rep)` Removes a specific repetition of TIMING_ENCODED (a Group object)

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
  - RSP_Z88_ORDER_ENCODED
```
public RSP_Z88_ORDER_ENCODED(Group parent,
                             ModelClassFactory factory)
```
    Creates a new RSP_Z88_ORDER_ENCODED group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.7"
  - getRXE
```
public RXE getRXE()
```
    Returns RXE (Pharmacy/Treatment Encoded Order) - creates it if necessary
  - getTIMING_ENCODED
```
public RSP_Z88_TIMING_ENCODED getTIMING_ENCODED()
```
    Returns the first repetition of TIMING_ENCODED (a Group object) - creates it if necessary
  - getTIMING_ENCODED
```
public RSP_Z88_TIMING_ENCODED getTIMING_ENCODED(int rep)
```
    Returns a specific repetition of TIMING_ENCODED (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.
  - getTIMING_ENCODEDReps
```
public int getTIMING_ENCODEDReps()
```
    Returns the number of existing repetitions of TIMING_ENCODED
  - getTIMING_ENCODEDAll
```
public List<RSP_Z88_TIMING_ENCODED> getTIMING_ENCODEDAll()
                                                  throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of TIMING_ENCODED.
    
    Note that unlike getTIMING_ENCODED(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertTIMING_ENCODED
```
public void insertTIMING_ENCODED(RSP_Z88_TIMING_ENCODED structure,
                                 int rep)
                          throws HL7Exception
```
    Inserts a specific repetition of TIMING_ENCODED (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertTIMING_ENCODED
```
public RSP_Z88_TIMING_ENCODED insertTIMING_ENCODED(int rep)
                                            throws HL7Exception
```
    Inserts a specific repetition of TIMING_ENCODED (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeTIMING_ENCODED
```
public RSP_Z88_TIMING_ENCODED removeTIMING_ENCODED(int rep)
                                            throws HL7Exception
```
    Removes a specific repetition of TIMING_ENCODED (a Group object)
    
    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)
  - getRXC
```
public RXC getRXC()
```
    Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
  - getRXC
```
public RXC getRXC(int rep)
```
    Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - 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.
  - getRXCReps
```
public int getRXCReps()
```
    Returns the number of existing repetitions of RXC
  - getRXCAll
```
public List<RXC> getRXCAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of RXC.
    
    Note that unlike getRXC(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertRXC
```
public void insertRXC(RXC structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertRXC
```
public RXC insertRXC(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeRXC
```
public RXC removeRXC(int rep)
              throws HL7Exception
```
    Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class RSP_Z88_ORDER_ENCODED

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.hl7v2.model.Structure

Constructor Detail

RSP_Z88_ORDER_ENCODED

Method Detail

getVersion

getRXE

getTIMING_ENCODED

getTIMING_ENCODED

getTIMING_ENCODEDReps

getTIMING_ENCODEDAll

insertTIMING_ENCODED

insertTIMING_ENCODED

removeTIMING_ENCODED

getRXR

getRXR

getRXRReps

getRXRAll

insertRXR

insertRXR

removeRXR

getRXC

getRXC

getRXCReps

getRXCAll

insertRXC

insertRXC

removeRXC