RAS_O17_ENCODING (HAPI - Java HL7 API - Generated Structures v2.8 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v28.group.RAS_O17_ENCODING

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class RAS_O17_ENCODING
extends AbstractGroup
```
Represents a RAS_O17_ENCODING 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: PRT (Participation Information) optional repeating
- 3: NTE (Notes and Comments) optional repeating
- 4: RAS_O17_TIMING_ENCODED (a Group object) repeating
- 5: RXR (Pharmacy/Treatment Route) repeating
- 6: RXC (Pharmacy/Treatment Component Order) optional repeating
- 7: CDO (Cumulative Dosage) optional repeating
See Also:

Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CDO`	`getCDO()` Returns the first repetition of CDO (Cumulative Dosage) - creates it if necessary
`CDO`	`getCDO(int rep)` Returns a specific repetition of CDO (Cumulative Dosage) - creates it if necessary
`List<CDO>`	`getCDOAll()` Returns a non-modifiable List containing all current existing repetitions of CDO.
`int`	`getCDOReps()` Returns the number of existing repetitions of CDO
`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
`PRT`	`getPRT()` Returns the first repetition of PRT (Participation Information) - creates it if necessary
`PRT`	`getPRT(int rep)` Returns a specific repetition of PRT (Participation Information) - creates it if necessary
`List<PRT>`	`getPRTAll()` Returns a non-modifiable List containing all current existing repetitions of PRT.
`int`	`getPRTReps()` Returns the number of existing repetitions of PRT
`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
`RAS_O17_TIMING_ENCODED`	`getTIMING_ENCODED()` Returns the first repetition of TIMING_ENCODED (a Group object) - creates it if necessary
`RAS_O17_TIMING_ENCODED`	`getTIMING_ENCODED(int rep)` Returns a specific repetition of TIMING_ENCODED (a Group object) - creates it if necessary
`List<RAS_O17_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.8"
`void`	`insertCDO(CDO structure, int rep)` Inserts a specific repetition of CDO (Cumulative Dosage)
`CDO`	`insertCDO(int rep)` Inserts a specific repetition of CDO (Cumulative Dosage)
`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)
`PRT`	`insertPRT(int rep)` Inserts a specific repetition of PRT (Participation Information)
`void`	`insertPRT(PRT structure, int rep)` Inserts a specific repetition of PRT (Participation Information)
`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)
`RAS_O17_TIMING_ENCODED`	`insertTIMING_ENCODED(int rep)` Inserts a specific repetition of TIMING_ENCODED (a Group object)
`void`	`insertTIMING_ENCODED(RAS_O17_TIMING_ENCODED structure, int rep)` Inserts a specific repetition of TIMING_ENCODED (a Group object)
`CDO`	`removeCDO(int rep)` Removes a specific repetition of CDO (Cumulative Dosage)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`PRT`	`removePRT(int rep)` Removes a specific repetition of PRT (Participation Information)
`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)
`RAS_O17_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
  - RAS_O17_ENCODING
```
public RAS_O17_ENCODING(Group parent,
                        ModelClassFactory factory)
```
    Creates a new RAS_O17_ENCODING group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8"
  - getRXE
```
public RXE getRXE()
```
    Returns RXE (Pharmacy/Treatment Encoded Order) - creates it if necessary
  - getPRT
```
public PRT getPRT()
```
    Returns the first repetition of PRT (Participation Information) - creates it if necessary
  - getPRT
```
public PRT getPRT(int rep)
```
    Returns a specific repetition of PRT (Participation Information) - 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.
  - getPRTReps
```
public int getPRTReps()
```
    Returns the number of existing repetitions of PRT
  - getPRTAll
```
public List<PRT> getPRTAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PRT.
    
    Note that unlike getPRT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPRT
```
public void insertPRT(PRT structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of PRT (Participation Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertPRT
```
public PRT insertPRT(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of PRT (Participation Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removePRT
```
public PRT removePRT(int rep)
              throws HL7Exception
```
    Removes a specific repetition of PRT (Participation Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - 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)
  - getTIMING_ENCODED
```
public RAS_O17_TIMING_ENCODED getTIMING_ENCODED()
```
    Returns the first repetition of TIMING_ENCODED (a Group object) - creates it if necessary
  - getTIMING_ENCODED
```
public RAS_O17_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<RAS_O17_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(RAS_O17_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 RAS_O17_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 RAS_O17_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)
  - getCDO
```
public CDO getCDO()
```
    Returns the first repetition of CDO (Cumulative Dosage) - creates it if necessary
  - getCDO
```
public CDO getCDO(int rep)
```
    Returns a specific repetition of CDO (Cumulative Dosage) - 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.
  - getCDOReps
```
public int getCDOReps()
```
    Returns the number of existing repetitions of CDO
  - getCDOAll
```
public List<CDO> getCDOAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of CDO.
    
    Note that unlike getCDO(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertCDO
```
public void insertCDO(CDO structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of CDO (Cumulative Dosage)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertCDO
```
public CDO insertCDO(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of CDO (Cumulative Dosage)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeCDO
```
public CDO removeCDO(int rep)
              throws HL7Exception
```
    Removes a specific repetition of CDO (Cumulative Dosage)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class RAS_O17_ENCODING

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

RAS_O17_ENCODING

Method Detail

getVersion

getRXE

getPRT

getPRT

getPRTReps

getPRTAll

insertPRT

insertPRT

removePRT

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

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

getCDO

getCDO

getCDOReps

getCDOAll

insertCDO

insertCDO

removeCDO