RAS_O17_ORDER_DETAIL_SUPPLEMENT (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.RAS_O17_ORDER_DETAIL_SUPPLEMENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class RAS_O17_ORDER_DETAIL_SUPPLEMENT
extends AbstractGroup
```
Represents a RAS_O17_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: RAS_O17_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
`RAS_O17_ORDER_DETAIL_SUPPLEMENT(Group parent, ModelClassFactory factory)` Creates a new RAS_O17_ORDER_DETAIL_SUPPLEMENT group

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RAS_O17_COMPONENTS`	`getCOMPONENTS()` Returns the first repetition of COMPONENTS (a Group object) - creates it if necessary
`RAS_O17_COMPONENTS`	`getCOMPONENTS(int rep)` Returns a specific repetition of COMPONENTS (a Group object) - creates it if necessary
`List<RAS_O17_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
`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.7"
`RAS_O17_COMPONENTS`	`insertCOMPONENTS(int rep)` Inserts a specific repetition of COMPONENTS (a Group object)
`void`	`insertCOMPONENTS(RAS_O17_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)
`RAS_O17_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
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_ORDER_DETAIL_SUPPLEMENT
```
public RAS_O17_ORDER_DETAIL_SUPPLEMENT(Group parent,
                                       ModelClassFactory factory)
```
    Creates a new RAS_O17_ORDER_DETAIL_SUPPLEMENT group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.7"
  - 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 RAS_O17_COMPONENTS getCOMPONENTS()
```
    Returns the first repetition of COMPONENTS (a Group object) - creates it if necessary
  - getCOMPONENTS
```
public RAS_O17_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<RAS_O17_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(RAS_O17_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 RAS_O17_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 RAS_O17_COMPONENTS removeCOMPONENTS(int rep)
                                    throws HL7Exception
```
    Removes a specific repetition of COMPONENTS (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class RAS_O17_ORDER_DETAIL_SUPPLEMENT

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_ORDER_DETAIL_SUPPLEMENT

Method Detail

getVersion

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getRXR

getRXR

getRXRReps

getRXRAll

insertRXR

insertRXR

removeRXR

getCOMPONENTS

getCOMPONENTS

getCOMPONENTSReps

getCOMPONENTSAll

insertCOMPONENTS

insertCOMPONENTS

removeCOMPONENTS