ca.uhn.hl7v2.model.v26.message

Class SSR_U04

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v26.message.SSR_U04

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class SSR_U04
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: UAC (User Authentication Credential Segment) optional
• 4: EQU (Equipment Detail)
• 5: SSR_U04_SPECIMEN_CONTAINER (a Group object) repeating
• 6: ROL (Role) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and 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
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
SSR_U04_SPECIMEN_CONTAINER	getSPECIMEN_CONTAINER() Returns the first repetition of SPECIMEN_CONTAINER (a Group object) - creates it if necessary
SSR_U04_SPECIMEN_CONTAINER	getSPECIMEN_CONTAINER(int rep) Returns a specific repetition of SPECIMEN_CONTAINER (a Group object) - creates it if necessary
List<SSR_U04_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
UAC	getUAC() Returns UAC (User Authentication Credential Segment) - creates it if necessary
String	getVersion() Returns "2.6"
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)
SSR_U04_SPECIMEN_CONTAINER	insertSPECIMEN_CONTAINER(int rep) Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)
void	insertSPECIMEN_CONTAINER(SSR_U04_SPECIMEN_CONTAINER structure, int rep) Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)
SSR_U04_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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, 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, isGroup, isRepeating, isRequired

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

getName

Constructor Detail

SSR_U04

public SSR_U04()

Creates a new SSR_U04 message with DefaultModelClassFactory.

SSR_U04

public SSR_U04(ModelClassFactory factory)

Creates a new SSR_U04 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.6"

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)

getUAC

public UAC getUAC()

Returns UAC (User Authentication Credential Segment) - creates it if necessary

getEQU

public EQU getEQU()

Returns EQU (Equipment Detail) - creates it if necessary

getSPECIMEN_CONTAINER

public SSR_U04_SPECIMEN_CONTAINER getSPECIMEN_CONTAINER()

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

getSPECIMEN_CONTAINER

public SSR_U04_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<SSR_U04_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(SSR_U04_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 SSR_U04_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 SSR_U04_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