Package ca.uhn.hl7v2.model.v251.segment

Class NK1

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v251.segment.NK1

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class NK1
extends AbstractSegment

Represents an HL7 NK1 message segment (Next of Kin / Associated Parties). This segment has the following fields:

• NK1-1: Set ID - NK1 (SI)
• NK1-2: Name (XPN) optional repeating
• NK1-3: Relationship (CE) optional
• NK1-4: Address (XAD) optional repeating
• NK1-5: Phone Number (XTN) optional repeating
• NK1-6: Business Phone Number (XTN) optional repeating
• NK1-7: Contact Role (CE) optional
• NK1-8: Start Date (DT) optional
• NK1-9: End Date (DT) optional
• NK1-10: Next of Kin / Associated Parties Job Title (ST) optional
• NK1-11: Next of Kin / Associated Parties Job Code/Class (JCC) optional
• NK1-12: Next of Kin / Associated Parties Employee Number (CX) optional
• NK1-13: Organization Name - NK1 (XON) optional repeating
• NK1-14: Marital Status (CE) optional
• NK1-15: Administrative Sex (IS) optional
• NK1-16: Date/Time of Birth (TS) optional
• NK1-17: Living Dependency (IS) optional repeating
• NK1-18: Ambulatory Status (IS) optional repeating
• NK1-19: Citizenship (CE) optional repeating
• NK1-20: Primary Language (CE) optional
• NK1-21: Living Arrangement (IS) optional
• NK1-22: Publicity Code (CE) optional
• NK1-23: Protection Indicator (ID) optional
• NK1-24: Student Indicator (IS) optional
• NK1-25: Religion (CE) optional
• NK1-26: Mother's Maiden Name (XPN) optional repeating
• NK1-27: Nationality (CE) optional
• NK1-28: Ethnic Group (CE) optional repeating
• NK1-29: Contact Reason (CE) optional repeating
• NK1-30: Contact Person's Name (XPN) optional repeating
• NK1-31: Contact Person's Telephone Number (XTN) optional repeating
• NK1-32: Contact Person's Address (XAD) optional repeating
• NK1-33: Next of Kin/Associated Party's Identifiers (CX) optional repeating
• NK1-34: Job Status (IS) optional
• NK1-35: Race (CE) optional repeating
• NK1-36: Handicap (IS) optional
• NK1-37: Contact Person Social Security Number (ST) optional
• NK1-38: Next of Kin Birth Place (ST) optional
• NK1-39: VIP Indicator (IS) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Type	createNewTypeWithoutReflection(int field)
XAD[]	getAddress()	Returns all repetitions of Address (NK1-4).
XAD	getAddress(int rep)	Returns a specific repetition of NK1-4: "Address" - creates it if necessary
int	getAddressReps()	Returns a count of the current number of repetitions of Address (NK1-4).
IS	getAdministrativeSex()	Returns NK1-15: "Administrative Sex" - creates it if necessary
IS[]	getAmbulatoryStatus()	Returns all repetitions of Ambulatory Status (NK1-18).
IS	getAmbulatoryStatus(int rep)	Returns a specific repetition of NK1-18: "Ambulatory Status" - creates it if necessary
int	getAmbulatoryStatusReps()	Returns a count of the current number of repetitions of Ambulatory Status (NK1-18).
XTN[]	getBusinessPhoneNumber()	Returns all repetitions of Business Phone Number (NK1-6).
XTN	getBusinessPhoneNumber(int rep)	Returns a specific repetition of NK1-6: "Business Phone Number" - creates it if necessary
int	getBusinessPhoneNumberReps()	Returns a count of the current number of repetitions of Business Phone Number (NK1-6).
CE[]	getCitizenship()	Returns all repetitions of Citizenship (NK1-19).
CE	getCitizenship(int rep)	Returns a specific repetition of NK1-19: "Citizenship" - creates it if necessary
int	getCitizenshipReps()	Returns a count of the current number of repetitions of Citizenship (NK1-19).
XAD[]	getContactPersonSAddress()	Returns all repetitions of Contact Person's Address (NK1-32).
XAD	getContactPersonSAddress(int rep)	Returns a specific repetition of NK1-32: "Contact Person's Address" - creates it if necessary
int	getContactPersonSAddressReps()	Returns a count of the current number of repetitions of Contact Person's Address (NK1-32).
XPN[]	getContactPersonSName()	Returns all repetitions of Contact Person's Name (NK1-30).
XPN	getContactPersonSName(int rep)	Returns a specific repetition of NK1-30: "Contact Person's Name" - creates it if necessary
int	getContactPersonSNameReps()	Returns a count of the current number of repetitions of Contact Person's Name (NK1-30).
ST	getContactPersonSocialSecurityNumber()	Returns NK1-37: "Contact Person Social Security Number" - creates it if necessary
XTN[]	getContactPersonSTelephoneNumber()	Returns all repetitions of Contact Person's Telephone Number (NK1-31).
XTN	getContactPersonSTelephoneNumber(int rep)	Returns a specific repetition of NK1-31: "Contact Person's Telephone Number" - creates it if necessary
int	getContactPersonSTelephoneNumberReps()	Returns a count of the current number of repetitions of Contact Person's Telephone Number (NK1-31).
CE[]	getContactReason()	Returns all repetitions of Contact Reason (NK1-29).
CE	getContactReason(int rep)	Returns a specific repetition of NK1-29: "Contact Reason" - creates it if necessary
int	getContactReasonReps()	Returns a count of the current number of repetitions of Contact Reason (NK1-29).
CE	getContactRole()	Returns NK1-7: "Contact Role" - creates it if necessary
TS	getDateTimeOfBirth()	Returns NK1-16: "Date/Time of Birth" - creates it if necessary
DT	getEndDate()	Returns NK1-9: "End Date" - creates it if necessary
CE[]	getEthnicGroup()	Returns all repetitions of Ethnic Group (NK1-28).
CE	getEthnicGroup(int rep)	Returns a specific repetition of NK1-28: "Ethnic Group" - creates it if necessary
int	getEthnicGroupReps()	Returns a count of the current number of repetitions of Ethnic Group (NK1-28).
IS	getHandicap()	Returns NK1-36: "Handicap" - creates it if necessary
IS	getJobStatus()	Returns NK1-34: "Job Status" - creates it if necessary
IS	getLivingArrangement()	Returns NK1-21: "Living Arrangement" - creates it if necessary
IS[]	getLivingDependency()	Returns all repetitions of Living Dependency (NK1-17).
IS	getLivingDependency(int rep)	Returns a specific repetition of NK1-17: "Living Dependency" - creates it if necessary
int	getLivingDependencyReps()	Returns a count of the current number of repetitions of Living Dependency (NK1-17).
CE	getMaritalStatus()	Returns NK1-14: "Marital Status" - creates it if necessary
XPN[]	getMotherSMaidenName()	Returns all repetitions of Mother's Maiden Name (NK1-26).
XPN	getMotherSMaidenName(int rep)	Returns a specific repetition of NK1-26: "Mother's Maiden Name" - creates it if necessary
int	getMotherSMaidenNameReps()	Returns a count of the current number of repetitions of Mother's Maiden Name (NK1-26).
CE	getNationality()	Returns NK1-27: "Nationality" - creates it if necessary
CX	getNextOfKinAssociatedPartiesEmployeeNumber()	Returns NK1-12: "Next of Kin / Associated Parties Employee Number" - creates it if necessary
JCC	getNextOfKinAssociatedPartiesJobCodeClass()	Returns NK1-11: "Next of Kin / Associated Parties Job Code/Class" - creates it if necessary
ST	getNextOfKinAssociatedPartiesJobTitle()	Returns NK1-10: "Next of Kin / Associated Parties Job Title" - creates it if necessary
CX[]	getNextOfKinAssociatedPartySIdentifiers()	Returns all repetitions of Next of Kin/Associated Party's Identifiers (NK1-33).
CX	getNextOfKinAssociatedPartySIdentifiers(int rep)	Returns a specific repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" - creates it if necessary
int	getNextOfKinAssociatedPartySIdentifiersReps()	Returns a count of the current number of repetitions of Next of Kin/Associated Party's Identifiers (NK1-33).
ST	getNextOfKinBirthPlace()	Returns NK1-38: "Next of Kin Birth Place" - creates it if necessary
SI	getNk11_SetIDNK1()	Returns NK1-1: "Set ID - NK1" - creates it if necessary
ST	getNk110_NextOfKinAssociatedPartiesJobTitle()	Returns NK1-10: "Next of Kin / Associated Parties Job Title" - creates it if necessary
JCC	getNk111_NextOfKinAssociatedPartiesJobCodeClass()	Returns NK1-11: "Next of Kin / Associated Parties Job Code/Class" - creates it if necessary
CX	getNk112_NextOfKinAssociatedPartiesEmployeeNumber()	Returns NK1-12: "Next of Kin / Associated Parties Employee Number" - creates it if necessary
XON[]	getNk113_OrganizationNameNK1()	Returns all repetitions of Organization Name - NK1 (NK1-13).
XON	getNk113_OrganizationNameNK1(int rep)	Returns a specific repetition of NK1-13: "Organization Name - NK1" - creates it if necessary
int	getNk113_OrganizationNameNK1Reps()	Returns a count of the current number of repetitions of Organization Name - NK1 (NK1-13).
CE	getNk114_MaritalStatus()	Returns NK1-14: "Marital Status" - creates it if necessary
IS	getNk115_AdministrativeSex()	Returns NK1-15: "Administrative Sex" - creates it if necessary
TS	getNk116_DateTimeOfBirth()	Returns NK1-16: "Date/Time of Birth" - creates it if necessary
IS[]	getNk117_LivingDependency()	Returns all repetitions of Living Dependency (NK1-17).
IS	getNk117_LivingDependency(int rep)	Returns a specific repetition of NK1-17: "Living Dependency" - creates it if necessary
int	getNk117_LivingDependencyReps()	Returns a count of the current number of repetitions of Living Dependency (NK1-17).
IS[]	getNk118_AmbulatoryStatus()	Returns all repetitions of Ambulatory Status (NK1-18).
IS	getNk118_AmbulatoryStatus(int rep)	Returns a specific repetition of NK1-18: "Ambulatory Status" - creates it if necessary
int	getNk118_AmbulatoryStatusReps()	Returns a count of the current number of repetitions of Ambulatory Status (NK1-18).
CE[]	getNk119_Citizenship()	Returns all repetitions of Citizenship (NK1-19).
CE	getNk119_Citizenship(int rep)	Returns a specific repetition of NK1-19: "Citizenship" - creates it if necessary
int	getNk119_CitizenshipReps()	Returns a count of the current number of repetitions of Citizenship (NK1-19).
XPN[]	getNk12_Name()	Returns all repetitions of Name (NK1-2).
XPN	getNk12_Name(int rep)	Returns a specific repetition of NK1-2: "Name" - creates it if necessary
int	getNk12_NameReps()	Returns a count of the current number of repetitions of Name (NK1-2).
CE	getNk120_PrimaryLanguage()	Returns NK1-20: "Primary Language" - creates it if necessary
IS	getNk121_LivingArrangement()	Returns NK1-21: "Living Arrangement" - creates it if necessary
CE	getNk122_PublicityCode()	Returns NK1-22: "Publicity Code" - creates it if necessary
ID	getNk123_ProtectionIndicator()	Returns NK1-23: "Protection Indicator" - creates it if necessary
IS	getNk124_StudentIndicator()	Returns NK1-24: "Student Indicator" - creates it if necessary
CE	getNk125_Religion()	Returns NK1-25: "Religion" - creates it if necessary
XPN[]	getNk126_MotherSMaidenName()	Returns all repetitions of Mother's Maiden Name (NK1-26).
XPN	getNk126_MotherSMaidenName(int rep)	Returns a specific repetition of NK1-26: "Mother's Maiden Name" - creates it if necessary
int	getNk126_MotherSMaidenNameReps()	Returns a count of the current number of repetitions of Mother's Maiden Name (NK1-26).
CE	getNk127_Nationality()	Returns NK1-27: "Nationality" - creates it if necessary
CE[]	getNk128_EthnicGroup()	Returns all repetitions of Ethnic Group (NK1-28).
CE	getNk128_EthnicGroup(int rep)	Returns a specific repetition of NK1-28: "Ethnic Group" - creates it if necessary
int	getNk128_EthnicGroupReps()	Returns a count of the current number of repetitions of Ethnic Group (NK1-28).
CE[]	getNk129_ContactReason()	Returns all repetitions of Contact Reason (NK1-29).
CE	getNk129_ContactReason(int rep)	Returns a specific repetition of NK1-29: "Contact Reason" - creates it if necessary
int	getNk129_ContactReasonReps()	Returns a count of the current number of repetitions of Contact Reason (NK1-29).
CE	getNk13_Relationship()	Returns NK1-3: "Relationship" - creates it if necessary
XPN[]	getNk130_ContactPersonSName()	Returns all repetitions of Contact Person's Name (NK1-30).
XPN	getNk130_ContactPersonSName(int rep)	Returns a specific repetition of NK1-30: "Contact Person's Name" - creates it if necessary
int	getNk130_ContactPersonSNameReps()	Returns a count of the current number of repetitions of Contact Person's Name (NK1-30).
XTN[]	getNk131_ContactPersonSTelephoneNumber()	Returns all repetitions of Contact Person's Telephone Number (NK1-31).
XTN	getNk131_ContactPersonSTelephoneNumber(int rep)	Returns a specific repetition of NK1-31: "Contact Person's Telephone Number" - creates it if necessary
int	getNk131_ContactPersonSTelephoneNumberReps()	Returns a count of the current number of repetitions of Contact Person's Telephone Number (NK1-31).
XAD[]	getNk132_ContactPersonSAddress()	Returns all repetitions of Contact Person's Address (NK1-32).
XAD	getNk132_ContactPersonSAddress(int rep)	Returns a specific repetition of NK1-32: "Contact Person's Address" - creates it if necessary
int	getNk132_ContactPersonSAddressReps()	Returns a count of the current number of repetitions of Contact Person's Address (NK1-32).
CX[]	getNk133_NextOfKinAssociatedPartySIdentifiers()	Returns all repetitions of Next of Kin/Associated Party's Identifiers (NK1-33).
CX	getNk133_NextOfKinAssociatedPartySIdentifiers(int rep)	Returns a specific repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" - creates it if necessary
int	getNk133_NextOfKinAssociatedPartySIdentifiersReps()	Returns a count of the current number of repetitions of Next of Kin/Associated Party's Identifiers (NK1-33).
IS	getNk134_JobStatus()	Returns NK1-34: "Job Status" - creates it if necessary
CE[]	getNk135_Race()	Returns all repetitions of Race (NK1-35).
CE	getNk135_Race(int rep)	Returns a specific repetition of NK1-35: "Race" - creates it if necessary
int	getNk135_RaceReps()	Returns a count of the current number of repetitions of Race (NK1-35).
IS	getNk136_Handicap()	Returns NK1-36: "Handicap" - creates it if necessary
ST	getNk137_ContactPersonSocialSecurityNumber()	Returns NK1-37: "Contact Person Social Security Number" - creates it if necessary
ST	getNk138_NextOfKinBirthPlace()	Returns NK1-38: "Next of Kin Birth Place" - creates it if necessary
IS	getNk139_VIPIndicator()	Returns NK1-39: "VIP Indicator" - creates it if necessary
XAD[]	getNk14_Address()	Returns all repetitions of Address (NK1-4).
XAD	getNk14_Address(int rep)	Returns a specific repetition of NK1-4: "Address" - creates it if necessary
int	getNk14_AddressReps()	Returns a count of the current number of repetitions of Address (NK1-4).
XTN[]	getNk15_PhoneNumber()	Returns all repetitions of Phone Number (NK1-5).
XTN	getNk15_PhoneNumber(int rep)	Returns a specific repetition of NK1-5: "Phone Number" - creates it if necessary
int	getNk15_PhoneNumberReps()	Returns a count of the current number of repetitions of Phone Number (NK1-5).
XTN[]	getNk16_BusinessPhoneNumber()	Returns all repetitions of Business Phone Number (NK1-6).
XTN	getNk16_BusinessPhoneNumber(int rep)	Returns a specific repetition of NK1-6: "Business Phone Number" - creates it if necessary
int	getNk16_BusinessPhoneNumberReps()	Returns a count of the current number of repetitions of Business Phone Number (NK1-6).
CE	getNk17_ContactRole()	Returns NK1-7: "Contact Role" - creates it if necessary
DT	getNk18_StartDate()	Returns NK1-8: "Start Date" - creates it if necessary
DT	getNk19_EndDate()	Returns NK1-9: "End Date" - creates it if necessary
XPN[]	getNK1Name()	Returns all repetitions of Name (NK1-2).
XPN	getNK1Name(int rep)	Returns a specific repetition of NK1-2: "Name" - creates it if necessary
int	getNK1NameReps()	Returns a count of the current number of repetitions of Name (NK1-2).
XON[]	getOrganizationNameNK1()	Returns all repetitions of Organization Name - NK1 (NK1-13).
XON	getOrganizationNameNK1(int rep)	Returns a specific repetition of NK1-13: "Organization Name - NK1" - creates it if necessary
int	getOrganizationNameNK1Reps()	Returns a count of the current number of repetitions of Organization Name - NK1 (NK1-13).
XTN[]	getPhoneNumber()	Returns all repetitions of Phone Number (NK1-5).
XTN	getPhoneNumber(int rep)	Returns a specific repetition of NK1-5: "Phone Number" - creates it if necessary
int	getPhoneNumberReps()	Returns a count of the current number of repetitions of Phone Number (NK1-5).
CE	getPrimaryLanguage()	Returns NK1-20: "Primary Language" - creates it if necessary
ID	getProtectionIndicator()	Returns NK1-23: "Protection Indicator" - creates it if necessary
CE	getPublicityCode()	Returns NK1-22: "Publicity Code" - creates it if necessary
CE[]	getRace()	Returns all repetitions of Race (NK1-35).
CE	getRace(int rep)	Returns a specific repetition of NK1-35: "Race" - creates it if necessary
int	getRaceReps()	Returns a count of the current number of repetitions of Race (NK1-35).
CE	getRelationship()	Returns NK1-3: "Relationship" - creates it if necessary
CE	getReligion()	Returns NK1-25: "Religion" - creates it if necessary
SI	getSetIDNK1()	Returns NK1-1: "Set ID - NK1" - creates it if necessary
DT	getStartDate()	Returns NK1-8: "Start Date" - creates it if necessary
IS	getStudentIndicator()	Returns NK1-24: "Student Indicator" - creates it if necessary
IS	getVIPIndicator()	Returns NK1-39: "VIP Indicator" - creates it if necessary
XAD	insertAddress(int rep)	Inserts a repetition of NK1-4: "Address" at a specific index
IS	insertAmbulatoryStatus(int rep)	Inserts a repetition of NK1-18: "Ambulatory Status" at a specific index
XTN	insertBusinessPhoneNumber(int rep)	Inserts a repetition of NK1-6: "Business Phone Number" at a specific index
CE	insertCitizenship(int rep)	Inserts a repetition of NK1-19: "Citizenship" at a specific index
XAD	insertContactPersonSAddress(int rep)	Inserts a repetition of NK1-32: "Contact Person's Address" at a specific index
XPN	insertContactPersonSName(int rep)	Inserts a repetition of NK1-30: "Contact Person's Name" at a specific index
XTN	insertContactPersonSTelephoneNumber(int rep)	Inserts a repetition of NK1-31: "Contact Person's Telephone Number" at a specific index
CE	insertContactReason(int rep)	Inserts a repetition of NK1-29: "Contact Reason" at a specific index
CE	insertEthnicGroup(int rep)	Inserts a repetition of NK1-28: "Ethnic Group" at a specific index
IS	insertLivingDependency(int rep)	Inserts a repetition of NK1-17: "Living Dependency" at a specific index
XPN	insertMotherSMaidenName(int rep)	Inserts a repetition of NK1-26: "Mother's Maiden Name" at a specific index
CX	insertNextOfKinAssociatedPartySIdentifiers(int rep)	Inserts a repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" at a specific index
XON	insertNk113_OrganizationNameNK1(int rep)	Inserts a repetition of NK1-13: "Organization Name - NK1" at a specific index
IS	insertNk117_LivingDependency(int rep)	Inserts a repetition of NK1-17: "Living Dependency" at a specific index
IS	insertNk118_AmbulatoryStatus(int rep)	Inserts a repetition of NK1-18: "Ambulatory Status" at a specific index
CE	insertNk119_Citizenship(int rep)	Inserts a repetition of NK1-19: "Citizenship" at a specific index
XPN	insertNk12_Name(int rep)	Inserts a repetition of NK1-2: "Name" at a specific index
XPN	insertNk126_MotherSMaidenName(int rep)	Inserts a repetition of NK1-26: "Mother's Maiden Name" at a specific index
CE	insertNk128_EthnicGroup(int rep)	Inserts a repetition of NK1-28: "Ethnic Group" at a specific index
CE	insertNk129_ContactReason(int rep)	Inserts a repetition of NK1-29: "Contact Reason" at a specific index
XPN	insertNk130_ContactPersonSName(int rep)	Inserts a repetition of NK1-30: "Contact Person's Name" at a specific index
XTN	insertNk131_ContactPersonSTelephoneNumber(int rep)	Inserts a repetition of NK1-31: "Contact Person's Telephone Number" at a specific index
XAD	insertNk132_ContactPersonSAddress(int rep)	Inserts a repetition of NK1-32: "Contact Person's Address" at a specific index
CX	insertNk133_NextOfKinAssociatedPartySIdentifiers(int rep)	Inserts a repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" at a specific index
CE	insertNk135_Race(int rep)	Inserts a repetition of NK1-35: "Race" at a specific index
XAD	insertNk14_Address(int rep)	Inserts a repetition of NK1-4: "Address" at a specific index
XTN	insertNk15_PhoneNumber(int rep)	Inserts a repetition of NK1-5: "Phone Number" at a specific index
XTN	insertNk16_BusinessPhoneNumber(int rep)	Inserts a repetition of NK1-6: "Business Phone Number" at a specific index
XPN	insertNK1Name(int rep)	Inserts a repetition of NK1-2: "Name" at a specific index
XON	insertOrganizationNameNK1(int rep)	Inserts a repetition of NK1-13: "Organization Name - NK1" at a specific index
XTN	insertPhoneNumber(int rep)	Inserts a repetition of NK1-5: "Phone Number" at a specific index
CE	insertRace(int rep)	Inserts a repetition of NK1-35: "Race" at a specific index
XAD	removeAddress(int rep)	Removes a repetition of NK1-4: "Address" at a specific index
IS	removeAmbulatoryStatus(int rep)	Removes a repetition of NK1-18: "Ambulatory Status" at a specific index
XTN	removeBusinessPhoneNumber(int rep)	Removes a repetition of NK1-6: "Business Phone Number" at a specific index
CE	removeCitizenship(int rep)	Removes a repetition of NK1-19: "Citizenship" at a specific index
XAD	removeContactPersonSAddress(int rep)	Removes a repetition of NK1-32: "Contact Person's Address" at a specific index
XPN	removeContactPersonSName(int rep)	Removes a repetition of NK1-30: "Contact Person's Name" at a specific index
XTN	removeContactPersonSTelephoneNumber(int rep)	Removes a repetition of NK1-31: "Contact Person's Telephone Number" at a specific index
CE	removeContactReason(int rep)	Removes a repetition of NK1-29: "Contact Reason" at a specific index
CE	removeEthnicGroup(int rep)	Removes a repetition of NK1-28: "Ethnic Group" at a specific index
IS	removeLivingDependency(int rep)	Removes a repetition of NK1-17: "Living Dependency" at a specific index
XPN	removeMotherSMaidenName(int rep)	Removes a repetition of NK1-26: "Mother's Maiden Name" at a specific index
CX	removeNextOfKinAssociatedPartySIdentifiers(int rep)	Removes a repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" at a specific index
XON	removeNk113_OrganizationNameNK1(int rep)	Removes a repetition of NK1-13: "Organization Name - NK1" at a specific index
IS	removeNk117_LivingDependency(int rep)	Removes a repetition of NK1-17: "Living Dependency" at a specific index
IS	removeNk118_AmbulatoryStatus(int rep)	Removes a repetition of NK1-18: "Ambulatory Status" at a specific index
CE	removeNk119_Citizenship(int rep)	Removes a repetition of NK1-19: "Citizenship" at a specific index
XPN	removeNk12_Name(int rep)	Removes a repetition of NK1-2: "Name" at a specific index
XPN	removeNk126_MotherSMaidenName(int rep)	Removes a repetition of NK1-26: "Mother's Maiden Name" at a specific index
CE	removeNk128_EthnicGroup(int rep)	Removes a repetition of NK1-28: "Ethnic Group" at a specific index
CE	removeNk129_ContactReason(int rep)	Removes a repetition of NK1-29: "Contact Reason" at a specific index
XPN	removeNk130_ContactPersonSName(int rep)	Removes a repetition of NK1-30: "Contact Person's Name" at a specific index
XTN	removeNk131_ContactPersonSTelephoneNumber(int rep)	Removes a repetition of NK1-31: "Contact Person's Telephone Number" at a specific index
XAD	removeNk132_ContactPersonSAddress(int rep)	Removes a repetition of NK1-32: "Contact Person's Address" at a specific index
CX	removeNk133_NextOfKinAssociatedPartySIdentifiers(int rep)	Removes a repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" at a specific index
CE	removeNk135_Race(int rep)	Removes a repetition of NK1-35: "Race" at a specific index
XAD	removeNk14_Address(int rep)	Removes a repetition of NK1-4: "Address" at a specific index
XTN	removeNk15_PhoneNumber(int rep)	Removes a repetition of NK1-5: "Phone Number" at a specific index
XTN	removeNk16_BusinessPhoneNumber(int rep)	Removes a repetition of NK1-6: "Business Phone Number" at a specific index
XPN	removeNK1Name(int rep)	Removes a repetition of NK1-2: "Name" at a specific index
XON	removeOrganizationNameNK1(int rep)	Removes a repetition of NK1-13: "Organization Name - NK1" at a specific index
XTN	removePhoneNumber(int rep)	Removes a repetition of NK1-5: "Phone Number" at a specific index
CE	removeRace(int rep)	Removes a repetition of NK1-35: "Race" 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 Details

NK1

public NK1(Group parent,
 ModelClassFactory factory)

Creates a new NK1 segment

Method Details

getSetIDNK1

public SI getSetIDNK1()

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

getNk11_SetIDNK1

public SI getNk11_SetIDNK1()

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

getNK1Name

public XPN[] getNK1Name()

Returns all repetitions of Name (NK1-2).

getNk12_Name

public XPN[] getNk12_Name()

Returns all repetitions of Name (NK1-2).

getNK1NameReps

public int getNK1NameReps()

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

getNK1Name

public XPN getNK1Name(int rep)

Returns a specific repetition of NK1-2: "Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk12_Name

public XPN getNk12_Name(int rep)

Returns a specific repetition of NK1-2: "Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk12_NameReps

public int getNk12_NameReps()

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

insertNK1Name

public XPN insertNK1Name(int rep)
                  throws HL7Exception

Inserts a repetition of NK1-2: "Name" 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)

insertNk12_Name

public XPN insertNk12_Name(int rep)
                    throws HL7Exception

Inserts a repetition of NK1-2: "Name" 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)

removeNK1Name

public XPN removeNK1Name(int rep)
                  throws HL7Exception

Removes a repetition of NK1-2: "Name" 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)

removeNk12_Name

public XPN removeNk12_Name(int rep)
                    throws HL7Exception

