RRI_I12 (HAPI - 04 - Generated Structures v2.3 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.v23.message.RRI_I12

All Implemented Interfaces:

Group, Message, Structure, Serializable
```
public class RRI_I12
extends AbstractMessage
```
Represents a RRI_I12 message structure (see chapter ?). This structure contains the following elements:
- 1: MSH (Message header segment)
- 2: MSA (Message acknowledgement segment) optional
- 3: RF1 (Referral Information Segment) optional
- 4: RRI_I12_AUTHORIZATION (a Group object) optional
- 5: RRI_I12_PROVIDER (a Group object) repeating
- 6: PID (Patient Identification)
- 7: ACC (Accident) optional
- 8: DG1 (Diagnosis) optional repeating
- 9: DRG (Diagnosis Related Group) optional repeating
- 10: AL1 (Patient allergy information) optional repeating
- 11: RRI_I12_PROCEDURE (a Group object) optional repeating
- 12: RRI_I12_RESULTS (a Group object) optional repeating
- 13: RRI_I12_VISIT (a Group object) optional
- 14: 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
`RRI_I12()` Creates a new RRI_I12 message with DefaultModelClassFactory.
`RRI_I12(ModelClassFactory factory)` Creates a new RRI_I12 message with custom ModelClassFactory.

Method Summary

Methods
Modifier and Type	Method and Description
`ACC`	`getACC()` Returns ACC (Accident) - creates it if necessary
`AL1`	`getAL1()` Returns the first repetition of AL1 (Patient allergy information) - creates it if necessary
`AL1`	`getAL1(int rep)` Returns a specific repetition of AL1 (Patient allergy information) - 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
`RRI_I12_AUTHORIZATION`	`getAUTHORIZATION()` Returns AUTHORIZATION (a Group object) - creates it if necessary
`DG1`	`getDG1()` Returns the first repetition of DG1 (Diagnosis) - creates it if necessary
`DG1`	`getDG1(int rep)` Returns a specific repetition of DG1 (Diagnosis) - 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 (Diagnosis Related Group) - creates it if necessary
`DRG`	`getDRG(int rep)` Returns a specific repetition of DRG (Diagnosis Related Group) - 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 (Message acknowledgement segment) - creates it if necessary
`MSH`	`getMSH()` Returns MSH (Message header segment) - creates it if necessary
`NTE`	`getNTE()` Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary
`NTE`	`getNTE(int rep)` Returns a specific repetition of 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
`PID`	`getPID()` Returns PID (Patient Identification) - creates it if necessary
`RRI_I12_PROCEDURE`	`getPROCEDURE()` Returns the first repetition of PROCEDURE (a Group object) - creates it if necessary
`RRI_I12_PROCEDURE`	`getPROCEDURE(int rep)` Returns a specific repetition of PROCEDURE (a Group object) - creates it if necessary
`List<RRI_I12_PROCEDURE>`	`getPROCEDUREAll()` Returns a non-modifiable List containing all current existing repetitions of PROCEDURE.
`int`	`getPROCEDUREReps()` Returns the number of existing repetitions of PROCEDURE
`RRI_I12_PROVIDER`	`getPROVIDER()` Returns the first repetition of PROVIDER (a Group object) - creates it if necessary
`RRI_I12_PROVIDER`	`getPROVIDER(int rep)` Returns a specific repetition of PROVIDER (a Group object) - creates it if necessary
`List<RRI_I12_PROVIDER>`	`getPROVIDERAll()` Returns a non-modifiable List containing all current existing repetitions of PROVIDER.
`int`	`getPROVIDERReps()` Returns the number of existing repetitions of PROVIDER
`RRI_I12_RESULTS`	`getRESULTS()` Returns the first repetition of RESULTS (a Group object) - creates it if necessary
`RRI_I12_RESULTS`	`getRESULTS(int rep)` Returns a specific repetition of RESULTS (a Group object) - creates it if necessary
`List<RRI_I12_RESULTS>`	`getRESULTSAll()` Returns a non-modifiable List containing all current existing repetitions of RESULTS.
`int`	`getRESULTSReps()` Returns the number of existing repetitions of RESULTS
`RF1`	`getRF1()` Returns RF1 (Referral Information Segment) - creates it if necessary
`String`	`getVersion()` Returns "2.3"
`RRI_I12_VISIT`	`getVISIT()` Returns VISIT (a Group object) - creates it if necessary
`void`	`insertAL1(AL1 structure, int rep)` Inserts a specific repetition of AL1 (Patient allergy information)
`AL1`	`insertAL1(int rep)` Inserts a specific repetition of AL1 (Patient allergy information)
`void`	`insertDG1(DG1 structure, int rep)` Inserts a specific repetition of DG1 (Diagnosis)
`DG1`	`insertDG1(int rep)` Inserts a specific repetition of DG1 (Diagnosis)
`void`	`insertDRG(DRG structure, int rep)` Inserts a specific repetition of DRG (Diagnosis Related Group)
`DRG`	`insertDRG(int rep)` Inserts a specific repetition of DRG (Diagnosis Related Group)
`NTE`	`insertNTE(int rep)` Inserts a specific repetition of NTE (Notes and comments segment)
`void`	`insertNTE(NTE structure, int rep)` Inserts a specific repetition of NTE (Notes and comments segment)
`RRI_I12_PROCEDURE`	`insertPROCEDURE(int rep)` Inserts a specific repetition of PROCEDURE (a Group object)
`void`	`insertPROCEDURE(RRI_I12_PROCEDURE structure, int rep)` Inserts a specific repetition of PROCEDURE (a Group object)
`RRI_I12_PROVIDER`	`insertPROVIDER(int rep)` Inserts a specific repetition of PROVIDER (a Group object)
`void`	`insertPROVIDER(RRI_I12_PROVIDER structure, int rep)` Inserts a specific repetition of PROVIDER (a Group object)
`RRI_I12_RESULTS`	`insertRESULTS(int rep)` Inserts a specific repetition of RESULTS (a Group object)
`void`	`insertRESULTS(RRI_I12_RESULTS structure, int rep)` Inserts a specific repetition of RESULTS (a Group object)
`AL1`	`removeAL1(int rep)` Removes a specific repetition of AL1 (Patient allergy information)
`DG1`	`removeDG1(int rep)` Removes a specific repetition of DG1 (Diagnosis)
`DRG`	`removeDRG(int rep)` Removes a specific repetition of DRG (Diagnosis Related Group)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and comments segment)
`RRI_I12_PROCEDURE`	`removePROCEDURE(int rep)` Removes a specific repetition of PROCEDURE (a Group object)
`RRI_I12_PROVIDER`	`removePROVIDER(int rep)` Removes a specific repetition of PROVIDER (a Group object)
`RRI_I12_RESULTS`	`removeRESULTS(int rep)` Removes a specific repetition of RESULTS (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
  - RRI_I12
```
public RRI_I12()
```
    Creates a new RRI_I12 message with DefaultModelClassFactory.
  - RRI_I12
```
public RRI_I12(ModelClassFactory factory)
```
    Creates a new RRI_I12 message with custom ModelClassFactory.
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.3"
    
    Specified by:
    
    getVersion in interface Message
    
    Overrides:
    
    getVersion in class AbstractMessage
  - getMSH
```
public MSH getMSH()
```
    Returns MSH (Message header segment) - creates it if necessary
  - getMSA
```
public MSA getMSA()
```
    Returns MSA (Message acknowledgement segment) - creates it if necessary
  - getRF1
```
public RF1 getRF1()
```
    Returns RF1 (Referral Information Segment) - creates it if necessary
  - getAUTHORIZATION
```
public RRI_I12_AUTHORIZATION getAUTHORIZATION()
```
    Returns AUTHORIZATION (a Group object) - creates it if necessary
  - getPROVIDER
```
public RRI_I12_PROVIDER getPROVIDER()
```
    Returns the first repetition of PROVIDER (a Group object) - creates it if necessary
  - getPROVIDER
```
public RRI_I12_PROVIDER getPROVIDER(int rep)
```
    Returns a specific repetition of PROVIDER (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.
  - getPROVIDERReps
```
public int getPROVIDERReps()
```
    Returns the number of existing repetitions of PROVIDER
  - getPROVIDERAll
```
public List<RRI_I12_PROVIDER> getPROVIDERAll()
                                      throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PROVIDER.
    
    Note that unlike getPROVIDER(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPROVIDER
```
public void insertPROVIDER(RRI_I12_PROVIDER structure,
                  int rep)
                    throws HL7Exception
```
    Inserts a specific repetition of PROVIDER (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertPROVIDER
```
public RRI_I12_PROVIDER insertPROVIDER(int rep)
                                throws HL7Exception
```
    Inserts a specific repetition of PROVIDER (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removePROVIDER
```
public RRI_I12_PROVIDER removePROVIDER(int rep)
                                throws HL7Exception
```
    Removes a specific repetition of PROVIDER (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getPID
```
public PID getPID()
```
    Returns PID (Patient Identification) - creates it if necessary
  - getACC
```
public ACC getACC()
```
    Returns ACC (Accident) - creates it if necessary
  - getDG1
```
public DG1 getDG1()
```
    Returns the first repetition of DG1 (Diagnosis) - creates it if necessary
  - getDG1
```
public DG1 getDG1(int rep)
```
    Returns a specific repetition of DG1 (Diagnosis) - 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 (Diagnosis)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertDG1
```
public DG1 insertDG1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of DG1 (Diagnosis)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeDG1
```
public DG1 removeDG1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of DG1 (Diagnosis)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getDRG
```
public DRG getDRG()
```
    Returns the first repetition of DRG (Diagnosis Related Group) - creates it if necessary
  - getDRG
```
public DRG getDRG(int rep)
```
    Returns a specific repetition of DRG (Diagnosis Related Group) - 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 (Diagnosis Related Group)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertDRG
```
public DRG insertDRG(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of DRG (Diagnosis Related Group)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeDRG
```
public DRG removeDRG(int rep)
              throws HL7Exception
```
    Removes a specific repetition of DRG (Diagnosis Related Group)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getAL1
```
public AL1 getAL1()
```
    Returns the first repetition of AL1 (Patient allergy information) - creates it if necessary
  - getAL1
```
public AL1 getAL1(int rep)
```
    Returns a specific repetition of AL1 (Patient allergy 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.
  - 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 (Patient allergy information)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertAL1
```
public AL1 insertAL1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of AL1 (Patient allergy information)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeAL1
```
public AL1 removeAL1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of AL1 (Patient allergy information)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getPROCEDURE
```
public RRI_I12_PROCEDURE getPROCEDURE()
```
    Returns the first repetition of PROCEDURE (a Group object) - creates it if necessary
  - getPROCEDURE
```
public RRI_I12_PROCEDURE getPROCEDURE(int rep)
```
    Returns a specific repetition of PROCEDURE (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.
  - getPROCEDUREReps
```
public int getPROCEDUREReps()
```
    Returns the number of existing repetitions of PROCEDURE
  - getPROCEDUREAll
```
public List<RRI_I12_PROCEDURE> getPROCEDUREAll()
                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PROCEDURE.
    
    Note that unlike getPROCEDURE(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPROCEDURE
```
public void insertPROCEDURE(RRI_I12_PROCEDURE structure,
                   int rep)
                     throws HL7Exception
```
    Inserts a specific repetition of PROCEDURE (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertPROCEDURE
```
public RRI_I12_PROCEDURE insertPROCEDURE(int rep)
                                  throws HL7Exception
```
    Inserts a specific repetition of PROCEDURE (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removePROCEDURE
```
public RRI_I12_PROCEDURE removePROCEDURE(int rep)
                                  throws HL7Exception
```
    Removes a specific repetition of PROCEDURE (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getRESULTS
```
public RRI_I12_RESULTS getRESULTS()
```
    Returns the first repetition of RESULTS (a Group object) - creates it if necessary
  - getRESULTS
```
public RRI_I12_RESULTS getRESULTS(int rep)
```
    Returns a specific repetition of RESULTS (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.
  - getRESULTSReps
```
public int getRESULTSReps()
```
    Returns the number of existing repetitions of RESULTS
  - getRESULTSAll
```
public List<RRI_I12_RESULTS> getRESULTSAll()
                                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of RESULTS.
    
    Note that unlike getRESULTS(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertRESULTS
```
public void insertRESULTS(RRI_I12_RESULTS structure,
                 int rep)
                   throws HL7Exception
```
    Inserts a specific repetition of RESULTS (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertRESULTS
```
public RRI_I12_RESULTS insertRESULTS(int rep)
                              throws HL7Exception
```
    Inserts a specific repetition of RESULTS (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeRESULTS
```
public RRI_I12_RESULTS removeRESULTS(int rep)
                              throws HL7Exception
```
    Removes a specific repetition of RESULTS (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getVISIT
```
public RRI_I12_VISIT getVISIT()
```
    Returns VISIT (a Group object) - creates it if necessary
  - getNTE
```
public NTE getNTE()
```
    Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary
  - getNTE
```
public NTE getNTE(int rep)
```
    Returns a specific repetition of 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 (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 (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 (Notes and comments segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)

Class RRI_I12

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

RRI_I12

RRI_I12

Method Detail

getVersion

getMSH

getMSA

getRF1

getAUTHORIZATION

getPROVIDER

getPROVIDER

getPROVIDERReps

getPROVIDERAll

insertPROVIDER

insertPROVIDER

removePROVIDER

getPID

getACC

getDG1

getDG1

getDG1Reps

getDG1All

insertDG1

insertDG1

removeDG1

getDRG

getDRG

getDRGReps

getDRGAll

insertDRG

insertDRG

removeDRG

getAL1

getAL1

getAL1Reps

getAL1All

insertAL1

insertAL1

removeAL1

getPROCEDURE

getPROCEDURE

getPROCEDUREReps

getPROCEDUREAll

insertPROCEDURE

insertPROCEDURE

removePROCEDURE

getRESULTS

getRESULTS

getRESULTSReps

getRESULTSAll

insertRESULTS

insertRESULTS

removeRESULTS

getVISIT

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE