RCI_I05 (HAPI - 04 - Generated Structures v2.3.1 2.0 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.AbstractMessage
    - - ca.uhn.hl7v2.model.v231.message.RCI_I05

All Implemented Interfaces:

Group, Message, Structure, Serializable
```
public class RCI_I05
extends AbstractMessage
```
Represents a RCI_I05 message structure (see chapter ?). This structure contains the following elements:
- 1: MSH (MSH - message header segment)
- 2: MSA (MSA - message acknowledgment segment)
- 3: QRD (QRD - original-style query definition segment)
- 4: QRF (QRF - original style query filter segment) optional
- 5: RCI_I05_PRDCTD (a Group object) repeating
- 6: PID (PID - patient identification segment)
- 7: DG1 (DG1 - diagnosis segment) optional repeating
- 8: DRG (DRG - diagnosis related group segment) optional repeating
- 9: AL1 (AL1 - patient allergy information segment) optional repeating
- 10: RCI_I05_OBRNTEOBXNTE (a Group object) optional repeating
- 11: NTE (NTE - notes and comments segment) optional repeating
See Also:
Serialized Form

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

Constructor Summary

Constructors
Constructor and Description
`RCI_I05()` Creates a new RCI_I05 message with DefaultModelClassFactory.
`RCI_I05(ModelClassFactory factory)` Creates a new RCI_I05 message with custom ModelClassFactory.

Method Summary

Methods
Modifier and Type	Method and Description
`AL1`	`getAL1()` Returns the first repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
`AL1`	`getAL1(int rep)` Returns a specific repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
`List<AL1>`	`getAL1All()` Returns a non-modifiable List containing all current existing repetitions of AL1.
`int`	`getAL1Reps()` Returns the number of existing repetitions of AL1
`DG1`	`getDG1()` Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
`DG1`	`getDG1(int rep)` Returns a specific repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
`List<DG1>`	`getDG1All()` Returns a non-modifiable List containing all current existing repetitions of DG1.
`int`	`getDG1Reps()` Returns the number of existing repetitions of DG1
`DRG`	`getDRG()` Returns the first repetition of DRG (DRG - diagnosis related group segment) - creates it if necessary
`DRG`	`getDRG(int rep)` Returns a specific repetition of DRG (DRG - diagnosis related group segment) - creates it if necessary
`List<DRG>`	`getDRGAll()` Returns a non-modifiable List containing all current existing repetitions of DRG.
`int`	`getDRGReps()` Returns the number of existing repetitions of DRG
`MSA`	`getMSA()` Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
`MSH`	`getMSH()` Returns MSH (MSH - message header segment) - creates it if necessary
`NTE`	`getNTE()` Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
`NTE`	`getNTE(int rep)` Returns a specific repetition of NTE (NTE - notes and comments segment) - 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
`RCI_I05_OBRNTEOBXNTE`	`getOBRNTEOBXNTE()` Returns the first repetition of OBRNTEOBXNTE (a Group object) - creates it if necessary
`RCI_I05_OBRNTEOBXNTE`	`getOBRNTEOBXNTE(int rep)` Returns a specific repetition of OBRNTEOBXNTE (a Group object) - creates it if necessary
`List<RCI_I05_OBRNTEOBXNTE>`	`getOBRNTEOBXNTEAll()` Returns a non-modifiable List containing all current existing repetitions of OBRNTEOBXNTE.
`int`	`getOBRNTEOBXNTEReps()` Returns the number of existing repetitions of OBRNTEOBXNTE
`PID`	`getPID()` Returns PID (PID - patient identification segment) - creates it if necessary
`RCI_I05_PRDCTD`	`getPRDCTD()` Returns the first repetition of PRDCTD (a Group object) - creates it if necessary
`RCI_I05_PRDCTD`	`getPRDCTD(int rep)` Returns a specific repetition of PRDCTD (a Group object) - creates it if necessary
`List<RCI_I05_PRDCTD>`	`getPRDCTDAll()` Returns a non-modifiable List containing all current existing repetitions of PRDCTD.
`int`	`getPRDCTDReps()` Returns the number of existing repetitions of PRDCTD
`QRD`	`getQRD()` Returns QRD (QRD - original-style query definition segment) - creates it if necessary
`QRF`	`getQRF()` Returns QRF (QRF - original style query filter segment) - creates it if necessary
`String`	`getVersion()` Returns "2.3.1"
`void`	`insertAL1(AL1 structure, int rep)` Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
`AL1`	`insertAL1(int rep)` Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
`void`	`insertDG1(DG1 structure, int rep)` Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
`DG1`	`insertDG1(int rep)` Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
`void`	`insertDRG(DRG structure, int rep)` Inserts a specific repetition of DRG (DRG - diagnosis related group segment)
`DRG`	`insertDRG(int rep)` Inserts a specific repetition of DRG (DRG - diagnosis related group segment)
`NTE`	`insertNTE(int rep)` Inserts a specific repetition of NTE (NTE - notes and comments segment)
`void`	`insertNTE(NTE structure, int rep)` Inserts a specific repetition of NTE (NTE - notes and comments segment)
`RCI_I05_OBRNTEOBXNTE`	`insertOBRNTEOBXNTE(int rep)` Inserts a specific repetition of OBRNTEOBXNTE (a Group object)
`void`	`insertOBRNTEOBXNTE(RCI_I05_OBRNTEOBXNTE structure, int rep)` Inserts a specific repetition of OBRNTEOBXNTE (a Group object)
`RCI_I05_PRDCTD`	`insertPRDCTD(int rep)` Inserts a specific repetition of PRDCTD (a Group object)
`void`	`insertPRDCTD(RCI_I05_PRDCTD structure, int rep)` Inserts a specific repetition of PRDCTD (a Group object)
`AL1`	`removeAL1(int rep)` Removes a specific repetition of AL1 (AL1 - patient allergy information segment)
`DG1`	`removeDG1(int rep)` Removes a specific repetition of DG1 (DG1 - diagnosis segment)
`DRG`	`removeDRG(int rep)` Removes a specific repetition of DRG (DRG - diagnosis related group segment)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (NTE - notes and comments segment)
`RCI_I05_OBRNTEOBXNTE`	`removeOBRNTEOBXNTE(int rep)` Removes a specific repetition of OBRNTEOBXNTE (a Group object)
`RCI_I05_PRDCTD`	`removePRDCTD(int rep)` Removes a specific repetition of PRDCTD (a Group object)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage
encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Group
addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isGroup, isRepeating, isRequired

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

- Constructor Detail
  - RCI_I05
```
public RCI_I05()
```
    Creates a new RCI_I05 message with DefaultModelClassFactory.
  - RCI_I05
```
public RCI_I05(ModelClassFactory factory)
```
    Creates a new RCI_I05 message with custom ModelClassFactory.
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.3.1"
    
    Specified by:
    
    getVersion in interface Message
    
    Overrides:
    
    getVersion in class AbstractMessage
  - getMSH
```
public MSH getMSH()
```
    Returns MSH (MSH - message header segment) - creates it if necessary
  - getMSA
```
public MSA getMSA()
```
    Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
  - getQRD
```
public QRD getQRD()
```
    Returns QRD (QRD - original-style query definition segment) - creates it if necessary
  - getQRF
```
public QRF getQRF()
```
    Returns QRF (QRF - original style query filter segment) - creates it if necessary
  - getPRDCTD
```
public RCI_I05_PRDCTD getPRDCTD()
```
    Returns the first repetition of PRDCTD (a Group object) - creates it if necessary
  - getPRDCTD
```
public RCI_I05_PRDCTD getPRDCTD(int rep)
```
    Returns a specific repetition of PRDCTD (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.
  - getPRDCTDReps
```
public int getPRDCTDReps()
```
    Returns the number of existing repetitions of PRDCTD
  - getPRDCTDAll
```
public List<RCI_I05_PRDCTD> getPRDCTDAll()
                                  throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PRDCTD.
    
    Note that unlike getPRDCTD(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPRDCTD
```
public void insertPRDCTD(RCI_I05_PRDCTD structure,
                int rep)
                  throws HL7Exception
```
    Inserts a specific repetition of PRDCTD (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertPRDCTD
```
public RCI_I05_PRDCTD insertPRDCTD(int rep)
                            throws HL7Exception
```
    Inserts a specific repetition of PRDCTD (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removePRDCTD
```
public RCI_I05_PRDCTD removePRDCTD(int rep)
                            throws HL7Exception
```
    Removes a specific repetition of PRDCTD (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getPID
```
public PID getPID()
```
    Returns PID (PID - patient identification segment) - creates it if necessary
  - getDG1
```
public DG1 getDG1()
```
    Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
  - getDG1
```
public DG1 getDG1(int rep)
```
    Returns a specific repetition of DG1 (DG1 - diagnosis segment) - 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.
  - getDG1Reps
```
public int getDG1Reps()
```
    Returns the number of existing repetitions of DG1
  - getDG1All
```
public List<DG1> getDG1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of DG1.
    
    Note that unlike getDG1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertDG1
```
public void insertDG1(DG1 structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertDG1
```
public DG1 insertDG1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeDG1
```
public DG1 removeDG1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of DG1 (DG1 - diagnosis segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getDRG
```
public DRG getDRG()
```
    Returns the first repetition of DRG (DRG - diagnosis related group segment) - creates it if necessary
  - getDRG
```
public DRG getDRG(int rep)
```
    Returns a specific repetition of DRG (DRG - diagnosis related group segment) - 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.
  - getDRGReps
```
public int getDRGReps()
```
    Returns the number of existing repetitions of DRG
  - getDRGAll
```
public List<DRG> getDRGAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of DRG.
    
    Note that unlike getDRG(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertDRG
```
public void insertDRG(DRG structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of DRG (DRG - diagnosis related group segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertDRG
```
public DRG insertDRG(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of DRG (DRG - diagnosis related group segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeDRG
```
public DRG removeDRG(int rep)
              throws HL7Exception
```
    Removes a specific repetition of DRG (DRG - diagnosis related group segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getAL1
```
public AL1 getAL1()
```
    Returns the first repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
  - getAL1
```
public AL1 getAL1(int rep)
```
    Returns a specific repetition of AL1 (AL1 - patient allergy information segment) - 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.
  - getAL1Reps
```
public int getAL1Reps()
```
    Returns the number of existing repetitions of AL1
  - getAL1All
```
public List<AL1> getAL1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of AL1.
    
    Note that unlike getAL1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertAL1
```
public void insertAL1(AL1 structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertAL1
```
public AL1 insertAL1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeAL1
```
public AL1 removeAL1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of AL1 (AL1 - patient allergy information segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getOBRNTEOBXNTE
```
public RCI_I05_OBRNTEOBXNTE getOBRNTEOBXNTE()
```
    Returns the first repetition of OBRNTEOBXNTE (a Group object) - creates it if necessary
  - getOBRNTEOBXNTE
```
public RCI_I05_OBRNTEOBXNTE getOBRNTEOBXNTE(int rep)
```
    Returns a specific repetition of OBRNTEOBXNTE (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.
  - getOBRNTEOBXNTEReps
```
public int getOBRNTEOBXNTEReps()
```
    Returns the number of existing repetitions of OBRNTEOBXNTE
  - getOBRNTEOBXNTEAll
```
public List<RCI_I05_OBRNTEOBXNTE> getOBRNTEOBXNTEAll()
                                              throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of OBRNTEOBXNTE.
    
    Note that unlike getOBRNTEOBXNTE(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertOBRNTEOBXNTE
```
public void insertOBRNTEOBXNTE(RCI_I05_OBRNTEOBXNTE structure,
                      int rep)
                        throws HL7Exception
```
    Inserts a specific repetition of OBRNTEOBXNTE (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertOBRNTEOBXNTE
```
public RCI_I05_OBRNTEOBXNTE insertOBRNTEOBXNTE(int rep)
                                        throws HL7Exception
```
    Inserts a specific repetition of OBRNTEOBXNTE (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeOBRNTEOBXNTE
```
public RCI_I05_OBRNTEOBXNTE removeOBRNTEOBXNTE(int rep)
                                        throws HL7Exception
```
    Removes a specific repetition of OBRNTEOBXNTE (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getNTE
```
public NTE getNTE()
```
    Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
  - getNTE
```
public NTE getNTE(int rep)
```
    Returns a specific repetition of NTE (NTE - notes and comments segment) - 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 (NTE - notes and comments segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertNTE
```
public NTE insertNTE(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of NTE (NTE - notes and comments segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeNTE
```
public NTE removeNTE(int rep)
              throws HL7Exception
```
    Removes a specific repetition of NTE (NTE - notes and comments segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)

Class RCI_I05

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

RCI_I05

RCI_I05

Method Detail

getVersion

getMSH

getMSA

getQRD

getQRF

getPRDCTD

getPRDCTD

getPRDCTDReps

getPRDCTDAll

insertPRDCTD

insertPRDCTD

removePRDCTD

getPID

getDG1

getDG1

getDG1Reps

getDG1All

insertDG1

insertDG1

removeDG1

getDRG

getDRG

getDRGReps

getDRGAll

insertDRG

insertDRG

removeDRG

getAL1

getAL1

getAL1Reps

getAL1All

insertAL1

insertAL1

removeAL1

getOBRNTEOBXNTE

getOBRNTEOBXNTE

getOBRNTEOBXNTEReps

getOBRNTEOBXNTEAll

insertOBRNTEOBXNTE

insertOBRNTEOBXNTE

removeOBRNTEOBXNTE

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE