ca.uhn.hl7v2.model.v231.group

Class SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE

All Implemented Interfaces:

Group, Structure, Serializable

public class SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE
extends AbstractGroup

Represents a SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE 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: SQR_S25_PIDPV1PV2DG1 (a Group object) optional
• 4: SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE (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
SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(Group parent, ModelClassFactory factory) Creates a new SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE 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
SQR_S25_PIDPV1PV2DG1	getPIDPV1PV2DG1() Returns PIDPV1PV2DG1 (a Group object) - creates it if necessary
SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE	getRGSAISNTEAIGNTEAIPNTEAILNTE() Returns the first repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) - creates it if necessary
SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE	getRGSAISNTEAIGNTEAIPNTEAILNTE(int rep) Returns a specific repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) - creates it if necessary
List<SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE>	getRGSAISNTEAIGNTEAIPNTEAILNTEAll() Returns a non-modifiable List containing all current existing repetitions of RGSAISNTEAIGNTEAIPNTEAILNTE.
int	getRGSAISNTEAIGNTEAIPNTEAILNTEReps() Returns the number of existing repetitions of RGSAISNTEAIGNTEAIPNTEAILNTE
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)
SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE	insertRGSAISNTEAIGNTEAIPNTEAILNTE(int rep) Inserts a specific repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object)
void	insertRGSAISNTEAIGNTEAIPNTEAILNTE(SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE structure, int rep) Inserts a specific repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE	removeRGSAISNTEAIGNTEAIPNTEAILNTE(int rep) Removes a specific repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (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

SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE

public SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(Group parent,
                                                     ModelClassFactory factory)

Creates a new SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE 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 SQR_S25_PIDPV1PV2DG1 getPIDPV1PV2DG1()

Returns PIDPV1PV2DG1 (a Group object) - creates it if necessary

getRGSAISNTEAIGNTEAIPNTEAILNTE

public SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE getRGSAISNTEAIGNTEAIPNTEAILNTE()

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

getRGSAISNTEAIGNTEAIPNTEAILNTE

public SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE getRGSAISNTEAIGNTEAIPNTEAILNTE(int rep)

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

getRGSAISNTEAIGNTEAIPNTEAILNTEReps

public int getRGSAISNTEAIGNTEAIPNTEAILNTEReps()

Returns the number of existing repetitions of RGSAISNTEAIGNTEAIPNTEAILNTE

getRGSAISNTEAIGNTEAIPNTEAILNTEAll

public List<SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE> getRGSAISNTEAIGNTEAIPNTEAILNTEAll()
                                                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertRGSAISNTEAIGNTEAIPNTEAILNTE

public void insertRGSAISNTEAIGNTEAIPNTEAILNTE(SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE structure,
                                     int rep)
                                       throws HL7Exception

Inserts a specific repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRGSAISNTEAIGNTEAIPNTEAILNTE

public SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE insertRGSAISNTEAIGNTEAIPNTEAILNTE(int rep)
                                                                      throws HL7Exception

Inserts a specific repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRGSAISNTEAIGNTEAIPNTEAILNTE

public SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE removeRGSAISNTEAIGNTEAIPNTEAILNTE(int rep)
                                                                      throws HL7Exception

Removes a specific repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)