ca.uhn.hl7v2.model.v26.message

Class ADT_A30

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v26.message.ADT_A30

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class ADT_A30
extends AbstractMessage

Represents a ADT_A30 message structure (see chapter 3.3.30). 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: MRG (Merge Patient Information)

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
ADT_A30() Creates a new ADT_A30 message with DefaultModelClassFactory.
ADT_A30(ModelClassFactory factory) Creates a new ADT_A30 message with custom ModelClassFactory.

Method Summary

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
EVN	getEVN() Returns EVN (Event Type) - creates it if necessary
MRG	getMRG() Returns MRG (Merge Patient Information) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
PD1	getPD1() Returns PD1 (Patient Additional Demographic) - creates it if necessary
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.6"
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)
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)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

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

ADT_A30

public ADT_A30()

Creates a new ADT_A30 message with DefaultModelClassFactory.

ADT_A30

public ADT_A30(ModelClassFactory factory)

Creates a new ADT_A30 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.6"

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)

getMRG

public MRG getMRG()

Returns MRG (Merge Patient Information) - creates it if necessary