Package ca.uhn.hl7v2.model.v23.message

Class ADT_A40

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.ADT_A40

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class ADT_A40
extends AbstractMessage

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

• 1: MSH (Message header segment)
• 2: EVN (Event type)
• 3: ADT_A40_PATIENT (a Group object) repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
EVN	getEVN()	Returns EVN (Event type) - creates it if necessary
MSH	getMSH()	Returns MSH (Message header segment) - creates it if necessary
ADT_A40_PATIENT	getPATIENT()	Returns the first repetition of PATIENT (a Group object) - creates it if necessary
ADT_A40_PATIENT	getPATIENT(int rep)	Returns a specific repetition of PATIENT (a Group object) - creates it if necessary
List<ADT_A40_PATIENT>	getPATIENTAll()	Returns a non-modifiable List containing all current existing repetitions of PATIENT.
int	getPATIENTReps()	Returns the number of existing repetitions of PATIENT
String	getVersion()	Returns "2.3"
ADT_A40_PATIENT	insertPATIENT(int rep)	Inserts a specific repetition of PATIENT (a Group object)
void	insertPATIENT(ADT_A40_PATIENT structure, int rep)	Inserts a specific repetition of PATIENT (a Group object)
ADT_A40_PATIENT	removePATIENT(int rep)	Removes a specific repetition of PATIENT (a Group object)

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

accept, copy, 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 Details

ADT_A40

public ADT_A40()

Creates a new ADT_A40 message with DefaultModelClassFactory.

ADT_A40

public ADT_A40(ModelClassFactory factory)

Creates a new ADT_A40 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.3"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message header segment) - creates it if necessary

getEVN

public EVN getEVN()

Returns EVN (Event type) - creates it if necessary

getPATIENT

public ADT_A40_PATIENT getPATIENT()

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

getPATIENT

public ADT_A40_PATIENT getPATIENT(int rep)

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

getPATIENTReps

public int getPATIENTReps()

Returns the number of existing repetitions of PATIENT

getPATIENTAll

public List<ADT_A40_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_A40_PATIENT structure,
 int rep)
                   throws HL7Exception

Inserts a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPATIENT

public ADT_A40_PATIENT insertPATIENT(int rep)
                              throws HL7Exception

Inserts a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePATIENT

public ADT_A40_PATIENT removePATIENT(int rep)
                              throws HL7Exception

Removes a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)