ca.uhn.hl7v2.model.v251.segment

Class EDU

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v251.segment.EDU

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class EDU
extends AbstractSegment

Represents an HL7 EDU message segment (Educational Detail). This segment has the following fields:

• EDU-1: Set ID - EDU (SI)
• EDU-2: Academic Degree (IS) optional
• EDU-3: Academic Degree Program Date Range (DR) optional
• EDU-4: Academic Degree Program Participation Date Range (DR) optional
• EDU-5: Academic Degree Granted Date (DT) optional
• EDU-6: School (XON) optional
• EDU-7: School Type Code (CE) optional
• EDU-8: School Address (XAD) optional
• EDU-9: Major Field of Study (CWE) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
EDU(Group parent, ModelClassFactory factory) Creates a new EDU segment

Method Summary

Modifier and Type	Method and Description
protected Type	createNewTypeWithoutReflection(int field)
IS	getAcademicDegree() Returns EDU-2: "Academic Degree" - creates it if necessary
DT	getAcademicDegreeGrantedDate() Returns EDU-5: "Academic Degree Granted Date" - creates it if necessary
DR	getAcademicDegreeProgramDateRange() Returns EDU-3: "Academic Degree Program Date Range" - creates it if necessary
DR	getAcademicDegreeProgramParticipationDateRange() Returns EDU-4: "Academic Degree Program Participation Date Range" - creates it if necessary
SI	getEdu1_SetIDEDU() Returns EDU-1: "Set ID - EDU" - creates it if necessary
IS	getEdu2_AcademicDegree() Returns EDU-2: "Academic Degree" - creates it if necessary
DR	getEdu3_AcademicDegreeProgramDateRange() Returns EDU-3: "Academic Degree Program Date Range" - creates it if necessary
DR	getEdu4_AcademicDegreeProgramParticipationDateRange() Returns EDU-4: "Academic Degree Program Participation Date Range" - creates it if necessary
DT	getEdu5_AcademicDegreeGrantedDate() Returns EDU-5: "Academic Degree Granted Date" - creates it if necessary
XON	getEdu6_School() Returns EDU-6: "School" - creates it if necessary
CE	getEdu7_SchoolTypeCode() Returns EDU-7: "School Type Code" - creates it if necessary
XAD	getEdu8_SchoolAddress() Returns EDU-8: "School Address" - creates it if necessary
CWE[]	getEdu9_MajorFieldOfStudy() Returns all repetitions of Major Field of Study (EDU-9).
CWE	getEdu9_MajorFieldOfStudy(int rep) Returns a specific repetition of EDU-9: "Major Field of Study" - creates it if necessary
int	getEdu9_MajorFieldOfStudyReps() Returns a count of the current number of repetitions of Major Field of Study (EDU-9).
CWE[]	getMajorFieldOfStudy() Returns all repetitions of Major Field of Study (EDU-9).
CWE	getMajorFieldOfStudy(int rep) Returns a specific repetition of EDU-9: "Major Field of Study" - creates it if necessary
int	getMajorFieldOfStudyReps() Returns a count of the current number of repetitions of Major Field of Study (EDU-9).
XON	getSchool() Returns EDU-6: "School" - creates it if necessary
XAD	getSchoolAddress() Returns EDU-8: "School Address" - creates it if necessary
CE	getSchoolTypeCode() Returns EDU-7: "School Type Code" - creates it if necessary
SI	getSetIDEDU() Returns EDU-1: "Set ID - EDU" - creates it if necessary
CWE	insertEdu9_MajorFieldOfStudy(int rep) Inserts a repetition of EDU-9: "Major Field of Study" at a specific index
CWE	insertMajorFieldOfStudy(int rep) Inserts a repetition of EDU-9: "Major Field of Study" at a specific index
CWE	removeEdu9_MajorFieldOfStudy(int rep) Removes a repetition of EDU-9: "Major Field of Study" at a specific index
CWE	removeMajorFieldOfStudy(int rep) Removes a repetition of EDU-9: "Major Field of Study" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition

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

EDU

public EDU(Group parent,
           ModelClassFactory factory)

Creates a new EDU segment

Method Detail

getSetIDEDU