Removes a repetition of NK1-2: "Name" 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)

getRelationship

public CE getRelationship()

Returns NK1-3: "Relationship" - creates it if necessary

getNk13_Relationship

public CE getNk13_Relationship()

Returns NK1-3: "Relationship" - creates it if necessary

getAddress

public XAD[] getAddress()

Returns all repetitions of Address (NK1-4).

getNk14_Address

public XAD[] getNk14_Address()

Returns all repetitions of Address (NK1-4).

getAddressReps

public int getAddressReps()

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

getAddress

public XAD getAddress(int rep)

Returns a specific repetition of NK1-4: "Address" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk14_Address

public XAD getNk14_Address(int rep)

Returns a specific repetition of NK1-4: "Address" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk14_AddressReps

public int getNk14_AddressReps()

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

insertAddress

public XAD insertAddress(int rep)
                  throws HL7Exception

Inserts a repetition of NK1-4: "Address" 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)

insertNk14_Address

public XAD insertNk14_Address(int rep)
                       throws HL7Exception

Inserts a repetition of NK1-4: "Address" 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)

removeAddress

public XAD removeAddress(int rep)
                  throws HL7Exception

Removes a repetition of NK1-4: "Address" 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)

removeNk14_Address

public XAD removeNk14_Address(int rep)
                       throws HL7Exception

