ca.uhn.hl7v2.model.v24.group

Class RSP_K25_STAFF

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.RSP_K25_STAFF

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RSP_K25_STAFF
extends AbstractGroup

Represents a RSP_K25_STAFF 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: STF (Staff Identification)
• 2: PRA (Practitioner Detail) optional
• 3: ORG (Practitioner Organization Unit) optional repeating
• 4: AFF (Professional Affiliation) optional repeating
• 5: LAN (Language Detail) optional repeating
• 6: EDU (Educational Detail) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
AFF	getAFF() Returns the first repetition of AFF (Professional Affiliation) - creates it if necessary
AFF	getAFF(int rep) Returns a specific repetition of AFF (Professional Affiliation) - creates it if necessary
List<AFF>	getAFFAll() Returns a non-modifiable List containing all current existing repetitions of AFF.
int	getAFFReps() Returns the number of existing repetitions of AFF
EDU	getEDU() Returns the first repetition of EDU (Educational Detail) - creates it if necessary
EDU	getEDU(int rep) Returns a specific repetition of EDU (Educational Detail) - creates it if necessary
List<EDU>	getEDUAll() Returns a non-modifiable List containing all current existing repetitions of EDU.
int	getEDUReps() Returns the number of existing repetitions of EDU
LAN	getLAN() Returns the first repetition of LAN (Language Detail) - creates it if necessary
LAN	getLAN(int rep) Returns a specific repetition of LAN (Language Detail) - creates it if necessary
List<LAN>	getLANAll() Returns a non-modifiable List containing all current existing repetitions of LAN.
int	getLANReps() Returns the number of existing repetitions of LAN
ORG	getORG() Returns the first repetition of ORG (Practitioner Organization Unit) - creates it if necessary
ORG	getORG(int rep) Returns a specific repetition of ORG (Practitioner Organization Unit) - creates it if necessary
List<ORG>	getORGAll() Returns a non-modifiable List containing all current existing repetitions of ORG.
int	getORGReps() Returns the number of existing repetitions of ORG
PRA	getPRA() Returns PRA (Practitioner Detail) - creates it if necessary
STF	getSTF() Returns STF (Staff Identification) - creates it if necessary
String	getVersion() Returns "2.4"
void	insertAFF(AFF structure, int rep) Inserts a specific repetition of AFF (Professional Affiliation)
AFF	insertAFF(int rep) Inserts a specific repetition of AFF (Professional Affiliation)
void	insertEDU(EDU structure, int rep) Inserts a specific repetition of EDU (Educational Detail)
EDU	insertEDU(int rep) Inserts a specific repetition of EDU (Educational Detail)
LAN	insertLAN(int rep) Inserts a specific repetition of LAN (Language Detail)
void	insertLAN(LAN structure, int rep) Inserts a specific repetition of LAN (Language Detail)
ORG	insertORG(int rep) Inserts a specific repetition of ORG (Practitioner Organization Unit)
void	insertORG(ORG structure, int rep) Inserts a specific repetition of ORG (Practitioner Organization Unit)
AFF	removeAFF(int rep) Removes a specific repetition of AFF (Professional Affiliation)
EDU	removeEDU(int rep) Removes a specific repetition of EDU (Educational Detail)
LAN	removeLAN(int rep) Removes a specific repetition of LAN (Language Detail)
ORG	removeORG(int rep) Removes a specific repetition of ORG (Practitioner Organization Unit)

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 Detail

RSP_K25_STAFF

public RSP_K25_STAFF(Group parent,
             ModelClassFactory factory)

Creates a new RSP_K25_STAFF group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getSTF

public STF getSTF()

Returns STF (Staff Identification) - creates it if necessary

getPRA

public PRA getPRA()

Returns PRA (Practitioner Detail) - creates it if necessary

getORG

public ORG getORG()

Returns the first repetition of ORG (Practitioner Organization Unit) - creates it if necessary

getORG

public ORG getORG(int rep)

Returns a specific repetition of ORG (Practitioner Organization Unit) - 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.

getORGReps

public int getORGReps()

Returns the number of existing repetitions of ORG

getORGAll

public List<ORG> getORGAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertORG

public void insertORG(ORG structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of ORG (Practitioner Organization Unit)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORG

public ORG insertORG(int rep)
              throws HL7Exception

Inserts a specific repetition of ORG (Practitioner Organization Unit)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORG

public ORG removeORG(int rep)
              throws HL7Exception

Removes a specific repetition of ORG (Practitioner Organization Unit)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getAFF

public AFF getAFF()

Returns the first repetition of AFF (Professional Affiliation) - creates it if necessary

getAFF

public AFF getAFF(int rep)

Returns a specific repetition of AFF (Professional Affiliation) - 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.

getAFFReps

public int getAFFReps()

Returns the number of existing repetitions of AFF

getAFFAll

public List<AFF> getAFFAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertAFF

public void insertAFF(AFF structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of AFF (Professional Affiliation)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAFF

public AFF insertAFF(int rep)
              throws HL7Exception

Inserts a specific repetition of AFF (Professional Affiliation)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAFF

public AFF removeAFF(int rep)
              throws HL7Exception

Removes a specific repetition of AFF (Professional Affiliation)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getLAN

public LAN getLAN()

Returns the first repetition of LAN (Language Detail) - creates it if necessary

getLAN

public LAN getLAN(int rep)

Returns a specific repetition of LAN (Language Detail) - 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.

getLANReps

public int getLANReps()

Returns the number of existing repetitions of LAN

getLANAll

public List<LAN> getLANAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertLAN

public void insertLAN(LAN structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of LAN (Language Detail)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertLAN

public LAN insertLAN(int rep)
              throws HL7Exception

Inserts a specific repetition of LAN (Language Detail)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeLAN

public LAN removeLAN(int rep)
              throws HL7Exception

Removes a specific repetition of LAN (Language Detail)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getEDU

public EDU getEDU()

Returns the first repetition of EDU (Educational Detail) - creates it if necessary

getEDU

public EDU getEDU(int rep)

Returns a specific repetition of EDU (Educational Detail) - 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.

getEDUReps

public int getEDUReps()

Returns the number of existing repetitions of EDU

getEDUAll

public List<EDU> getEDUAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertEDU

public void insertEDU(EDU structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of EDU (Educational Detail)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertEDU

public EDU insertEDU(int rep)
              throws HL7Exception

Inserts a specific repetition of EDU (Educational Detail)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeEDU

public EDU removeEDU(int rep)
              throws HL7Exception

Removes a specific repetition of EDU (Educational Detail)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)