RQI_I03 (HAPI - Java HL7 API - Generated Structures v2.3 2.3 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.RQI_I03

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable
```
public class RQI_I03
extends AbstractMessage
```
Represents a RQI_I03 message structure (see chapter ?). This structure contains the following elements:
- 1: MSH (Message header segment)
- 2: RQI_I03_PROVIDER (a Group object) repeating
- 3: PID (Patient Identification)
- 4: NK1 (Next of kin) optional repeating
- 5: RQI_I03_GUARANTOR_INSURANCE (a Group object) optional
- 6: 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
`RQI_I03()` Creates a new RQI_I03 message with DefaultModelClassFactory.
`RQI_I03(ModelClassFactory factory)` Creates a new RQI_I03 message with custom ModelClassFactory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RQI_I03_GUARANTOR_INSURANCE`	`getGUARANTOR_INSURANCE()` Returns GUARANTOR_INSURANCE (a Group object) - creates it if necessary
`MSH`	`getMSH()` Returns MSH (Message header segment) - creates it if necessary
`NK1`	`getNK1()` Returns the first repetition of NK1 (Next of kin) - creates it if necessary
`NK1`	`getNK1(int rep)` Returns a specific repetition of NK1 (Next of kin) - creates it if necessary
`List<NK1>`	`getNK1All()` Returns a non-modifiable List containing all current existing repetitions of NK1.
`int`	`getNK1Reps()` Returns the number of existing repetitions of NK1
`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
`RQI_I03_PROVIDER`	`getPROVIDER()` Returns the first repetition of PROVIDER (a Group object) - creates it if necessary
`RQI_I03_PROVIDER`	`getPROVIDER(int rep)` Returns a specific repetition of PROVIDER (a Group object) - creates it if necessary
`List<RQI_I03_PROVIDER>`	`getPROVIDERAll()` Returns a non-modifiable List containing all current existing repetitions of PROVIDER.
`int`	`getPROVIDERReps()` Returns the number of existing repetitions of PROVIDER
`String`	`getVersion()` Returns "2.3"
`NK1`	`insertNK1(int rep)` Inserts a specific repetition of NK1 (Next of kin)
`void`	`insertNK1(NK1 structure, int rep)` Inserts a specific repetition of NK1 (Next of kin)
`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)
`RQI_I03_PROVIDER`	`insertPROVIDER(int rep)` Inserts a specific repetition of PROVIDER (a Group object)
`void`	`insertPROVIDER(RQI_I03_PROVIDER structure, int rep)` Inserts a specific repetition of PROVIDER (a Group object)
`NK1`	`removeNK1(int rep)` Removes a specific repetition of NK1 (Next of kin)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and comments segment)
`RQI_I03_PROVIDER`	`removePROVIDER(int rep)` Removes a specific repetition of PROVIDER (a Group object)

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

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup
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 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, isChoiceElement, isGroup, isRepeating, isRequired

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

Methods inherited from interface ca.uhn.hl7v2.model.Visitable
isEmpty, provideLocation

- Constructor Detail
  - RQI_I03
```
public RQI_I03()
```
    Creates a new RQI_I03 message with DefaultModelClassFactory.
  - RQI_I03
```
public RQI_I03(ModelClassFactory factory)
```
    Creates a new RQI_I03 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
  - getPROVIDER
```
public RQI_I03_PROVIDER getPROVIDER()
```
    Returns the first repetition of PROVIDER (a Group object) - creates it if necessary
  - getPROVIDER
```
public RQI_I03_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<RQI_I03_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(RQI_I03_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 RQI_I03_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 RQI_I03_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
  - getNK1
```
public NK1 getNK1()
```
    Returns the first repetition of NK1 (Next of kin) - creates it if necessary
  - getNK1
```
public NK1 getNK1(int rep)
```
    Returns a specific repetition of NK1 (Next of kin) - 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.
  - getNK1Reps
```
public int getNK1Reps()
```
    Returns the number of existing repetitions of NK1
  - getNK1All
```
public List<NK1> getNK1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of NK1.
    
    Note that unlike getNK1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertNK1
```
public void insertNK1(NK1 structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of NK1 (Next of kin)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertNK1
```
public NK1 insertNK1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of NK1 (Next of kin)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeNK1
```
public NK1 removeNK1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of NK1 (Next of kin)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getGUARANTOR_INSURANCE
```
public RQI_I03_GUARANTOR_INSURANCE getGUARANTOR_INSURANCE()
```
    Returns GUARANTOR_INSURANCE (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 RQI_I03

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

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

Constructor Detail

RQI_I03

RQI_I03

Method Detail

getVersion

getMSH

getPROVIDER

getPROVIDER

getPROVIDERReps

getPROVIDERAll

insertPROVIDER

insertPROVIDER

removePROVIDER

getPID

getNK1

getNK1

getNK1Reps

getNK1All

insertNK1

insertNK1

removeNK1

getGUARANTOR_INSURANCE

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE