ca.uhn.hl7v2.model.v231.message

Class SIU_S12

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.SIU_S12

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class SIU_S12
extends AbstractMessage

Represents a SIU_S12 message structure (see chapter ${chapter}). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: SCH (SCH - schedule activity information segment)
• 3: NTE (NTE - notes and comments segment) optional repeating
• 4: SIU_S12_PIDPD1PV1PV2OBXDG1 (a Group object) optional repeating
• 5: SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
SIU_S12_PIDPD1PV1PV2OBXDG1	getPIDPD1PV1PV2OBXDG1() Returns the first repetition of PIDPD1PV1PV2OBXDG1 (a Group object) - creates it if necessary
SIU_S12_PIDPD1PV1PV2OBXDG1	getPIDPD1PV1PV2OBXDG1(int rep) Returns a specific repetition of PIDPD1PV1PV2OBXDG1 (a Group object) - creates it if necessary
List<SIU_S12_PIDPD1PV1PV2OBXDG1>	getPIDPD1PV1PV2OBXDG1All() Returns a non-modifiable List containing all current existing repetitions of PIDPD1PV1PV2OBXDG1.
int	getPIDPD1PV1PV2OBXDG1Reps() Returns the number of existing repetitions of PIDPD1PV1PV2OBXDG1
SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE	getRGSAISNTEAIGNTEAILNTEAIPNTE() Returns the first repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object) - creates it if necessary
SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE	getRGSAISNTEAIGNTEAILNTEAIPNTE(int rep) Returns a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object) - creates it if necessary
List<SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE>	getRGSAISNTEAIGNTEAILNTEAIPNTEAll() Returns a non-modifiable List containing all current existing repetitions of RGSAISNTEAIGNTEAILNTEAIPNTE.
int	getRGSAISNTEAIGNTEAILNTEAIPNTEReps() Returns the number of existing repetitions of RGSAISNTEAIGNTEAILNTEAIPNTE
SCH	getSCH() Returns SCH (SCH - schedule activity information segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
SIU_S12_PIDPD1PV1PV2OBXDG1	insertPIDPD1PV1PV2OBXDG1(int rep) Inserts a specific repetition of PIDPD1PV1PV2OBXDG1 (a Group object)
void	insertPIDPD1PV1PV2OBXDG1(SIU_S12_PIDPD1PV1PV2OBXDG1 structure, int rep) Inserts a specific repetition of PIDPD1PV1PV2OBXDG1 (a Group object)
SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE	insertRGSAISNTEAIGNTEAILNTEAIPNTE(int rep) Inserts a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object)
void	insertRGSAISNTEAIGNTEAILNTEAIPNTE(SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE structure, int rep) Inserts a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
SIU_S12_PIDPD1PV1PV2OBXDG1	removePIDPD1PV1PV2OBXDG1(int rep) Removes a specific repetition of PIDPD1PV1PV2OBXDG1 (a Group object)
SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE	removeRGSAISNTEAIGNTEAILNTEAIPNTE(int rep) Removes a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (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

SIU_S12

public SIU_S12()

Creates a new SIU_S12 message with DefaultModelClassFactory.

SIU_S12

public SIU_S12(ModelClassFactory factory)

Creates a new SIU_S12 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

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

getSCH

public SCH getSCH()

Returns SCH (SCH - schedule activity information segment) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (NTE - notes and comments 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getPIDPD1PV1PV2OBXDG1

public SIU_S12_PIDPD1PV1PV2OBXDG1 getPIDPD1PV1PV2OBXDG1()

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

getPIDPD1PV1PV2OBXDG1

public SIU_S12_PIDPD1PV1PV2OBXDG1 getPIDPD1PV1PV2OBXDG1(int rep)

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

getPIDPD1PV1PV2OBXDG1Reps

public int getPIDPD1PV1PV2OBXDG1Reps()

Returns the number of existing repetitions of PIDPD1PV1PV2OBXDG1

getPIDPD1PV1PV2OBXDG1All

public List<SIU_S12_PIDPD1PV1PV2OBXDG1> getPIDPD1PV1PV2OBXDG1All()
                                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertPIDPD1PV1PV2OBXDG1

public void insertPIDPD1PV1PV2OBXDG1(SIU_S12_PIDPD1PV1PV2OBXDG1 structure,
                            int rep)
                              throws HL7Exception

Inserts a specific repetition of PIDPD1PV1PV2OBXDG1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPIDPD1PV1PV2OBXDG1

public SIU_S12_PIDPD1PV1PV2OBXDG1 insertPIDPD1PV1PV2OBXDG1(int rep)
                                                    throws HL7Exception

Inserts a specific repetition of PIDPD1PV1PV2OBXDG1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePIDPD1PV1PV2OBXDG1

public SIU_S12_PIDPD1PV1PV2OBXDG1 removePIDPD1PV1PV2OBXDG1(int rep)
                                                    throws HL7Exception

Removes a specific repetition of PIDPD1PV1PV2OBXDG1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getRGSAISNTEAIGNTEAILNTEAIPNTE

public SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE getRGSAISNTEAIGNTEAILNTEAIPNTE()

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

getRGSAISNTEAIGNTEAILNTEAIPNTE

public SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE getRGSAISNTEAIGNTEAILNTEAIPNTE(int rep)

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

getRGSAISNTEAIGNTEAILNTEAIPNTEReps

public int getRGSAISNTEAIGNTEAILNTEAIPNTEReps()

Returns the number of existing repetitions of RGSAISNTEAIGNTEAILNTEAIPNTE

getRGSAISNTEAIGNTEAILNTEAIPNTEAll

public List<SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE> getRGSAISNTEAIGNTEAILNTEAIPNTEAll()
                                                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertRGSAISNTEAIGNTEAILNTEAIPNTE

public void insertRGSAISNTEAIGNTEAILNTEAIPNTE(SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE structure,
                                     int rep)
                                       throws HL7Exception

Inserts a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRGSAISNTEAIGNTEAILNTEAIPNTE

public SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE insertRGSAISNTEAIGNTEAILNTEAIPNTE(int rep)
                                                                      throws HL7Exception

Inserts a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRGSAISNTEAIGNTEAILNTEAIPNTE

public SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE removeRGSAISNTEAIGNTEAILNTEAIPNTE(int rep)
                                                                      throws HL7Exception

Removes a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)