OSU_O41 (HAPI - Java HL7 API - Generated Structures v2.8.1 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.v281.message.OSU_O41

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable
```
public class OSU_O41
extends AbstractMessage
```
Represents a OSU_O41 message structure (see chapter 4.4.18). This structure contains the following elements:
- 1: MSH (Message Header)
- 2: MSA (Message Acknowledgment)
- 3: ERR (Error) optional repeating
- 4: SFT (Software Segment) optional repeating
- 5: UAC (User Authentication Credential Segment) optional
- 6: NTE (Notes and Comments) optional repeating
- 7: PID (Patient Identification) optional
- 8: ARV (Access Restriction) optional repeating
- 9: OSU_O41_ORDER_STATUS (a Group object) repeating
See Also:

Serialized Form

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ARV`	`getARV()` Returns the first repetition of ARV (Access Restriction) - creates it if necessary
`ARV`	`getARV(int rep)` Returns a specific repetition of ARV (Access Restriction) - creates it if necessary
`List<ARV>`	`getARVAll()` Returns a non-modifiable List containing all current existing repetitions of ARV.
`int`	`getARVReps()` Returns the number of existing repetitions of ARV
`ERR`	`getERR()` Returns the first repetition of ERR (Error) - creates it if necessary
`ERR`	`getERR(int rep)` Returns a specific repetition of ERR (Error) - creates it if necessary
`List<ERR>`	`getERRAll()` Returns a non-modifiable List containing all current existing repetitions of ERR.
`int`	`getERRReps()` Returns the number of existing repetitions of ERR
`MSA`	`getMSA()` Returns MSA (Message Acknowledgment) - creates it if necessary
`MSH`	`getMSH()` Returns MSH (Message Header) - creates it if necessary
`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
`OSU_O41_ORDER_STATUS`	`getORDER_STATUS()` Returns the first repetition of ORDER_STATUS (a Group object) - creates it if necessary
`OSU_O41_ORDER_STATUS`	`getORDER_STATUS(int rep)` Returns a specific repetition of ORDER_STATUS (a Group object) - creates it if necessary
`List<OSU_O41_ORDER_STATUS>`	`getORDER_STATUSAll()` Returns a non-modifiable List containing all current existing repetitions of ORDER_STATUS.
`int`	`getORDER_STATUSReps()` Returns the number of existing repetitions of ORDER_STATUS
`PID`	`getPID()` Returns PID (Patient Identification) - creates it if necessary
`SFT`	`getSFT()` Returns the first repetition of SFT (Software Segment) - creates it if necessary
`SFT`	`getSFT(int rep)` Returns a specific repetition of SFT (Software Segment) - creates it if necessary
`List<SFT>`	`getSFTAll()` Returns a non-modifiable List containing all current existing repetitions of SFT.
`int`	`getSFTReps()` Returns the number of existing repetitions of SFT
`UAC`	`getUAC()` Returns UAC (User Authentication Credential Segment) - creates it if necessary
`String`	`getVersion()` Returns "2.8.1"
`void`	`insertARV(ARV structure, int rep)` Inserts a specific repetition of ARV (Access Restriction)
`ARV`	`insertARV(int rep)` Inserts a specific repetition of ARV (Access Restriction)
`void`	`insertERR(ERR structure, int rep)` Inserts a specific repetition of ERR (Error)
`ERR`	`insertERR(int rep)` Inserts a specific repetition of ERR (Error)
`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)
`OSU_O41_ORDER_STATUS`	`insertORDER_STATUS(int rep)` Inserts a specific repetition of ORDER_STATUS (a Group object)
`void`	`insertORDER_STATUS(OSU_O41_ORDER_STATUS structure, int rep)` Inserts a specific repetition of ORDER_STATUS (a Group object)
`SFT`	`insertSFT(int rep)` Inserts a specific repetition of SFT (Software Segment)
`void`	`insertSFT(SFT structure, int rep)` Inserts a specific repetition of SFT (Software Segment)
`ARV`	`removeARV(int rep)` Removes a specific repetition of ARV (Access Restriction)
`ERR`	`removeERR(int rep)` Removes a specific repetition of ERR (Error)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`OSU_O41_ORDER_STATUS`	`removeORDER_STATUS(int rep)` Removes a specific repetition of ORDER_STATUS (a Group object)
`SFT`	`removeSFT(int rep)` Removes a specific repetition of SFT (Software Segment)

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
  - OSU_O41
```
public OSU_O41()
```
    Creates a new OSU_O41 message with DefaultModelClassFactory.
  - OSU_O41
```
public OSU_O41(ModelClassFactory factory)
```
    Creates a new OSU_O41 message with custom ModelClassFactory.
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8.1"
    
    Specified by:
    
    getVersion in interface Message
    
    Overrides:
    
    getVersion in class AbstractMessage
  - getMSH
```
public MSH getMSH()
```
    Returns MSH (Message Header) - creates it if necessary
  - getMSA
```
public MSA getMSA()
```
    Returns MSA (Message Acknowledgment) - creates it if necessary
  - getERR
```
public ERR getERR()
```
    Returns the first repetition of ERR (Error) - creates it if necessary
  - getERR
```
public ERR getERR(int rep)
```
    Returns a specific repetition of ERR (Error) - 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.
  - getERRReps
```
public int getERRReps()
```
    Returns the number of existing repetitions of ERR
  - getERRAll
```
public List<ERR> getERRAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ERR.
    
    Note that unlike getERR(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertERR
```
public void insertERR(ERR structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of ERR (Error)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertERR
```
public ERR insertERR(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of ERR (Error)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeERR
```
public ERR removeERR(int rep)
              throws HL7Exception
```
    Removes a specific repetition of ERR (Error)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getSFT
```
public SFT getSFT()
```
    Returns the first repetition of SFT (Software Segment) - creates it if necessary
  - getSFT
```
public SFT getSFT(int rep)
```
    Returns a specific repetition of SFT (Software 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.
  - getSFTReps
```
public int getSFTReps()
```
    Returns the number of existing repetitions of SFT
  - getSFTAll
```
public List<SFT> getSFTAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of SFT.
    
    Note that unlike getSFT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertSFT
```
public void insertSFT(SFT structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertSFT
```
public SFT insertSFT(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeSFT
```
public SFT removeSFT(int rep)
              throws HL7Exception
```
    Removes a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getUAC
```
public UAC getUAC()
```
    Returns UAC (User Authentication Credential Segment) - creates it if necessary
  - 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)
  - getPID
```
public PID getPID()
```
    Returns PID (Patient Identification) - creates it if necessary
  - getARV
```
public ARV getARV()
```
    Returns the first repetition of ARV (Access Restriction) - creates it if necessary
  - getARV
```
public ARV getARV(int rep)
```
    Returns a specific repetition of ARV (Access Restriction) - 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.
  - getARVReps
```
public int getARVReps()
```
    Returns the number of existing repetitions of ARV
  - getARVAll
```
public List<ARV> getARVAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ARV.
    
    Note that unlike getARV(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertARV
```
public void insertARV(ARV structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of ARV (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertARV
```
public ARV insertARV(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of ARV (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeARV
```
public ARV removeARV(int rep)
              throws HL7Exception
```
    Removes a specific repetition of ARV (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getORDER_STATUS
```
public OSU_O41_ORDER_STATUS getORDER_STATUS()
```
    Returns the first repetition of ORDER_STATUS (a Group object) - creates it if necessary
  - getORDER_STATUS
```
public OSU_O41_ORDER_STATUS getORDER_STATUS(int rep)
```
    Returns a specific repetition of ORDER_STATUS (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.
  - getORDER_STATUSReps
```
public int getORDER_STATUSReps()
```
    Returns the number of existing repetitions of ORDER_STATUS
  - getORDER_STATUSAll
```
public List<OSU_O41_ORDER_STATUS> getORDER_STATUSAll()
                                              throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ORDER_STATUS.
    
    Note that unlike getORDER_STATUS(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertORDER_STATUS
```
public void insertORDER_STATUS(OSU_O41_ORDER_STATUS structure,
                               int rep)
                        throws HL7Exception
```
    Inserts a specific repetition of ORDER_STATUS (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertORDER_STATUS
```
public OSU_O41_ORDER_STATUS insertORDER_STATUS(int rep)
                                        throws HL7Exception
```
    Inserts a specific repetition of ORDER_STATUS (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeORDER_STATUS
```
public OSU_O41_ORDER_STATUS removeORDER_STATUS(int rep)
                                        throws HL7Exception
```
    Removes a specific repetition of ORDER_STATUS (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class OSU_O41

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

OSU_O41

OSU_O41

Method Detail

getVersion

getMSH

getMSA

getERR

getERR

getERRReps

getERRAll

insertERR

insertERR

removeERR

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getPID

getARV

getARV

getARVReps

getARVAll

insertARV

insertARV

removeARV

getORDER_STATUS

getORDER_STATUS

getORDER_STATUSReps

getORDER_STATUSAll

insertORDER_STATUS

insertORDER_STATUS

removeORDER_STATUS