ca.uhn.hl7v2.model.v231.group

Class OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1
extends AbstractGroup

Represents a OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 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: PID (PID - patient identification segment)
• 2: PD1 (PD1 - patient additional demographic segment) optional
• 3: NTE (NTE - notes and comments segment) optional repeating
• 4: OMD_O01_PV1PV2 (a Group object) optional
• 5: OMD_O01_IN1IN2IN3 (a Group object) optional repeating
• 6: GT1 (GT1 - guarantor segment) optional
• 7: AL1 (AL1 - patient allergy information segment) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AL1	getAL1() Returns the first repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
AL1	getAL1(int rep) Returns a specific repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
List<AL1>	getAL1All() Returns a non-modifiable List containing all current existing repetitions of AL1.
int	getAL1Reps() Returns the number of existing repetitions of AL1
GT1	getGT1() Returns GT1 (GT1 - guarantor segment) - creates it if necessary
OMD_O01_IN1IN2IN3	getIN1IN2IN3() Returns the first repetition of IN1IN2IN3 (a Group object) - creates it if necessary
OMD_O01_IN1IN2IN3	getIN1IN2IN3(int rep) Returns a specific repetition of IN1IN2IN3 (a Group object) - creates it if necessary
List<OMD_O01_IN1IN2IN3>	getIN1IN2IN3All() Returns a non-modifiable List containing all current existing repetitions of IN1IN2IN3.
int	getIN1IN2IN3Reps() Returns the number of existing repetitions of IN1IN2IN3
NTE	getNTE() Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
PD1	getPD1() Returns PD1 (PD1 - patient additional demographic segment) - creates it if necessary
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
OMD_O01_PV1PV2	getPV1PV2() Returns PV1PV2 (a Group object) - creates it if necessary
String	getVersion() Returns "2.3.1"
void	insertAL1(AL1 structure, int rep) Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
AL1	insertAL1(int rep) Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
OMD_O01_IN1IN2IN3	insertIN1IN2IN3(int rep) Inserts a specific repetition of IN1IN2IN3 (a Group object)
void	insertIN1IN2IN3(OMD_O01_IN1IN2IN3 structure, int rep) Inserts a specific repetition of IN1IN2IN3 (a Group object)
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
AL1	removeAL1(int rep) Removes a specific repetition of AL1 (AL1 - patient allergy information segment)
OMD_O01_IN1IN2IN3	removeIN1IN2IN3(int rep) Removes a specific repetition of IN1IN2IN3 (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)

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

OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1

public OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1(Group parent,
                                              ModelClassFactory factory)

Creates a new OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getPID

public PID getPID()

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

getPD1

public PD1 getPD1()

Returns PD1 (PD1 - patient additional demographic segment) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (NTE - notes and comments segment) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPV1PV2

public OMD_O01_PV1PV2 getPV1PV2()

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

getIN1IN2IN3

public OMD_O01_IN1IN2IN3 getIN1IN2IN3()

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

getIN1IN2IN3

public OMD_O01_IN1IN2IN3 getIN1IN2IN3(int rep)

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

getIN1IN2IN3Reps

public int getIN1IN2IN3Reps()

Returns the number of existing repetitions of IN1IN2IN3

getIN1IN2IN3All

public List<OMD_O01_IN1IN2IN3> getIN1IN2IN3All()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertIN1IN2IN3

public void insertIN1IN2IN3(OMD_O01_IN1IN2IN3 structure,
                            int rep)
                     throws HL7Exception

Inserts a specific repetition of IN1IN2IN3 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertIN1IN2IN3

public OMD_O01_IN1IN2IN3 insertIN1IN2IN3(int rep)
                                  throws HL7Exception

Inserts a specific repetition of IN1IN2IN3 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeIN1IN2IN3

public OMD_O01_IN1IN2IN3 removeIN1IN2IN3(int rep)
                                  throws HL7Exception

Removes a specific repetition of IN1IN2IN3 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getGT1

public GT1 getGT1()

Returns GT1 (GT1 - guarantor segment) - creates it if necessary

getAL1

public AL1 getAL1()

Returns the first repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary

getAL1

public AL1 getAL1(int rep)

Returns a specific repetition of AL1 (AL1 - patient allergy information segment) - 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.

getAL1Reps

public int getAL1Reps()

Returns the number of existing repetitions of AL1

getAL1All

public List<AL1> getAL1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertAL1

public void insertAL1(AL1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAL1

public AL1 insertAL1(int rep)
              throws HL7Exception

Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAL1

public AL1 removeAL1(int rep)
              throws HL7Exception

Removes a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)