ca.uhn.hl7v2.model.v24.message

Class ADT_A60

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v24.message.ADT_A60

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class ADT_A60
extends AbstractMessage

Represents a ADT_A60 message structure (see chapter 3). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: EVN (Event Type)
• 3: PID (Patient identification)
• 4: PV1 (Patient visit) optional
• 5: PV2 (Patient visit - additional information) optional
• 6: IAM (Patient adverse reaction information - unique iden) 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_A60() Creates a new ADT_A60 message with DefaultModelClassFactory.
ADT_A60(ModelClassFactory factory) Creates a new ADT_A60 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
EVN	getEVN() Returns EVN (Event Type) - creates it if necessary
IAM	getIAM() Returns the first repetition of IAM (Patient adverse reaction information - unique iden) - creates it if necessary
IAM	getIAM(int rep) Returns a specific repetition of IAM (Patient adverse reaction information - unique iden) - creates it if necessary
List<IAM>	getIAMAll() Returns a non-modifiable List containing all current existing repetitions of IAM.
int	getIAMReps() Returns the number of existing repetitions of IAM
MSH	getMSH() Returns MSH (Message Header) - 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
String	getVersion() Returns "2.4"
void	insertIAM(IAM structure, int rep) Inserts a specific repetition of IAM (Patient adverse reaction information - unique iden)
IAM	insertIAM(int rep) Inserts a specific repetition of IAM (Patient adverse reaction information - unique iden)
IAM	removeIAM(int rep) Removes a specific repetition of IAM (Patient adverse reaction information - unique iden)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage

encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, setValidationContext, 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, 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, isChoiceElement, isGroup, isRepeating, isRequired

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

getName, isEmpty

Constructor Detail

ADT_A60

public ADT_A60()

Creates a new ADT_A60 message with DefaultModelClassFactory.

ADT_A60

public ADT_A60(ModelClassFactory factory)

Creates a new ADT_A60 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - 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

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

getIAM

public IAM getIAM()

Returns the first repetition of IAM (Patient adverse reaction information - unique iden) - creates it if necessary

getIAM

public IAM getIAM(int rep)

Returns a specific repetition of IAM (Patient adverse reaction information - unique iden) - 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.

getIAMReps

public int getIAMReps()

Returns the number of existing repetitions of IAM

getIAMAll

public List<IAM> getIAMAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of IAM.

Note that unlike getIAM(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertIAM

public void insertIAM(IAM structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of IAM (Patient adverse reaction information - unique iden)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertIAM

public IAM insertIAM(int rep)
              throws HL7Exception

Inserts a specific repetition of IAM (Patient adverse reaction information - unique iden)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeIAM

public IAM removeIAM(int rep)
              throws HL7Exception

Removes a specific repetition of IAM (Patient adverse reaction information - unique iden)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)