ca.uhn.hl7v2.model.v26.group

Class OPL_O37_PRIOR_RESULT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.OPL_O37_PRIOR_RESULT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OPL_O37_PRIOR_RESULT
extends AbstractGroup

Represents a OPL_O37_PRIOR_RESULT 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: OPL_O37_PATIENT_PRIOR (a Group object) optional
• 3: OPL_O37_PATIENT_VISIT_PRIOR (a Group object) optional
• 4: AL1 (Patient Allergy Information) optional
• 5: OPL_O37_ORDER_PRIOR (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
OPL_O37_PRIOR_RESULT(Group parent, ModelClassFactory factory) Creates a new OPL_O37_PRIOR_RESULT group

Method Summary

Modifier and Type	Method and Description
AL1	getAL1() Returns AL1 (Patient Allergy Information) - creates it if necessary
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
OPL_O37_ORDER_PRIOR	getORDER_PRIOR() Returns the first repetition of ORDER_PRIOR (a Group object) - creates it if necessary
OPL_O37_ORDER_PRIOR	getORDER_PRIOR(int rep) Returns a specific repetition of ORDER_PRIOR (a Group object) - creates it if necessary
List<OPL_O37_ORDER_PRIOR>	getORDER_PRIORAll() Returns a non-modifiable List containing all current existing repetitions of ORDER_PRIOR.
int	getORDER_PRIORReps() Returns the number of existing repetitions of ORDER_PRIOR
OPL_O37_PATIENT_PRIOR	getPATIENT_PRIOR() Returns PATIENT_PRIOR (a Group object) - creates it if necessary
OPL_O37_PATIENT_VISIT_PRIOR	getPATIENT_VISIT_PRIOR() Returns PATIENT_VISIT_PRIOR (a Group object) - creates it if necessary
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)
OPL_O37_ORDER_PRIOR	insertORDER_PRIOR(int rep) Inserts a specific repetition of ORDER_PRIOR (a Group object)
void	insertORDER_PRIOR(OPL_O37_ORDER_PRIOR structure, int rep) Inserts a specific repetition of ORDER_PRIOR (a Group object)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
OPL_O37_ORDER_PRIOR	removeORDER_PRIOR(int rep) Removes a specific repetition of ORDER_PRIOR (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 Detail

OPL_O37_PRIOR_RESULT

public OPL_O37_PRIOR_RESULT(Group parent,
                            ModelClassFactory factory)

Creates a new OPL_O37_PRIOR_RESULT 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_PRIOR

public OPL_O37_PATIENT_PRIOR getPATIENT_PRIOR()

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

getPATIENT_VISIT_PRIOR

public OPL_O37_PATIENT_VISIT_PRIOR getPATIENT_VISIT_PRIOR()

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

getAL1

public AL1 getAL1()

Returns AL1 (Patient Allergy Information) - creates it if necessary

getORDER_PRIOR

public OPL_O37_ORDER_PRIOR getORDER_PRIOR()

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

getORDER_PRIOR

public OPL_O37_ORDER_PRIOR getORDER_PRIOR(int rep)

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

getORDER_PRIORReps

public int getORDER_PRIORReps()

Returns the number of existing repetitions of ORDER_PRIOR

getORDER_PRIORAll

public List<OPL_O37_ORDER_PRIOR> getORDER_PRIORAll()
                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER_PRIOR

public void insertORDER_PRIOR(OPL_O37_ORDER_PRIOR structure,
                              int rep)
                       throws HL7Exception

Inserts a specific repetition of ORDER_PRIOR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORDER_PRIOR

public OPL_O37_ORDER_PRIOR insertORDER_PRIOR(int rep)
                                      throws HL7Exception

Inserts a specific repetition of ORDER_PRIOR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORDER_PRIOR

public OPL_O37_ORDER_PRIOR removeORDER_PRIOR(int rep)
                                      throws HL7Exception

Removes a specific repetition of ORDER_PRIOR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)