ca.uhn.hl7v2.model.v21.message

Class ADT_AXX

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v21.message.ADT_AXX

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class ADT_AXX
extends AbstractMessage

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

• 1: MSH ()
• 2: EVN ()
• 3: PID () optional
• 4: MRG () optional
• 5: PD1 () optional
• 6: NK1 () optional
• 7: PV1 () optional
• 8: DG1 () optional
• 9: ADT_AXX_PATIENT () optional repeating
• 10: NPU () optional
• 11: PID () optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
DG1	getDG1() Returns DG1 () - creates it if necessary
EVN	getEVN() Returns EVN () - creates it if necessary
MRG	getMRG() Returns MRG () - creates it if necessary
MSH	getMSH() Returns MSH () - creates it if necessary
NK1	getNK1() Returns NK1 () - creates it if necessary
NPU	getNPU() Returns NPU () - creates it if necessary
ADT_AXX_PATIENT	getPATIENT() Returns the first repetition of PATIENT () - creates it if necessary
ADT_AXX_PATIENT	getPATIENT(int rep) Returns a specific repetition of PATIENT () - creates it if necessary
List<ADT_AXX_PATIENT>	getPATIENTAll() Returns a non-modifiable List containing all current existing repetitions of PATIENT.
int	getPATIENTReps() Returns the number of existing repetitions of PATIENT
PD1	getPD1() Returns PD1 () - creates it if necessary
PID	getPID() Returns PID () - creates it if necessary
PID	getPID2() Returns PID2 () - creates it if necessary
PV1	getPV1() Returns PV1 () - creates it if necessary
String	getVersion() Returns "2.1"
void	insertPATIENT(ADT_AXX_PATIENT structure, int rep) Inserts a specific repetition of PATIENT ()
ADT_AXX_PATIENT	insertPATIENT(int rep) Inserts a specific repetition of PATIENT ()
ADT_AXX_PATIENT	removePATIENT(int rep) Removes a specific repetition of PATIENT ()

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_AXX

public ADT_AXX()

Creates a new ADT_AXX message with DefaultModelClassFactory.

ADT_AXX

public ADT_AXX(ModelClassFactory factory)

Creates a new ADT_AXX message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH () - creates it if necessary

getEVN

public EVN getEVN()

Returns EVN () - creates it if necessary

getPID

public PID getPID()

Returns PID () - creates it if necessary

getMRG

public MRG getMRG()

Returns MRG () - creates it if necessary

getPD1

public PD1 getPD1()

Returns PD1 () - creates it if necessary

getNK1

public NK1 getNK1()

Returns NK1 () - creates it if necessary

getPV1

public PV1 getPV1()

Returns PV1 () - creates it if necessary

getDG1

public DG1 getDG1()

Returns DG1 () - creates it if necessary

getPATIENT

public ADT_AXX_PATIENT getPATIENT()

Returns the first repetition of PATIENT () - creates it if necessary

getPATIENT

public ADT_AXX_PATIENT getPATIENT(int rep)

Returns a specific repetition of PATIENT () - 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.

getPATIENTReps

public int getPATIENTReps()

Returns the number of existing repetitions of PATIENT

getPATIENTAll

public List<ADT_AXX_PATIENT> getPATIENTAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPATIENT

public void insertPATIENT(ADT_AXX_PATIENT structure,
                 int rep)
                   throws HL7Exception

Inserts a specific repetition of PATIENT ()

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPATIENT

public ADT_AXX_PATIENT insertPATIENT(int rep)
                              throws HL7Exception

Inserts a specific repetition of PATIENT ()

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePATIENT

public ADT_AXX_PATIENT removePATIENT(int rep)
                              throws HL7Exception

Removes a specific repetition of PATIENT ()

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getNPU

public NPU getNPU()

Returns NPU () - creates it if necessary

getPID2

public PID getPID2()

Returns PID2 () - creates it if necessary