Removes a repetition of NK1-4: "Address" 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)

getPhoneNumber

public XTN[] getPhoneNumber()

Returns all repetitions of Phone Number (NK1-5).

getNk15_PhoneNumber

public XTN[] getNk15_PhoneNumber()

Returns all repetitions of Phone Number (NK1-5).

getPhoneNumberReps

public int getPhoneNumberReps()

Returns a count of the current number of repetitions of Phone Number (NK1-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getPhoneNumber

public XTN getPhoneNumber(int rep)

Returns a specific repetition of NK1-5: "Phone Number" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk15_PhoneNumber

public XTN getNk15_PhoneNumber(int rep)

Returns a specific repetition of NK1-5: "Phone Number" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk15_PhoneNumberReps

public int getNk15_PhoneNumberReps()

Returns a count of the current number of repetitions of Phone Number (NK1-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertPhoneNumber

public XTN insertPhoneNumber(int rep)
                      throws HL7Exception

Inserts a repetition of NK1-5: "Phone Number" 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)

insertNk15_PhoneNumber

public XTN insertNk15_PhoneNumber(int rep)
                           throws HL7Exception

Inserts a repetition of NK1-5: "Phone Number" 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)

removePhoneNumber

public XTN removePhoneNumber(int rep)
                      throws HL7Exception

Removes a repetition of NK1-5: "Phone Number" 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)

removeNk15_PhoneNumber

public XTN removeNk15_PhoneNumber(int rep)
                           throws HL7Exception

Removes a repetition of NK1-5: "Phone Number" 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)

getBusinessPhoneNumber

public XTN[] getBusinessPhoneNumber()

Returns all repetitions of Business Phone Number (NK1-6).

getNk16_BusinessPhoneNumber

public XTN[] getNk16_BusinessPhoneNumber()

Returns all repetitions of Business Phone Number (NK1-6).

getBusinessPhoneNumberReps

public int getBusinessPhoneNumberReps()

Returns a count of the current number of repetitions of Business Phone Number (NK1-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getBusinessPhoneNumber

public XTN getBusinessPhoneNumber(int rep)

Returns a specific repetition of NK1-6: "Business Phone Number" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk16_BusinessPhoneNumber

public XTN getNk16_BusinessPhoneNumber(int rep)

Returns a specific repetition of NK1-6: "Business Phone Number" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk16_BusinessPhoneNumberReps

public int getNk16_BusinessPhoneNumberReps()

Returns a count of the current number of repetitions of Business Phone Number (NK1-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertBusinessPhoneNumber

public XTN insertBusinessPhoneNumber(int rep)
                              throws HL7Exception

Inserts a repetition of NK1-6: "Business Phone Number" 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)

insertNk16_BusinessPhoneNumber

public XTN insertNk16_BusinessPhoneNumber(int rep)
                                   throws HL7Exception

Inserts a repetition of NK1-6: "Business Phone Number" 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)

removeBusinessPhoneNumber

public XTN removeBusinessPhoneNumber(int rep)
                              throws HL7Exception

Removes a repetition of NK1-6: "Business Phone Number" 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)

removeNk16_BusinessPhoneNumber

public XTN removeNk16_BusinessPhoneNumber(int rep)
                                   throws HL7Exception

Removes a repetition of NK1-6: "Business Phone Number" 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)

getContactRole

public CE getContactRole()

Returns NK1-7: "Contact Role" - creates it if necessary

getNk17_ContactRole

public CE getNk17_ContactRole()

Returns NK1-7: "Contact Role" - creates it if necessary

getStartDate

public DT getStartDate()

Returns NK1-8: "Start Date" - creates it if necessary

getNk18_StartDate

public DT getNk18_StartDate()

Returns NK1-8: "Start Date" - creates it if necessary

getEndDate

public DT getEndDate()

Returns NK1-9: "End Date" - creates it if necessary

getNk19_EndDate

public DT getNk19_EndDate()

Returns NK1-9: "End Date" - creates it if necessary

getNextOfKinAssociatedPartiesJobTitle

public ST getNextOfKinAssociatedPartiesJobTitle()

Returns NK1-10: "Next of Kin / Associated Parties Job Title" - creates it if necessary

getNk110_NextOfKinAssociatedPartiesJobTitle

public ST getNk110_NextOfKinAssociatedPartiesJobTitle()

Returns NK1-10: "Next of Kin / Associated Parties Job Title" - creates it if necessary

getNextOfKinAssociatedPartiesJobCodeClass

public JCC getNextOfKinAssociatedPartiesJobCodeClass()

Returns NK1-11: "Next of Kin / Associated Parties Job Code/Class" - creates it if necessary

getNk111_NextOfKinAssociatedPartiesJobCodeClass

public JCC getNk111_NextOfKinAssociatedPartiesJobCodeClass()

Returns NK1-11: "Next of Kin / Associated Parties Job Code/Class" - creates it if necessary

getNextOfKinAssociatedPartiesEmployeeNumber

public CX getNextOfKinAssociatedPartiesEmployeeNumber()

Returns NK1-12: "Next of Kin / Associated Parties Employee Number" - creates it if necessary

getNk112_NextOfKinAssociatedPartiesEmployeeNumber

public CX getNk112_NextOfKinAssociatedPartiesEmployeeNumber()

Returns NK1-12: "Next of Kin / Associated Parties Employee Number" - creates it if necessary

getOrganizationNameNK1

public XON[] getOrganizationNameNK1()

Returns all repetitions of Organization Name - NK1 (NK1-13).

getNk113_OrganizationNameNK1

public XON[] getNk113_OrganizationNameNK1()

Returns all repetitions of Organization Name - NK1 (NK1-13).

getOrganizationNameNK1Reps

public int getOrganizationNameNK1Reps()

Returns a count of the current number of repetitions of Organization Name - NK1 (NK1-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getOrganizationNameNK1

public XON getOrganizationNameNK1(int rep)

Returns a specific repetition of NK1-13: "Organization Name - NK1" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk113_OrganizationNameNK1

public XON getNk113_OrganizationNameNK1(int rep)

Returns a specific repetition of NK1-13: "Organization Name - NK1" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk113_OrganizationNameNK1Reps

public int getNk113_OrganizationNameNK1Reps()

Returns a count of the current number of repetitions of Organization Name - NK1 (NK1-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertOrganizationNameNK1

public XON insertOrganizationNameNK1(int rep)
                              throws HL7Exception

Inserts a repetition of NK1-13: "Organization Name - NK1" 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)

insertNk113_OrganizationNameNK1

public XON insertNk113_OrganizationNameNK1(int rep)
                                    throws HL7Exception

Inserts a repetition of NK1-13: "Organization Name - NK1" 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)

removeOrganizationNameNK1

public XON removeOrganizationNameNK1(int rep)
                              throws HL7Exception

