ca.uhn.hl7v2.model.v231.group

Class SQM_S25_ARQAPRPIDRGSAISAPRAIGAPRAIPAPRAILAPR

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.SQM_S25_ARQAPRPIDRGSAISAPRAIGAPRAIPAPRAILAPR

All Implemented Interfaces:

Group, Structure, Serializable

public class SQM_S25_ARQAPRPIDRGSAISAPRAIGAPRAIPAPRAILAPR
extends AbstractGroup

Represents a SQM_S25_ARQAPRPIDRGSAISAPRAIGAPRAIPAPRAILAPR 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: ARQ (ARQ - appointment request segment)
• 2: APR (APR - appointment preferences segment) optional
• 3: PID (PID - patient identification segment) optional
• 4: SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR (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
SQM_S25_ARQAPRPIDRGSAISAPRAIGAPRAIPAPRAILAPR(Group parent, ModelClassFactory factory) Creates a new SQM_S25_ARQAPRPIDRGSAISAPRAIGAPRAIPAPRAILAPR group

Method Summary

Methods

Modifier and Type	Method and Description
APR	getAPR() Returns APR (APR - appointment preferences segment) - creates it if necessary
ARQ	getARQ() Returns ARQ (ARQ - appointment request segment) - creates it if necessary
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR	getRGSAISAPRAIGAPRAIPAPRAILAPR() Returns the first repetition of RGSAISAPRAIGAPRAIPAPRAILAPR (a Group object) - creates it if necessary
SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR	getRGSAISAPRAIGAPRAIPAPRAILAPR(int rep) Returns a specific repetition of RGSAISAPRAIGAPRAIPAPRAILAPR (a Group object) - creates it if necessary
List<SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR>	getRGSAISAPRAIGAPRAIPAPRAILAPRAll() Returns a non-modifiable List containing all current existing repetitions of RGSAISAPRAIGAPRAIPAPRAILAPR.
int	getRGSAISAPRAIGAPRAIPAPRAILAPRReps() Returns the number of existing repetitions of RGSAISAPRAIGAPRAIPAPRAILAPR
String	getVersion() Returns "2.3.1"
SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR	insertRGSAISAPRAIGAPRAIPAPRAILAPR(int rep) Inserts a specific repetition of RGSAISAPRAIGAPRAIPAPRAILAPR (a Group object)
void	insertRGSAISAPRAIGAPRAIPAPRAILAPR(SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR structure, int rep) Inserts a specific repetition of RGSAISAPRAIGAPRAIPAPRAILAPR (a Group object)
SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR	removeRGSAISAPRAIGAPRAIPAPRAILAPR(int rep) Removes a specific repetition of RGSAISAPRAIGAPRAIPAPRAILAPR (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

SQM_S25_ARQAPRPIDRGSAISAPRAIGAPRAIPAPRAILAPR

public SQM_S25_ARQAPRPIDRGSAISAPRAIGAPRAIPAPRAILAPR(Group parent,
                                            ModelClassFactory factory)

Creates a new SQM_S25_ARQAPRPIDRGSAISAPRAIGAPRAIPAPRAILAPR group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getARQ

public ARQ getARQ()

Returns ARQ (ARQ - appointment request segment) - creates it if necessary

getAPR

public APR getAPR()

Returns APR (APR - appointment preferences segment) - creates it if necessary

getPID

public PID getPID()

Returns PID (PID - patient identification segment) - creates it if necessary

getRGSAISAPRAIGAPRAIPAPRAILAPR

public SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR getRGSAISAPRAIGAPRAIPAPRAILAPR()

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

getRGSAISAPRAIGAPRAIPAPRAILAPR

public SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR getRGSAISAPRAIGAPRAIPAPRAILAPR(int rep)

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

getRGSAISAPRAIGAPRAIPAPRAILAPRReps

public int getRGSAISAPRAIGAPRAIPAPRAILAPRReps()

Returns the number of existing repetitions of RGSAISAPRAIGAPRAIPAPRAILAPR

getRGSAISAPRAIGAPRAIPAPRAILAPRAll

public List<SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR> getRGSAISAPRAIGAPRAIPAPRAILAPRAll()
                                                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertRGSAISAPRAIGAPRAIPAPRAILAPR

public void insertRGSAISAPRAIGAPRAIPAPRAILAPR(SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR structure,
                                     int rep)
                                       throws HL7Exception

Inserts a specific repetition of RGSAISAPRAIGAPRAIPAPRAILAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRGSAISAPRAIGAPRAIPAPRAILAPR

public SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR insertRGSAISAPRAIGAPRAIPAPRAILAPR(int rep)
                                                                      throws HL7Exception

Inserts a specific repetition of RGSAISAPRAIGAPRAIPAPRAILAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRGSAISAPRAIGAPRAIPAPRAILAPR

public SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR removeRGSAISAPRAIGAPRAIPAPRAILAPR(int rep)
                                                                      throws HL7Exception

Removes a specific repetition of RGSAISAPRAIGAPRAIPAPRAILAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)