Package ca.uhn.hl7v2.model.v251.group

Class SRR_S01_SCHEDULE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.SRR_S01_SCHEDULE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class SRR_S01_SCHEDULE
extends AbstractGroup

Represents a SRR_S01_SCHEDULE 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 (Scheduling Activity Information)
• 2: TQ1 (Timing/Quantity) optional repeating
• 3: NTE (Notes and Comments) optional repeating
• 4: SRR_S01_PATIENT (a Group object) optional repeating
• 5: SRR_S01_RESOURCES (a Group object) repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
SRR_S01_SCHEDULE(Group parent, ModelClassFactory factory)	Creates a new SRR_S01_SCHEDULE group

Method Summary

Modifier and Type	Method	Description
NTE	getNTE()	Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep)	Returns a specific repetition of NTE (Notes and Comments) - 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_PATIENT	getPATIENT()	Returns the first repetition of PATIENT (a Group object) - creates it if necessary
SRR_S01_PATIENT	getPATIENT(int rep)	Returns a specific repetition of PATIENT (a Group object) - creates it if necessary
List<SRR_S01_PATIENT>	getPATIENTAll()	Returns a non-modifiable List containing all current existing repetitions of PATIENT.
int	getPATIENTReps()	Returns the number of existing repetitions of PATIENT
SRR_S01_RESOURCES	getRESOURCES()	Returns the first repetition of RESOURCES (a Group object) - creates it if necessary
SRR_S01_RESOURCES	getRESOURCES(int rep)	Returns a specific repetition of RESOURCES (a Group object) - creates it if necessary
List<SRR_S01_RESOURCES>	getRESOURCESAll()	Returns a non-modifiable List containing all current existing repetitions of RESOURCES.
int	getRESOURCESReps()	Returns the number of existing repetitions of RESOURCES
SCH	getSCH()	Returns SCH (Scheduling Activity Information) - creates it if necessary
TQ1	getTQ1()	Returns the first repetition of TQ1 (Timing/Quantity) - creates it if necessary
TQ1	getTQ1(int rep)	Returns a specific repetition of TQ1 (Timing/Quantity) - creates it if necessary
List<TQ1>	getTQ1All()	Returns a non-modifiable List containing all current existing repetitions of TQ1.
int	getTQ1Reps()	Returns the number of existing repetitions of TQ1
String	getVersion()	Returns "2.5.1"
NTE	insertNTE(int rep)	Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep)	Inserts a specific repetition of NTE (Notes and Comments)
SRR_S01_PATIENT	insertPATIENT(int rep)	Inserts a specific repetition of PATIENT (a Group object)
void	insertPATIENT(SRR_S01_PATIENT structure, int rep)	Inserts a specific repetition of PATIENT (a Group object)
SRR_S01_RESOURCES	insertRESOURCES(int rep)	Inserts a specific repetition of RESOURCES (a Group object)
void	insertRESOURCES(SRR_S01_RESOURCES structure, int rep)	Inserts a specific repetition of RESOURCES (a Group object)
TQ1	insertTQ1(int rep)	Inserts a specific repetition of TQ1 (Timing/Quantity)
void	insertTQ1(TQ1 structure, int rep)	Inserts a specific repetition of TQ1 (Timing/Quantity)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and Comments)
SRR_S01_PATIENT	removePATIENT(int rep)	Removes a specific repetition of PATIENT (a Group object)
SRR_S01_RESOURCES	removeRESOURCES(int rep)	Removes a specific repetition of RESOURCES (a Group object)
TQ1	removeTQ1(int rep)	Removes a specific repetition of TQ1 (Timing/Quantity)

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

accept, 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, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

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 Details

SRR_S01_SCHEDULE

public SRR_S01_SCHEDULE(Group parent,
 ModelClassFactory factory)

Creates a new SRR_S01_SCHEDULE group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getSCH

public SCH getSCH()

Returns SCH (Scheduling Activity Information) - creates it if necessary

getTQ1

public TQ1 getTQ1()

Returns the first repetition of TQ1 (Timing/Quantity) - creates it if necessary

getTQ1

public TQ1 getTQ1(int rep)

Returns a specific repetition of TQ1 (Timing/Quantity) - 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.

getTQ1Reps

public int getTQ1Reps()

Returns the number of existing repetitions of TQ1

getTQ1All

public List<TQ1> getTQ1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertTQ1

public void insertTQ1(TQ1 structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of TQ1 (Timing/Quantity)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertTQ1

public TQ1 insertTQ1(int rep)
              throws HL7Exception

Inserts a specific repetition of TQ1 (Timing/Quantity)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeTQ1

public TQ1 removeTQ1(int rep)
              throws HL7Exception

Removes a specific repetition of TQ1 (Timing/Quantity)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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 (Notes and Comments)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPATIENT

public SRR_S01_PATIENT getPATIENT()

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

getPATIENT

public SRR_S01_PATIENT getPATIENT(int rep)

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

getPATIENTReps

public int getPATIENTReps()

Returns the number of existing repetitions of PATIENT

getPATIENTAll

public List<SRR_S01_PATIENT> getPATIENTAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPATIENT

public void insertPATIENT(SRR_S01_PATIENT structure,
 int rep)
                   throws HL7Exception

Inserts a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPATIENT

public SRR_S01_PATIENT insertPATIENT(int rep)
                              throws HL7Exception

Inserts a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePATIENT

public SRR_S01_PATIENT removePATIENT(int rep)
                              throws HL7Exception

Removes a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getRESOURCES

public SRR_S01_RESOURCES getRESOURCES()

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

getRESOURCES

public SRR_S01_RESOURCES getRESOURCES(int rep)

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

getRESOURCESReps

public int getRESOURCESReps()

Returns the number of existing repetitions of RESOURCES

getRESOURCESAll

public List<SRR_S01_RESOURCES> getRESOURCESAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertRESOURCES

public void insertRESOURCES(SRR_S01_RESOURCES structure,
 int rep)
                     throws HL7Exception

Inserts a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertRESOURCES

public SRR_S01_RESOURCES insertRESOURCES(int rep)
                                  throws HL7Exception

Inserts a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeRESOURCES

public SRR_S01_RESOURCES removeRESOURCES(int rep)
                                  throws HL7Exception

Removes a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)