ca.uhn.hl7v2.model.v24.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.v24.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). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: EQU (Equipment Detail)
• 3: SAC (Specimen and container detail) 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 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
SAC	getSAC() Returns the first repetition of SAC (Specimen and container detail) - creates it if necessary
SAC	getSAC(int rep) Returns a specific repetition of SAC (Specimen and container detail) - creates it if necessary
List<SAC>	getSACAll() Returns a non-modifiable List containing all current existing repetitions of SAC.
int	getSACReps() Returns the number of existing repetitions of SAC
String	getVersion() Returns "2.4"
SAC	insertSAC(int rep) Inserts a specific repetition of SAC (Specimen and container detail)
void	insertSAC(SAC structure, int rep) Inserts a specific repetition of SAC (Specimen and container detail)
SAC	removeSAC(int rep) Removes a specific repetition of SAC (Specimen and container detail)

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

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.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

getSAC

public SAC getSAC()

Returns the first repetition of SAC (Specimen and container detail) - creates it if necessary

getSAC

public SAC getSAC(int rep)

Returns a specific repetition of SAC (Specimen and container detail) - 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.

getSACReps

public int getSACReps()

Returns the number of existing repetitions of SAC

getSACAll

public List<SAC> getSACAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSAC

public void insertSAC(SAC structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of SAC (Specimen and container detail)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSAC

public SAC insertSAC(int rep)
              throws HL7Exception

Inserts a specific repetition of SAC (Specimen and container detail)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSAC

public SAC removeSAC(int rep)
              throws HL7Exception

Removes a specific repetition of SAC (Specimen and container detail)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getROL

public ROL getROL()

Returns ROL (Role) - creates it if necessary