ADT_A15 (HAPI - Java HL7 API - Generated Structures v2.8 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.v28.message.ADT_A15

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable
```
public class ADT_A15
extends AbstractMessage
```
Represents a ADT_A15 message structure (see chapter 3.3.15). This structure contains the following elements:
- 1: MSH (Message Header)
- 2: SFT (Software Segment) optional repeating
- 3: UAC (User Authentication Credential Segment) optional
- 4: EVN (Event Type)
- 5: PID (Patient Identification)
- 6: PD1 (Patient Additional Demographic) optional
- 7: ARV (Access Restriction) optional repeating
- 8: ROL (Role) optional repeating
- 9: PV1 (Patient Visit)
- 10: PV2 (Patient Visit - Additional Information) optional
- 11: ARV (Access Restriction) optional repeating
- 12: ROL (Role) optional repeating
- 13: DB1 (Disability) optional repeating
- 14: OBX (Observation/Result) optional repeating
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description
`ADT_A15()` Creates a new ADT_A15 message with DefaultModelClassFactory.
`ADT_A15(ModelClassFactory factory)` Creates a new ADT_A15 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
`ARV`	`getARV2()` Returns the first repetition of ARV2 (Access Restriction) - creates it if necessary
`ARV`	`getARV2(int rep)` Returns a specific repetition of ARV2 (Access Restriction) - creates it if necessary
`List<ARV>`	`getARV2All()` Returns a non-modifiable List containing all current existing repetitions of ARV2.
`int`	`getARV2Reps()` Returns the number of existing repetitions of ARV2
`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
`DB1`	`getDB1()` Returns the first repetition of DB1 (Disability) - creates it if necessary
`DB1`	`getDB1(int rep)` Returns a specific repetition of DB1 (Disability) - creates it if necessary
`List<DB1>`	`getDB1All()` Returns a non-modifiable List containing all current existing repetitions of DB1.
`int`	`getDB1Reps()` Returns the number of existing repetitions of DB1
`EVN`	`getEVN()` Returns EVN (Event Type) - creates it if necessary
`MSH`	`getMSH()` Returns MSH (Message Header) - creates it if necessary
`OBX`	`getOBX()` Returns the first repetition of OBX (Observation/Result) - creates it if necessary
`OBX`	`getOBX(int rep)` Returns a specific repetition of OBX (Observation/Result) - creates it if necessary
`List<OBX>`	`getOBXAll()` Returns a non-modifiable List containing all current existing repetitions of OBX.
`int`	`getOBXReps()` Returns the number of existing repetitions of OBX
`PD1`	`getPD1()` Returns PD1 (Patient Additional Demographic) - creates it if necessary
`PID`	`getPID()` Returns PID (Patient Identification) - creates it if necessary
`PV1`	`getPV1()` Returns PV1 (Patient Visit) - creates it if necessary
`PV2`	`getPV2()` Returns PV2 (Patient Visit - Additional Information) - creates it if necessary
`ROL`	`getROL()` Returns the first repetition of ROL (Role) - creates it if necessary
`ROL`	`getROL(int rep)` Returns a specific repetition of ROL (Role) - creates it if necessary
`ROL`	`getROL2()` Returns the first repetition of ROL2 (Role) - creates it if necessary
`ROL`	`getROL2(int rep)` Returns a specific repetition of ROL2 (Role) - creates it if necessary
`List<ROL>`	`getROL2All()` Returns a non-modifiable List containing all current existing repetitions of ROL2.
`int`	`getROL2Reps()` Returns the number of existing repetitions of ROL2
`List<ROL>`	`getROLAll()` Returns a non-modifiable List containing all current existing repetitions of ROL.
`int`	`getROLReps()` Returns the number of existing repetitions of ROL
`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"
`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`	`insertARV2(ARV structure, int rep)` Inserts a specific repetition of ARV2 (Access Restriction)
`ARV`	`insertARV2(int rep)` Inserts a specific repetition of ARV2 (Access Restriction)
`void`	`insertDB1(DB1 structure, int rep)` Inserts a specific repetition of DB1 (Disability)
`DB1`	`insertDB1(int rep)` Inserts a specific repetition of DB1 (Disability)
`OBX`	`insertOBX(int rep)` Inserts a specific repetition of OBX (Observation/Result)
`void`	`insertOBX(OBX structure, int rep)` Inserts a specific repetition of OBX (Observation/Result)
`ROL`	`insertROL(int rep)` Inserts a specific repetition of ROL (Role)
`void`	`insertROL(ROL structure, int rep)` Inserts a specific repetition of ROL (Role)
`ROL`	`insertROL2(int rep)` Inserts a specific repetition of ROL2 (Role)
`void`	`insertROL2(ROL structure, int rep)` Inserts a specific repetition of ROL2 (Role)
`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)
`ARV`	`removeARV2(int rep)` Removes a specific repetition of ARV2 (Access Restriction)
`DB1`	`removeDB1(int rep)` Removes a specific repetition of DB1 (Disability)
`OBX`	`removeOBX(int rep)` Removes a specific repetition of OBX (Observation/Result)
`ROL`	`removeROL(int rep)` Removes a specific repetition of ROL (Role)
`ROL`	`removeROL2(int rep)` Removes a specific repetition of ROL2 (Role)
`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
  - ADT_A15
```
public ADT_A15()
```
    Creates a new ADT_A15 message with DefaultModelClassFactory.
  - ADT_A15
```
public ADT_A15(ModelClassFactory factory)
```
    Creates a new ADT_A15 message with custom ModelClassFactory.
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8"
    
    Specified by:
    
    getVersion in interface Message
    
    Overrides:
    
    getVersion in class AbstractMessage
  - getMSH
```
public MSH getMSH()
```
    Returns MSH (Message Header) - creates it if necessary
  - 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
  - getEVN
```
public EVN getEVN()
```
    Returns EVN (Event Type) - creates it if necessary
  - getPID
```
public PID getPID()
```
    Returns PID (Patient Identification) - creates it if necessary
  - getPD1
```
public PD1 getPD1()
```
    Returns PD1 (Patient Additional Demographic) - 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)
  - getROL
