ca.uhn.hl7v2.model.v231.group

Class SRR_S01_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAILNTEAIPNTE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.SRR_S01_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAILNTEAIPNTE

All Implemented Interfaces:

Group, Structure, Serializable

public class SRR_S01_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAILNTEAIPNTE
extends AbstractGroup

Represents a SRR_S01_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAILNTEAIPNTE group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: SCH (SCH - schedule activity information segment)
• 2: NTE (NTE - notes and comments segment) optional repeating
• 3: SRR_S01_PIDPV1PV2DG1 (a Group object) optional repeating
• 4: SRR_S01_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
SRR_S01_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAILNTEAIPNTE(Group parent, ModelClassFactory factory) Creates a new SRR_S01_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAILNTEAIPNTE group

Method Summary

Methods

Modifier and Type	Method and Description
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
SRR_S01_PIDPV1PV2DG1	getPIDPV1PV2DG1() Returns the first repetition of PIDPV1PV2DG1 (a Group object) - creates it if necessary
SRR_S01_PIDPV1PV2DG1	getPIDPV1PV2DG1(int rep) Returns a specific repetition of PIDPV1PV2DG1 (a Group object) - creates it if necessary
List<SRR_S01_PIDPV1PV2DG1>	getPIDPV1PV2DG1All() Returns a non-modifiable List containing all current existing repetitions of PIDPV1PV2DG1.
int	getPIDPV1PV2DG1Reps() Returns the number of existing repetitions of PIDPV1PV2DG1
SRR_S01_RGSAISNTEAIGNTEAILNTEAIPNTE	getRGSAISNTEAIGNTEAILNTEAIPNTE() Returns the first repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object) - creates it if necessary
SRR_S01_RGSAISNTEAIGNTEAILNTEAIPNTE	getRGSAISNTEAIGNTEAILNTEAIPNTE(int rep) Returns a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object) - creates it if necessary
List<SRR_S01_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)
SRR_S01_PIDPV1PV2DG1	insertPIDPV1PV2DG1(int rep) Inserts a specific repetition of PIDPV1PV2DG1 (a Group object)
void	insertPIDPV1PV2DG1(SRR_S01_PIDPV1PV2DG1 structure, int rep) Inserts a specific repetition of PIDPV1PV2DG1 (a Group object)
SRR_S01_RGSAISNTEAIGNTEAILNTEAIPNTE	insertRGSAISNTEAIGNTEAILNTEAIPNTE(int rep) Inserts a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object)
void	insertRGSAISNTEAIGNTEAILNTEAIPNTE(SRR_S01_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)
SRR_S01_PIDPV1PV2DG1	removePIDPV1PV2DG1(int rep) Removes a specific repetition of PIDPV1PV2DG1 (a Group object)
SRR_S01_RGSAISNTEAIGNTEAILNTEAIPNTE	removeRGSAISNTEAIGNTEAILNTEAIPNTE(int rep) Removes a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object)

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 ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMessage, getParent

Constructor Detail

SRR_S01_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAILNTEAIPNTE

public SRR_S01_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAILNTEAIPNTE(Group parent,
                                                     ModelClassFactory factory)

Creates a new SRR_S01_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAILNTEAIPNTE group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

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)

getPIDPV1PV2DG1

public SRR_S01_PIDPV1PV2DG1 getPIDPV1PV2DG1()

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

getPIDPV1PV2DG1

public SRR_S01_PIDPV1PV2DG1 getPIDPV1PV2DG1(int rep)

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

getPIDPV1PV2DG1Reps

public int getPIDPV1PV2DG1Reps()

Returns the number of existing repetitions of PIDPV1PV2DG1

getPIDPV1PV2DG1All

public List<SRR_S01_PIDPV1PV2DG1> getPIDPV1PV2DG1All()
                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertPIDPV1PV2DG1

public void insertPIDPV1PV2DG1(SRR_S01_PIDPV1PV2DG1 structure,
                      int rep)
                        throws HL7Exception

Inserts a specific repetition of PIDPV1PV2DG1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPIDPV1PV2DG1

public SRR_S01_PIDPV1PV2DG1 insertPIDPV1PV2DG1(int rep)
                                        throws HL7Exception

Inserts a specific repetition of PIDPV1PV2DG1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePIDPV1PV2DG1

public SRR_S01_PIDPV1PV2DG1 removePIDPV1PV2DG1(int rep)
                                        throws HL7Exception

Removes a specific repetition of PIDPV1PV2DG1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRGSAISNTEAIGNTEAILNTEAIPNTE

public SRR_S01_RGSAISNTEAIGNTEAILNTEAIPNTE getRGSAISNTEAIGNTEAILNTEAIPNTE()

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

getRGSAISNTEAIGNTEAILNTEAIPNTE

public SRR_S01_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<SRR_S01_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(SRR_S01_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 SRR_S01_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 SRR_S01_RGSAISNTEAIGNTEAILNTEAIPNTE removeRGSAISNTEAIGNTEAILNTEAIPNTE(int rep)
                                                                      throws HL7Exception

Removes a specific repetition of RGSAISNTEAIGNTEAILNTEAIPNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)