ca.uhn.hl7v2.model.v281.group

Class OSM_R26_SUBJECT_POPULATION_LOCATION_IDENTIFICATION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.OSM_R26_SUBJECT_POPULATION_LOCATION_IDENTIFICATION

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OSM_R26_SUBJECT_POPULATION_LOCATION_IDENTIFICATION
extends AbstractGroup

Represents a OSM_R26_SUBJECT_POPULATION_LOCATION_IDENTIFICATION 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: PV1 (Patient Visit)
• 2: PRT (Participation Information) optional repeating
• 3: OSM_R26_PATIENT_VISIT_OBSERVATION (a Group object) optional repeating
• 4: PID (Patient Identification) optional
• 5: PRT (Participation Information) optional repeating
• 6: NK1 (Next of Kin / Associated Parties) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

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
OSM_R26_PATIENT_VISIT_OBSERVATION	getPATIENT_VISIT_OBSERVATION() Returns the first repetition of PATIENT_VISIT_OBSERVATION (a Group object) - creates it if necessary
OSM_R26_PATIENT_VISIT_OBSERVATION	getPATIENT_VISIT_OBSERVATION(int rep) Returns a specific repetition of PATIENT_VISIT_OBSERVATION (a Group object) - creates it if necessary
List<OSM_R26_PATIENT_VISIT_OBSERVATION>	getPATIENT_VISIT_OBSERVATIONAll() Returns a non-modifiable List containing all current existing repetitions of PATIENT_VISIT_OBSERVATION.
int	getPATIENT_VISIT_OBSERVATIONReps() Returns the number of existing repetitions of PATIENT_VISIT_OBSERVATION
PID	getPID() Returns PID (Patient Identification) - creates it if necessary
PRT	getPRT() Returns the first repetition of PRT (Participation Information) - creates it if necessary
PRT	getPRT(int rep) Returns a specific repetition of PRT (Participation Information) - creates it if necessary
PRT	getPRT2() Returns the first repetition of PRT2 (Participation Information) - creates it if necessary
PRT	getPRT2(int rep) Returns a specific repetition of PRT (Participation Information) - creates it if necessary
List<PRT>	getPRT2All() Returns a non-modifiable List containing all current existing repetitions of PRT2.
int	getPRT2Reps() Returns the number of existing repetitions of PRT2
List<PRT>	getPRTAll() Returns a non-modifiable List containing all current existing repetitions of PRT.
int	getPRTReps() Returns the number of existing repetitions of PRT
PV1	getPV1() Returns PV1 (Patient Visit) - creates it if necessary
String	getVersion() Returns "2.8.1"
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)
OSM_R26_PATIENT_VISIT_OBSERVATION	insertPATIENT_VISIT_OBSERVATION(int rep) Inserts a specific repetition of PATIENT_VISIT_OBSERVATION (a Group object)
void	insertPATIENT_VISIT_OBSERVATION(OSM_R26_PATIENT_VISIT_OBSERVATION structure, int rep) Inserts a specific repetition of PATIENT_VISIT_OBSERVATION (a Group object)
PRT	insertPRT(int rep) Inserts a specific repetition of PRT (Participation Information)
void	insertPRT(PRT structure, int rep) Inserts a specific repetition of PRT (Participation Information)
PRT	insertPRT2(int rep) Inserts a specific repetition of PRT2 (Participation Information)
void	insertPRT2(PRT structure, int rep) Inserts a specific repetition of PRT2 (Participation Information)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
OSM_R26_PATIENT_VISIT_OBSERVATION	removePATIENT_VISIT_OBSERVATION(int rep) Removes a specific repetition of PATIENT_VISIT_OBSERVATION (a Group object)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)
PRT	removePRT2(int rep) Removes a specific repetition of PRT2 (Participation Information)

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

OSM_R26_SUBJECT_POPULATION_LOCATION_IDENTIFICATION

public OSM_R26_SUBJECT_POPULATION_LOCATION_IDENTIFICATION(Group parent,
                                                          ModelClassFactory factory)

Creates a new OSM_R26_SUBJECT_POPULATION_LOCATION_IDENTIFICATION group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getPV1

public PV1 getPV1()

Returns PV1 (Patient Visit) - creates it if necessary

getPRT

public PRT getPRT()

Returns the first repetition of PRT (Participation Information) - creates it if necessary

getPRT

public PRT getPRT(int rep)

Returns a specific repetition of PRT (Participation Information) - 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.

getPRTReps

public int getPRTReps()

Returns the number of existing repetitions of PRT

getPRTAll

public List<PRT> getPRTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRT

public void insertPRT(PRT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRT

public PRT insertPRT(int rep)
              throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRT

public PRT removePRT(int rep)
              throws HL7Exception

Removes a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPATIENT_VISIT_OBSERVATION

public OSM_R26_PATIENT_VISIT_OBSERVATION getPATIENT_VISIT_OBSERVATION()

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

getPATIENT_VISIT_OBSERVATION

public OSM_R26_PATIENT_VISIT_OBSERVATION getPATIENT_VISIT_OBSERVATION(int rep)

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

getPATIENT_VISIT_OBSERVATIONReps

public int getPATIENT_VISIT_OBSERVATIONReps()

Returns the number of existing repetitions of PATIENT_VISIT_OBSERVATION

getPATIENT_VISIT_OBSERVATIONAll

public List<OSM_R26_PATIENT_VISIT_OBSERVATION> getPATIENT_VISIT_OBSERVATIONAll()
                                                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertPATIENT_VISIT_OBSERVATION

public void insertPATIENT_VISIT_OBSERVATION(OSM_R26_PATIENT_VISIT_OBSERVATION structure,
                                            int rep)
                                     throws HL7Exception

Inserts a specific repetition of PATIENT_VISIT_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPATIENT_VISIT_OBSERVATION

public OSM_R26_PATIENT_VISIT_OBSERVATION insertPATIENT_VISIT_OBSERVATION(int rep)
                                                                  throws HL7Exception

Inserts a specific repetition of PATIENT_VISIT_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePATIENT_VISIT_OBSERVATION

public OSM_R26_PATIENT_VISIT_OBSERVATION removePATIENT_VISIT_OBSERVATION(int rep)
                                                                  throws HL7Exception

Removes a specific repetition of PATIENT_VISIT_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPRT2

public PRT getPRT2()

Returns the first repetition of PRT2 (Participation Information) - creates it if necessary

getPRT2

public PRT getPRT2(int rep)

Returns a specific repetition of PRT (Participation Information) - 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.

getPRT2Reps

public int getPRT2Reps()

Returns the number of existing repetitions of PRT2

getPRT2All

public List<PRT> getPRT2All()
                     throws HL7Exception

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

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

Throws:

HL7Exception

insertPRT2

public void insertPRT2(PRT structure,
                       int rep)
                throws HL7Exception

Inserts a specific repetition of PRT2 (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRT2

public PRT insertPRT2(int rep)
               throws HL7Exception

Inserts a specific repetition of PRT2 (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRT2

public PRT removePRT2(int rep)
               throws HL7Exception

Removes a specific repetition of PRT2 (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

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)