```
public ROL getROL()
```
    Returns the first repetition of ROL (Role) - creates it if necessary
  - getROL
```
public ROL getROL(int rep)
```
    Returns a specific repetition of ROL (Role) - 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.
  - getROLReps
```
public int getROLReps()
```
    Returns the number of existing repetitions of ROL
  - getROLAll
```
public List<ROL> getROLAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ROL.
    
    Note that unlike getROL(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertROL
```
public void insertROL(ROL structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of ROL (Role)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertROL
```
public ROL insertROL(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of ROL (Role)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeROL
```
public ROL removeROL(int rep)
              throws HL7Exception
```
    Removes a specific repetition of ROL (Role)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getPV1
```
public PV1 getPV1()
```
    Returns PV1 (Patient Visit) - creates it if necessary
  - getPV2
```
public PV2 getPV2()
```
    Returns PV2 (Patient Visit - Additional Information) - creates it if necessary
  - getARV2
```
public ARV getARV2()
```
    Returns the first repetition of ARV2 (Access Restriction) - creates it if necessary
  - getARV2
```
public ARV getARV2(int rep)
```
    Returns a specific repetition of ARV2 (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.
  - getARV2Reps
```
public int getARV2Reps()
```
    Returns the number of existing repetitions of ARV2
  - getARV2All
```
public List<ARV> getARV2All()
                     throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ARV2.
    
    Note that unlike getARV2(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertARV2
```
public void insertARV2(ARV structure,
                       int rep)
                throws HL7Exception
```
    Inserts a specific repetition of ARV2 (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertARV2
```
public ARV insertARV2(int rep)
               throws HL7Exception
```
    Inserts a specific repetition of ARV2 (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeARV2
```
public ARV removeARV2(int rep)
               throws HL7Exception
```
    Removes a specific repetition of ARV2 (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getROL2
```
public ROL getROL2()
```
    Returns the first repetition of ROL2 (Role) - creates it if necessary
  - getROL2
```
public ROL getROL2(int rep)
```
    Returns a specific repetition of ROL2 (Role) - 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.
  - getROL2Reps
```
public int getROL2Reps()
```
    Returns the number of existing repetitions of ROL2
  - getROL2All
```
public List<ROL> getROL2All()
                     throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ROL2.
    
    Note that unlike getROL2(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertROL2
```
public void insertROL2(ROL structure,
                       int rep)
                throws HL7Exception
```
    Inserts a specific repetition of ROL2 (Role)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertROL2
```
public ROL insertROL2(int rep)
               throws HL7Exception
```
    Inserts a specific repetition of ROL2 (Role)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeROL2
```
public ROL removeROL2(int rep)
               throws HL7Exception
```
    Removes a specific repetition of ROL2 (Role)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getDB1
```
public DB1 getDB1()
```
    Returns the first repetition of DB1 (Disability) - creates it if necessary
  - getDB1
```
public DB1 getDB1(int rep)
```
    Returns a specific repetition of DB1 (Disability) - 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.
  - getDB1Reps
```
public int getDB1Reps()
```
    Returns the number of existing repetitions of DB1
  - getDB1All
```
public List<DB1> getDB1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of DB1.
    
    Note that unlike getDB1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertDB1
```
public void insertDB1(DB1 structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of DB1 (Disability)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertDB1
```
public DB1 insertDB1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of DB1 (Disability)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeDB1
```
public DB1 removeDB1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of DB1 (Disability)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getOBX
```
public OBX getOBX()
```
    Returns the first repetition of OBX (Observation/Result) - creates it if necessary
  - getOBX
```
public OBX getOBX(int rep)
```
    Returns a specific repetition of OBX (Observation/Result) - 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.
  - getOBXReps
```
public int getOBXReps()
```
    Returns the number of existing repetitions of OBX
  - getOBXAll
```
public List<OBX> getOBXAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of OBX.
    
    Note that unlike getOBX(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertOBX
```
public void insertOBX(OBX structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of OBX (Observation/Result)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertOBX
```
public OBX insertOBX(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of OBX (Observation/Result)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeOBX
```
public OBX removeOBX(int rep)
              throws HL7Exception
```
    Removes a specific repetition of OBX (Observation/Result)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class ADT_A15

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

ADT_A15

ADT_A15

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getEVN

getPID

getPD1

getARV

getARV

getARVReps

getARVAll

insertARV

insertARV

removeARV

getROL

getROL

getROLReps

getROLAll

insertROL

insertROL

removeROL

getPV1

getPV2

getARV2

getARV2

getARV2Reps

getARV2All

insertARV2

insertARV2

removeARV2

getROL2

getROL2

getROL2Reps

getROL2All

insertROL2

insertROL2

removeROL2

getDB1

getDB1

getDB1Reps

getDB1All

insertDB1

insertDB1

removeDB1

getOBX

getOBX

getOBXReps

getOBXAll

insertOBX

insertOBX

removeOBX