Package ca.uhn.hl7v2.model.v24.message

Class SSU_U03

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v24.message.SSU_U03

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class SSU_U03
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: EQU (Equipment Detail)
• 3: SSU_U03_SPECIMEN_CONTAINER (a Group object) repeating
• 4: ROL (Role) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
EQU	getEQU()	Returns EQU (Equipment Detail) - creates it if necessary
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
ROL	getROL()	Returns ROL (Role) - creates it if necessary
SSU_U03_SPECIMEN_CONTAINER	getSPECIMEN_CONTAINER()	Returns the first repetition of SPECIMEN_CONTAINER (a Group object) - creates it if necessary
SSU_U03_SPECIMEN_CONTAINER	getSPECIMEN_CONTAINER(int rep)	Returns a specific repetition of SPECIMEN_CONTAINER (a Group object) - creates it if necessary
List<SSU_U03_SPECIMEN_CONTAINER>	getSPECIMEN_CONTAINERAll()	Returns a non-modifiable List containing all current existing repetitions of SPECIMEN_CONTAINER.
int	getSPECIMEN_CONTAINERReps()	Returns the number of existing repetitions of SPECIMEN_CONTAINER
String	getVersion()	Returns "2.4"
SSU_U03_SPECIMEN_CONTAINER	insertSPECIMEN_CONTAINER(int rep)	Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)
void	insertSPECIMEN_CONTAINER(SSU_U03_SPECIMEN_CONTAINER structure, int rep)	Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)
SSU_U03_SPECIMEN_CONTAINER	removeSPECIMEN_CONTAINER(int rep)	Removes a specific repetition of SPECIMEN_CONTAINER (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

SSU_U03

public SSU_U03()

Creates a new SSU_U03 message with DefaultModelClassFactory.

SSU_U03

public SSU_U03(ModelClassFactory factory)

Creates a new SSU_U03 message with custom ModelClassFactory.

Method Details

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

getEQU

public EQU getEQU()

Returns EQU (Equipment Detail) - creates it if necessary

getSPECIMEN_CONTAINER

public SSU_U03_SPECIMEN_CONTAINER getSPECIMEN_CONTAINER()

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

getSPECIMEN_CONTAINER

public SSU_U03_SPECIMEN_CONTAINER getSPECIMEN_CONTAINER(int rep)

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

getSPECIMEN_CONTAINERReps

public int getSPECIMEN_CONTAINERReps()

Returns the number of existing repetitions of SPECIMEN_CONTAINER

getSPECIMEN_CONTAINERAll

public List<SSU_U03_SPECIMEN_CONTAINER> getSPECIMEN_CONTAINERAll()
                                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertSPECIMEN_CONTAINER

public void insertSPECIMEN_CONTAINER(SSU_U03_SPECIMEN_CONTAINER structure,
 int rep)
                              throws HL7Exception

Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertSPECIMEN_CONTAINER

public SSU_U03_SPECIMEN_CONTAINER insertSPECIMEN_CONTAINER(int rep)
                                                    throws HL7Exception

Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeSPECIMEN_CONTAINER

public SSU_U03_SPECIMEN_CONTAINER removeSPECIMEN_CONTAINER(int rep)
                                                    throws HL7Exception

Removes a specific repetition of SPECIMEN_CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getROL

public ROL getROL()

Returns ROL (Role) - creates it if necessary