Package ca.uhn.hl7v2.model.v24.group

Class SQM_S25_REQUEST

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.SQM_S25_REQUEST

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class SQM_S25_REQUEST
extends AbstractGroup

Represents a SQM_S25_REQUEST 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 (Appointment Request)
• 2: APR (Appointment Preferences) optional
• 3: PID (Patient identification) optional
• 4: SQM_S25_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
SQM_S25_REQUEST(Group parent, ModelClassFactory factory)	Creates a new SQM_S25_REQUEST group

Method Summary

Modifier and Type	Method	Description
APR	getAPR()	Returns APR (Appointment Preferences) - creates it if necessary
ARQ	getARQ()	Returns ARQ (Appointment Request) - creates it if necessary
PID	getPID()	Returns PID (Patient identification) - creates it if necessary
SQM_S25_RESOURCES	getRESOURCES()	Returns the first repetition of RESOURCES (a Group object) - creates it if necessary
SQM_S25_RESOURCES	getRESOURCES(int rep)	Returns a specific repetition of RESOURCES (a Group object) - creates it if necessary
List<SQM_S25_RESOURCES>	getRESOURCESAll()	Returns a non-modifiable List containing all current existing repetitions of RESOURCES.
int	getRESOURCESReps()	Returns the number of existing repetitions of RESOURCES
String	getVersion()	Returns "2.4"
SQM_S25_RESOURCES	insertRESOURCES(int rep)	Inserts a specific repetition of RESOURCES (a Group object)
void	insertRESOURCES(SQM_S25_RESOURCES structure, int rep)	Inserts a specific repetition of RESOURCES (a Group object)
SQM_S25_RESOURCES	removeRESOURCES(int rep)	Removes a specific repetition of RESOURCES (a Group object)

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

SQM_S25_REQUEST

public SQM_S25_REQUEST(Group parent,
 ModelClassFactory factory)

Creates a new SQM_S25_REQUEST group

Method Details

getVersion

public String getVersion()

Returns "2.4"

getARQ

public ARQ getARQ()

Returns ARQ (Appointment Request) - creates it if necessary

getAPR

public APR getAPR()

Returns APR (Appointment Preferences) - creates it if necessary

getPID

public PID getPID()

Returns PID (Patient identification) - creates it if necessary

getRESOURCES

public SQM_S25_RESOURCES getRESOURCES()

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

getRESOURCES

public SQM_S25_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<SQM_S25_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(SQM_S25_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 SQM_S25_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 SQM_S25_RESOURCES removeRESOURCES(int rep)
                                  throws HL7Exception

Removes a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)