public SI getSetIDEDU()

Returns EDU-1: "Set ID - EDU" - creates it if necessary

getEdu1_SetIDEDU

public SI getEdu1_SetIDEDU()

Returns EDU-1: "Set ID - EDU" - creates it if necessary

getAcademicDegree

public IS getAcademicDegree()

Returns EDU-2: "Academic Degree" - creates it if necessary

getEdu2_AcademicDegree

public IS getEdu2_AcademicDegree()

Returns EDU-2: "Academic Degree" - creates it if necessary

getAcademicDegreeProgramDateRange

public DR getAcademicDegreeProgramDateRange()

Returns EDU-3: "Academic Degree Program Date Range" - creates it if necessary

getEdu3_AcademicDegreeProgramDateRange

public DR getEdu3_AcademicDegreeProgramDateRange()

Returns EDU-3: "Academic Degree Program Date Range" - creates it if necessary

getAcademicDegreeProgramParticipationDateRange

public DR getAcademicDegreeProgramParticipationDateRange()

Returns EDU-4: "Academic Degree Program Participation Date Range" - creates it if necessary

getEdu4_AcademicDegreeProgramParticipationDateRange

public DR getEdu4_AcademicDegreeProgramParticipationDateRange()

Returns EDU-4: "Academic Degree Program Participation Date Range" - creates it if necessary

getAcademicDegreeGrantedDate

public DT getAcademicDegreeGrantedDate()

Returns EDU-5: "Academic Degree Granted Date" - creates it if necessary

getEdu5_AcademicDegreeGrantedDate

public DT getEdu5_AcademicDegreeGrantedDate()

Returns EDU-5: "Academic Degree Granted Date" - creates it if necessary

getSchool

public XON getSchool()

Returns EDU-6: "School" - creates it if necessary

getEdu6_School

public XON getEdu6_School()

Returns EDU-6: "School" - creates it if necessary

getSchoolTypeCode

public CE getSchoolTypeCode()

Returns EDU-7: "School Type Code" - creates it if necessary

getEdu7_SchoolTypeCode

public CE getEdu7_SchoolTypeCode()

Returns EDU-7: "School Type Code" - creates it if necessary

getSchoolAddress

public XAD getSchoolAddress()

Returns EDU-8: "School Address" - creates it if necessary

getEdu8_SchoolAddress

public XAD getEdu8_SchoolAddress()

Returns EDU-8: "School Address" - creates it if necessary

getMajorFieldOfStudy

public CWE[] getMajorFieldOfStudy()

Returns all repetitions of Major Field of Study (EDU-9).

getEdu9_MajorFieldOfStudy

public CWE[] getEdu9_MajorFieldOfStudy()

Returns all repetitions of Major Field of Study (EDU-9).

getMajorFieldOfStudyReps

public int getMajorFieldOfStudyReps()

Returns a count of the current number of repetitions of Major Field of Study (EDU-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getMajorFieldOfStudy

public CWE getMajorFieldOfStudy(int rep)

Returns a specific repetition of EDU-9: "Major Field of Study" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getEdu9_MajorFieldOfStudy

public CWE getEdu9_MajorFieldOfStudy(int rep)

Returns a specific repetition of EDU-9: "Major Field of Study" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getEdu9_MajorFieldOfStudyReps

public int getEdu9_MajorFieldOfStudyReps()

Returns a count of the current number of repetitions of Major Field of Study (EDU-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertMajorFieldOfStudy

public CWE insertMajorFieldOfStudy(int rep)
                            throws HL7Exception

Inserts a repetition of EDU-9: "Major Field of Study" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertEdu9_MajorFieldOfStudy

public CWE insertEdu9_MajorFieldOfStudy(int rep)
                                 throws HL7Exception

Inserts a repetition of EDU-9: "Major Field of Study" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeMajorFieldOfStudy

public CWE removeMajorFieldOfStudy(int rep)
                            throws HL7Exception

Removes a repetition of EDU-9: "Major Field of Study" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeEdu9_MajorFieldOfStudy

public CWE removeEdu9_MajorFieldOfStudy(int rep)
                                 throws HL7Exception

Removes a repetition of EDU-9: "Major Field of Study" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment