ca.uhn.hl7v2.model.v26.group

Class OPU_R25_ACCESSION_DETAIL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.OPU_R25_ACCESSION_DETAIL

All Implemented Interfaces:

Group, Structure, Serializable

public class OPU_R25_ACCESSION_DETAIL
extends AbstractGroup

Represents a OPU_R25_ACCESSION_DETAIL 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: NK1 (Next of Kin / Associated Parties) repeating
• 2: OPU_R25_PATIENT (a Group object) optional
• 3: OPU_R25_SPECIMEN (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
OPU_R25_ACCESSION_DETAIL(Group parent, ModelClassFactory factory) Creates a new OPU_R25_ACCESSION_DETAIL group

Method Summary

Methods

Modifier and Type	Method and Description
NK1	getNK1() Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
NK1	getNK1(int rep) Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
List<NK1>	getNK1All() Returns a non-modifiable List containing all current existing repetitions of NK1.
int	getNK1Reps() Returns the number of existing repetitions of NK1
OPU_R25_PATIENT	getPATIENT() Returns PATIENT (a Group object) - creates it if necessary
OPU_R25_SPECIMEN	getSPECIMEN() Returns the first repetition of SPECIMEN (a Group object) - creates it if necessary
OPU_R25_SPECIMEN	getSPECIMEN(int rep) Returns a specific repetition of SPECIMEN (a Group object) - creates it if necessary
List<OPU_R25_SPECIMEN>	getSPECIMENAll() Returns a non-modifiable List containing all current existing repetitions of SPECIMEN.
int	getSPECIMENReps() Returns the number of existing repetitions of SPECIMEN
String	getVersion() Returns "2.6"
NK1	insertNK1(int rep) Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
void	insertNK1(NK1 structure, int rep) Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
OPU_R25_SPECIMEN	insertSPECIMEN(int rep) Inserts a specific repetition of SPECIMEN (a Group object)
void	insertSPECIMEN(OPU_R25_SPECIMEN structure, int rep) Inserts a specific repetition of SPECIMEN (a Group object)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
OPU_R25_SPECIMEN	removeSPECIMEN(int rep) Removes a specific repetition of SPECIMEN (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

OPU_R25_ACCESSION_DETAIL

public OPU_R25_ACCESSION_DETAIL(Group parent,
                        ModelClassFactory factory)

Creates a new OPU_R25_ACCESSION_DETAIL group

Method Detail

getVersion

public String getVersion()

Returns "2.6"

getNK1

public NK1 getNK1()

Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary

getNK1

public NK1 getNK1(int rep)

Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - 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.

getNK1Reps

public int getNK1Reps()

Returns the number of existing repetitions of NK1

getNK1All

public List<NK1> getNK1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNK1

public void insertNK1(NK1 structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPATIENT

public OPU_R25_PATIENT getPATIENT()

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

getSPECIMEN

public OPU_R25_SPECIMEN getSPECIMEN()

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

getSPECIMEN

public OPU_R25_SPECIMEN getSPECIMEN(int rep)

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

getSPECIMENReps

public int getSPECIMENReps()

Returns the number of existing repetitions of SPECIMEN

getSPECIMENAll

public List<OPU_R25_SPECIMEN> getSPECIMENAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertSPECIMEN

public void insertSPECIMEN(OPU_R25_SPECIMEN structure,
                  int rep)
                    throws HL7Exception

Inserts a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSPECIMEN

public OPU_R25_SPECIMEN insertSPECIMEN(int rep)
                                throws HL7Exception

Inserts a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSPECIMEN

public OPU_R25_SPECIMEN removeSPECIMEN(int rep)
                                throws HL7Exception

Removes a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)