Removes a repetition of NK1-13: "Organization Name - NK1" 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)

removeNk113_OrganizationNameNK1

public XON removeNk113_OrganizationNameNK1(int rep)
                                    throws HL7Exception

Removes a repetition of NK1-13: "Organization Name - NK1" 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)

getMaritalStatus

public CE getMaritalStatus()

Returns NK1-14: "Marital Status" - creates it if necessary

getNk114_MaritalStatus

public CE getNk114_MaritalStatus()

Returns NK1-14: "Marital Status" - creates it if necessary

getAdministrativeSex

public IS getAdministrativeSex()

Returns NK1-15: "Administrative Sex" - creates it if necessary

getNk115_AdministrativeSex

public IS getNk115_AdministrativeSex()

Returns NK1-15: "Administrative Sex" - creates it if necessary

getDateTimeOfBirth

public TS getDateTimeOfBirth()

Returns NK1-16: "Date/Time of Birth" - creates it if necessary

getNk116_DateTimeOfBirth

public TS getNk116_DateTimeOfBirth()

Returns NK1-16: "Date/Time of Birth" - creates it if necessary

getLivingDependency

public IS[] getLivingDependency()

Returns all repetitions of Living Dependency (NK1-17).

getNk117_LivingDependency

public IS[] getNk117_LivingDependency()

Returns all repetitions of Living Dependency (NK1-17).

getLivingDependencyReps

public int getLivingDependencyReps()

Returns a count of the current number of repetitions of Living Dependency (NK1-17). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getLivingDependency

public IS getLivingDependency(int rep)

Returns a specific repetition of NK1-17: "Living Dependency" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk117_LivingDependency

public IS getNk117_LivingDependency(int rep)

Returns a specific repetition of NK1-17: "Living Dependency" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk117_LivingDependencyReps

public int getNk117_LivingDependencyReps()

Returns a count of the current number of repetitions of Living Dependency (NK1-17). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertLivingDependency

public IS insertLivingDependency(int rep)
                          throws HL7Exception

Inserts a repetition of NK1-17: "Living Dependency" 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)

insertNk117_LivingDependency

public IS insertNk117_LivingDependency(int rep)
                                throws HL7Exception

Inserts a repetition of NK1-17: "Living Dependency" 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)

removeLivingDependency

public IS removeLivingDependency(int rep)
                          throws HL7Exception

Removes a repetition of NK1-17: "Living Dependency" 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)

removeNk117_LivingDependency

public IS removeNk117_LivingDependency(int rep)
                                throws HL7Exception

Removes a repetition of NK1-17: "Living Dependency" 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)

getAmbulatoryStatus

public IS[] getAmbulatoryStatus()

Returns all repetitions of Ambulatory Status (NK1-18).

getNk118_AmbulatoryStatus

public IS[] getNk118_AmbulatoryStatus()

Returns all repetitions of Ambulatory Status (NK1-18).

getAmbulatoryStatusReps

public int getAmbulatoryStatusReps()

Returns a count of the current number of repetitions of Ambulatory Status (NK1-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getAmbulatoryStatus

public IS getAmbulatoryStatus(int rep)

Returns a specific repetition of NK1-18: "Ambulatory Status" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk118_AmbulatoryStatus

public IS getNk118_AmbulatoryStatus(int rep)

Returns a specific repetition of NK1-18: "Ambulatory Status" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk118_AmbulatoryStatusReps

public int getNk118_AmbulatoryStatusReps()

Returns a count of the current number of repetitions of Ambulatory Status (NK1-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertAmbulatoryStatus

public IS insertAmbulatoryStatus(int rep)
                          throws HL7Exception

Inserts a repetition of NK1-18: "Ambulatory Status" 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)

insertNk118_AmbulatoryStatus

public IS insertNk118_AmbulatoryStatus(int rep)
                                throws HL7Exception

Inserts a repetition of NK1-18: "Ambulatory Status" 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)

removeAmbulatoryStatus

public IS removeAmbulatoryStatus(int rep)
                          throws HL7Exception

Removes a repetition of NK1-18: "Ambulatory Status" 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)

removeNk118_AmbulatoryStatus

public IS removeNk118_AmbulatoryStatus(int rep)
                                throws HL7Exception

Removes a repetition of NK1-18: "Ambulatory Status" 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)

getCitizenship

public CE[] getCitizenship()

Returns all repetitions of Citizenship (NK1-19).

getNk119_Citizenship

public CE[] getNk119_Citizenship()

Returns all repetitions of Citizenship (NK1-19).

getCitizenshipReps

public int getCitizenshipReps()

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

getCitizenship

public CE getCitizenship(int rep)

Returns a specific repetition of NK1-19: "Citizenship" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk119_Citizenship

public CE getNk119_Citizenship(int rep)

Returns a specific repetition of NK1-19: "Citizenship" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk119_CitizenshipReps

public int getNk119_CitizenshipReps()

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

insertCitizenship

public CE insertCitizenship(int rep)
                     throws HL7Exception

Inserts a repetition of NK1-19: "Citizenship" 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)

insertNk119_Citizenship

public CE insertNk119_Citizenship(int rep)
                           throws HL7Exception

Inserts a repetition of NK1-19: "Citizenship" 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)

removeCitizenship

public CE removeCitizenship(int rep)
                     throws HL7Exception

Removes a repetition of NK1-19: "Citizenship" 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)

removeNk119_Citizenship

public CE removeNk119_Citizenship(int rep)
                           throws HL7Exception

Removes a repetition of NK1-19: "Citizenship" 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)

getPrimaryLanguage

public CE getPrimaryLanguage()

Returns NK1-20: "Primary Language" - creates it if necessary

getNk120_PrimaryLanguage

public CE getNk120_PrimaryLanguage()

Returns NK1-20: "Primary Language" - creates it if necessary

getLivingArrangement

public IS getLivingArrangement()

Returns NK1-21: "Living Arrangement" - creates it if necessary

getNk121_LivingArrangement

public IS getNk121_LivingArrangement()

Returns NK1-21: "Living Arrangement" - creates it if necessary

getPublicityCode

public CE getPublicityCode()

Returns NK1-22: "Publicity Code" - creates it if necessary

getNk122_PublicityCode

public CE getNk122_PublicityCode()

Returns NK1-22: "Publicity Code" - creates it if necessary

getProtectionIndicator

public ID getProtectionIndicator()

Returns NK1-23: "Protection Indicator" - creates it if necessary

getNk123_ProtectionIndicator

public ID getNk123_ProtectionIndicator()

Returns NK1-23: "Protection Indicator" - creates it if necessary

getStudentIndicator

public IS getStudentIndicator()

Returns NK1-24: "Student Indicator" - creates it if necessary

getNk124_StudentIndicator

public IS getNk124_StudentIndicator()

Returns NK1-24: "Student Indicator" - creates it if necessary

getReligion

public CE getReligion()

Returns NK1-25: "Religion" - creates it if necessary

getNk125_Religion

public CE getNk125_Religion()

Returns NK1-25: "Religion" - creates it if necessary

getMotherSMaidenName

public XPN[] getMotherSMaidenName()

Returns all repetitions of Mother's Maiden Name (NK1-26).

getNk126_MotherSMaidenName

public XPN[] getNk126_MotherSMaidenName()

Returns all repetitions of Mother's Maiden Name (NK1-26).

getMotherSMaidenNameReps

public int getMotherSMaidenNameReps()

Returns a count of the current number of repetitions of Mother's Maiden Name (NK1-26). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getMotherSMaidenName

public XPN getMotherSMaidenName(int rep)

Returns a specific repetition of NK1-26: "Mother's Maiden Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk126_MotherSMaidenName

public XPN getNk126_MotherSMaidenName(int rep)

Returns a specific repetition of NK1-26: "Mother's Maiden Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk126_MotherSMaidenNameReps

public int getNk126_MotherSMaidenNameReps()

Returns a count of the current number of repetitions of Mother's Maiden Name (NK1-26). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertMotherSMaidenName

public XPN insertMotherSMaidenName(int rep)
                            throws HL7Exception

Inserts a repetition of NK1-26: "Mother's Maiden Name" 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)

insertNk126_MotherSMaidenName

public XPN insertNk126_MotherSMaidenName(int rep)
                                  throws HL7Exception

Inserts a repetition of NK1-26: "Mother's Maiden Name" 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)

removeMotherSMaidenName

public XPN removeMotherSMaidenName(int rep)
                            throws HL7Exception

Removes a repetition of NK1-26: "Mother's Maiden Name" 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)

removeNk126_MotherSMaidenName

public XPN removeNk126_MotherSMaidenName(int rep)
                                  throws HL7Exception

Removes a repetition of NK1-26: "Mother's Maiden Name" 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)

getNationality

public CE getNationality()

Returns NK1-27: "Nationality" - creates it if necessary

getNk127_Nationality

public CE getNk127_Nationality()

Returns NK1-27: "Nationality" - creates it if necessary

getEthnicGroup

public CE[] getEthnicGroup()

Returns all repetitions of Ethnic Group (NK1-28).

getNk128_EthnicGroup

public CE[] getNk128_EthnicGroup()

Returns all repetitions of Ethnic Group (NK1-28).

getEthnicGroupReps

public int getEthnicGroupReps()

Returns a count of the current number of repetitions of Ethnic Group (NK1-28). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getEthnicGroup

public CE getEthnicGroup(int rep)

Returns a specific repetition of NK1-28: "Ethnic Group" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk128_EthnicGroup

public CE getNk128_EthnicGroup(int rep)

Returns a specific repetition of NK1-28: "Ethnic Group" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk128_EthnicGroupReps

public int getNk128_EthnicGroupReps()

Returns a count of the current number of repetitions of Ethnic Group (NK1-28). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertEthnicGroup

public CE insertEthnicGroup(int rep)
                     throws HL7Exception

Inserts a repetition of NK1-28: "Ethnic Group" 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)

insertNk128_EthnicGroup

public CE insertNk128_EthnicGroup(int rep)
                           throws HL7Exception

Inserts a repetition of NK1-28: "Ethnic Group" 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)

removeEthnicGroup

public CE removeEthnicGroup(int rep)
                     throws HL7Exception

Removes a repetition of NK1-28: "Ethnic Group" 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)

removeNk128_EthnicGroup

public CE removeNk128_EthnicGroup(int rep)
                           throws HL7Exception

Removes a repetition of NK1-28: "Ethnic Group" 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)

getContactReason

public CE[] getContactReason()

Returns all repetitions of Contact Reason (NK1-29).

getNk129_ContactReason

public CE[] getNk129_ContactReason()

Returns all repetitions of Contact Reason (NK1-29).

getContactReasonReps

public int getContactReasonReps()

Returns a count of the current number of repetitions of Contact Reason (NK1-29). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getContactReason

public CE getContactReason(int rep)

Returns a specific repetition of NK1-29: "Contact Reason" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk129_ContactReason

public CE getNk129_ContactReason(int rep)

Returns a specific repetition of NK1-29: "Contact Reason" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk129_ContactReasonReps

public int getNk129_ContactReasonReps()

Returns a count of the current number of repetitions of Contact Reason (NK1-29). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertContactReason

public CE insertContactReason(int rep)
                       throws HL7Exception

Inserts a repetition of NK1-29: "Contact Reason" 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)

insertNk129_ContactReason

public CE insertNk129_ContactReason(int rep)
                             throws HL7Exception

Inserts a repetition of NK1-29: "Contact Reason" 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)

removeContactReason

public CE removeContactReason(int rep)
                       throws HL7Exception

Removes a repetition of NK1-29: "Contact Reason" 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)

removeNk129_ContactReason

public CE removeNk129_ContactReason(int rep)
                             throws HL7Exception

Removes a repetition of NK1-29: "Contact Reason" 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)

getContactPersonSName

public XPN[] getContactPersonSName()

Returns all repetitions of Contact Person's Name (NK1-30).

getNk130_ContactPersonSName

public XPN[] getNk130_ContactPersonSName()

Returns all repetitions of Contact Person's Name (NK1-30).

getContactPersonSNameReps

public int getContactPersonSNameReps()

Returns a count of the current number of repetitions of Contact Person's Name (NK1-30). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getContactPersonSName

public XPN getContactPersonSName(int rep)

Returns a specific repetition of NK1-30: "Contact Person's Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk130_ContactPersonSName

public XPN getNk130_ContactPersonSName(int rep)

Returns a specific repetition of NK1-30: "Contact Person's Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk130_ContactPersonSNameReps

public int getNk130_ContactPersonSNameReps()

Returns a count of the current number of repetitions of Contact Person's Name (NK1-30). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertContactPersonSName

public XPN insertContactPersonSName(int rep)
                             throws HL7Exception

Inserts a repetition of NK1-30: "Contact Person's Name" 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)

insertNk130_ContactPersonSName

public XPN insertNk130_ContactPersonSName(int rep)
                                   throws HL7Exception

Inserts a repetition of NK1-30: "Contact Person's Name" 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)

removeContactPersonSName

public XPN removeContactPersonSName(int rep)
                             throws HL7Exception

Removes a repetition of NK1-30: "Contact Person's Name" 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)

removeNk130_ContactPersonSName

public XPN removeNk130_ContactPersonSName(int rep)
                                   throws HL7Exception

Removes a repetition of NK1-30: "Contact Person's Name" 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)

getContactPersonSTelephoneNumber

public XTN[] getContactPersonSTelephoneNumber()

Returns all repetitions of Contact Person's Telephone Number (NK1-31).

getNk131_ContactPersonSTelephoneNumber

public XTN[] getNk131_ContactPersonSTelephoneNumber()

Returns all repetitions of Contact Person's Telephone Number (NK1-31).

getContactPersonSTelephoneNumberReps

public int getContactPersonSTelephoneNumberReps()

Returns a count of the current number of repetitions of Contact Person's Telephone Number (NK1-31). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getContactPersonSTelephoneNumber

public XTN getContactPersonSTelephoneNumber(int rep)

Returns a specific repetition of NK1-31: "Contact Person's Telephone Number" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk131_ContactPersonSTelephoneNumber

public XTN getNk131_ContactPersonSTelephoneNumber(int rep)

Returns a specific repetition of NK1-31: "Contact Person's Telephone Number" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk131_ContactPersonSTelephoneNumberReps

public int getNk131_ContactPersonSTelephoneNumberReps()

