Package ca.uhn.hl7v2.model.v251.message

Class ADT_A45

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.ADT_A45

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class ADT_A45
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: EVN (Event Type)
• 4: PID (Patient Identification)
• 5: PD1 (Patient Additional Demographic) optional
• 6: ADT_A45_MERGE_INFO (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_A45()	Creates a new ADT_A45 message with DefaultModelClassFactory.
ADT_A45(ModelClassFactory factory)	Creates a new ADT_A45 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
EVN	getEVN()	Returns EVN (Event Type) - creates it if necessary
ADT_A45_MERGE_INFO	getMERGE_INFO()	Returns the first repetition of MERGE_INFO (a Group object) - creates it if necessary
ADT_A45_MERGE_INFO	getMERGE_INFO(int rep)	Returns a specific repetition of MERGE_INFO (a Group object) - creates it if necessary
List<ADT_A45_MERGE_INFO>	getMERGE_INFOAll()	Returns a non-modifiable List containing all current existing repetitions of MERGE_INFO.
int	getMERGE_INFOReps()	Returns the number of existing repetitions of MERGE_INFO
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
String	getVersion()	Returns "2.5.1"
ADT_A45_MERGE_INFO	insertMERGE_INFO(int rep)	Inserts a specific repetition of MERGE_INFO (a Group object)
void	insertMERGE_INFO(ADT_A45_MERGE_INFO structure, int rep)	Inserts a specific repetition of MERGE_INFO (a Group object)
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)
ADT_A45_MERGE_INFO	removeMERGE_INFO(int rep)	Removes a specific repetition of MERGE_INFO (a Group object)
SFT	removeSFT(int rep)	Removes a specific repetition of SFT (Software Segment)

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_A45

public ADT_A45()

Creates a new ADT_A45 message with DefaultModelClassFactory.

ADT_A45

public ADT_A45(ModelClassFactory factory)

Creates a new ADT_A45 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

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)

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

getMERGE_INFO

public ADT_A45_MERGE_INFO getMERGE_INFO()

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

getMERGE_INFO

public ADT_A45_MERGE_INFO getMERGE_INFO(int rep)

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

getMERGE_INFOReps

public int getMERGE_INFOReps()

Returns the number of existing repetitions of MERGE_INFO

getMERGE_INFOAll

public List<ADT_A45_MERGE_INFO> getMERGE_INFOAll()
                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertMERGE_INFO

public void insertMERGE_INFO(ADT_A45_MERGE_INFO structure,
 int rep)
                      throws HL7Exception

Inserts a specific repetition of MERGE_INFO (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertMERGE_INFO

public ADT_A45_MERGE_INFO insertMERGE_INFO(int rep)
                                    throws HL7Exception

Inserts a specific repetition of MERGE_INFO (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeMERGE_INFO

public ADT_A45_MERGE_INFO removeMERGE_INFO(int rep)
                                    throws HL7Exception

Removes a specific repetition of MERGE_INFO (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)