Returns a count of the current number of repetitions of Contact Person's Telephone Number (NK1-31). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertContactPersonSTelephoneNumber

public XTN insertContactPersonSTelephoneNumber(int rep)
                                        throws HL7Exception

Inserts a repetition of NK1-31: "Contact Person's Telephone Number" 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)

insertNk131_ContactPersonSTelephoneNumber

public XTN insertNk131_ContactPersonSTelephoneNumber(int rep)
                                              throws HL7Exception

Inserts a repetition of NK1-31: "Contact Person's Telephone Number" 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)

removeContactPersonSTelephoneNumber

public XTN removeContactPersonSTelephoneNumber(int rep)
                                        throws HL7Exception

Removes a repetition of NK1-31: "Contact Person's Telephone Number" 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)

removeNk131_ContactPersonSTelephoneNumber

public XTN removeNk131_ContactPersonSTelephoneNumber(int rep)
                                              throws HL7Exception

Removes a repetition of NK1-31: "Contact Person's Telephone Number" 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)

getContactPersonSAddress

public XAD[] getContactPersonSAddress()

Returns all repetitions of Contact Person's Address (NK1-32).

getNk132_ContactPersonSAddress

public XAD[] getNk132_ContactPersonSAddress()

Returns all repetitions of Contact Person's Address (NK1-32).

getContactPersonSAddressReps

public int getContactPersonSAddressReps()

Returns a count of the current number of repetitions of Contact Person's Address (NK1-32). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getContactPersonSAddress

public XAD getContactPersonSAddress(int rep)

Returns a specific repetition of NK1-32: "Contact Person's Address" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk132_ContactPersonSAddress

public XAD getNk132_ContactPersonSAddress(int rep)

Returns a specific repetition of NK1-32: "Contact Person's Address" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk132_ContactPersonSAddressReps

public int getNk132_ContactPersonSAddressReps()

Returns a count of the current number of repetitions of Contact Person's Address (NK1-32). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertContactPersonSAddress

public XAD insertContactPersonSAddress(int rep)
                                throws HL7Exception

Inserts a repetition of NK1-32: "Contact Person's Address" 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)

insertNk132_ContactPersonSAddress

public XAD insertNk132_ContactPersonSAddress(int rep)
                                      throws HL7Exception

Inserts a repetition of NK1-32: "Contact Person's Address" 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)

removeContactPersonSAddress

public XAD removeContactPersonSAddress(int rep)
                                throws HL7Exception

Removes a repetition of NK1-32: "Contact Person's Address" 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)

removeNk132_ContactPersonSAddress

public XAD removeNk132_ContactPersonSAddress(int rep)
                                      throws HL7Exception

Removes a repetition of NK1-32: "Contact Person's Address" 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)

getNextOfKinAssociatedPartySIdentifiers

public CX[] getNextOfKinAssociatedPartySIdentifiers()

Returns all repetitions of Next of Kin/Associated Party's Identifiers (NK1-33).

getNk133_NextOfKinAssociatedPartySIdentifiers

public CX[] getNk133_NextOfKinAssociatedPartySIdentifiers()

Returns all repetitions of Next of Kin/Associated Party's Identifiers (NK1-33).

getNextOfKinAssociatedPartySIdentifiersReps

public int getNextOfKinAssociatedPartySIdentifiersReps()

Returns a count of the current number of repetitions of Next of Kin/Associated Party's Identifiers (NK1-33). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getNextOfKinAssociatedPartySIdentifiers

public CX getNextOfKinAssociatedPartySIdentifiers(int rep)

Returns a specific repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk133_NextOfKinAssociatedPartySIdentifiers

public CX getNk133_NextOfKinAssociatedPartySIdentifiers(int rep)

Returns a specific repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk133_NextOfKinAssociatedPartySIdentifiersReps

public int getNk133_NextOfKinAssociatedPartySIdentifiersReps()

Returns a count of the current number of repetitions of Next of Kin/Associated Party's Identifiers (NK1-33). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertNextOfKinAssociatedPartySIdentifiers

public CX insertNextOfKinAssociatedPartySIdentifiers(int rep)
                                              throws HL7Exception

Inserts a repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" 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)

insertNk133_NextOfKinAssociatedPartySIdentifiers

public CX insertNk133_NextOfKinAssociatedPartySIdentifiers(int rep)
                                                    throws HL7Exception

Inserts a repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" 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)

removeNextOfKinAssociatedPartySIdentifiers

public CX removeNextOfKinAssociatedPartySIdentifiers(int rep)
                                              throws HL7Exception

Removes a repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" 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)

removeNk133_NextOfKinAssociatedPartySIdentifiers

public CX removeNk133_NextOfKinAssociatedPartySIdentifiers(int rep)
                                                    throws HL7Exception

Removes a repetition of NK1-33: "Next of Kin/Associated Party's Identifiers" 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)

getJobStatus

public IS getJobStatus()

Returns NK1-34: "Job Status" - creates it if necessary

getNk134_JobStatus

public IS getNk134_JobStatus()

Returns NK1-34: "Job Status" - creates it if necessary

getRace

public CE[] getRace()

Returns all repetitions of Race (NK1-35).

getNk135_Race

public CE[] getNk135_Race()

Returns all repetitions of Race (NK1-35).

getRaceReps

public int getRaceReps()

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

getRace

public CE getRace(int rep)

Returns a specific repetition of NK1-35: "Race" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk135_Race

public CE getNk135_Race(int rep)

Returns a specific repetition of NK1-35: "Race" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNk135_RaceReps

public int getNk135_RaceReps()

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

insertRace

public CE insertRace(int rep)
              throws HL7Exception

Inserts a repetition of NK1-35: "Race" 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)

insertNk135_Race

public CE insertNk135_Race(int rep)
                    throws HL7Exception

Inserts a repetition of NK1-35: "Race" 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)

removeRace

public CE removeRace(int rep)
              throws HL7Exception

Removes a repetition of NK1-35: "Race" 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)

removeNk135_Race

public CE removeNk135_Race(int rep)
                    throws HL7Exception

Removes a repetition of NK1-35: "Race" 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)

getHandicap

public IS getHandicap()

Returns NK1-36: "Handicap" - creates it if necessary

getNk136_Handicap

public IS getNk136_Handicap()

Returns NK1-36: "Handicap" - creates it if necessary

getContactPersonSocialSecurityNumber

public ST getContactPersonSocialSecurityNumber()

Returns NK1-37: "Contact Person Social Security Number" - creates it if necessary

getNk137_ContactPersonSocialSecurityNumber

public ST getNk137_ContactPersonSocialSecurityNumber()

Returns NK1-37: "Contact Person Social Security Number" - creates it if necessary

getNextOfKinBirthPlace

public ST getNextOfKinBirthPlace()

Returns NK1-38: "Next of Kin Birth Place" - creates it if necessary

getNk138_NextOfKinBirthPlace

public ST getNk138_NextOfKinBirthPlace()

Returns NK1-38: "Next of Kin Birth Place" - creates it if necessary

getVIPIndicator

public IS getVIPIndicator()

Returns NK1-39: "VIP Indicator" - creates it if necessary

getNk139_VIPIndicator

public IS getNk139_VIPIndicator()

Returns NK1-39: "VIP Indicator" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment