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

Class PID

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v251.segment.PID

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class PID
extends AbstractSegment

Represents an HL7 PID message segment (Patient Identification). This segment has the following fields:

• PID-1: Set ID - PID (SI) optional
• PID-2: Patient ID (CX) optional
• PID-3: Patient Identifier List (CX) repeating
• PID-4: Alternate Patient ID - PID (CX) optional repeating
• PID-5: Patient Name (XPN) repeating
• PID-6: Mother's Maiden Name (XPN) optional repeating
• PID-7: Date/Time of Birth (TS) optional
• PID-8: Administrative Sex (IS) optional
• PID-9: Patient Alias (XPN) optional repeating
• PID-10: Race (CE) optional repeating
• PID-11: Patient Address (XAD) optional repeating
• PID-12: County Code (IS) optional
• PID-13: Phone Number - Home (XTN) optional repeating
• PID-14: Phone Number - Business (XTN) optional repeating
• PID-15: Primary Language (CE) optional
• PID-16: Marital Status (CE) optional
• PID-17: Religion (CE) optional
• PID-18: Patient Account Number (CX) optional
• PID-19: SSN Number - Patient (ST) optional
• PID-20: Driver's License Number - Patient (DLN) optional
• PID-21: Mother's Identifier (CX) optional repeating
• PID-22: Ethnic Group (CE) optional repeating
• PID-23: Birth Place (ST) optional
• PID-24: Multiple Birth Indicator (ID) optional
• PID-25: Birth Order (NM) optional
• PID-26: Citizenship (CE) optional repeating
• PID-27: Veterans Military Status (CE) optional
• PID-28: Nationality (CE) optional
• PID-29: Patient Death Date and Time (TS) optional
• PID-30: Patient Death Indicator (ID) optional
• PID-31: Identity Unknown Indicator (ID) optional
• PID-32: Identity Reliability Code (IS) optional repeating
• PID-33: Last Update Date/Time (TS) optional
• PID-34: Last Update Facility (HD) optional
• PID-35: Species Code (CE) optional
• PID-36: Breed Code (CE) optional
• PID-37: Strain (ST) optional
• PID-38: Production Class Code (CE) optional
• PID-39: Tribal Citizenship (CWE) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Type	createNewTypeWithoutReflection(int field)
IS	getAdministrativeSex()	Returns PID-8: "Administrative Sex" - creates it if necessary
CX[]	getAlternatePatientIDPID()	Returns all repetitions of Alternate Patient ID - PID (PID-4).
CX	getAlternatePatientIDPID(int rep)	Returns a specific repetition of PID-4: "Alternate Patient ID - PID" - creates it if necessary
int	getAlternatePatientIDPIDReps()	Returns a count of the current number of repetitions of Alternate Patient ID - PID (PID-4).
NM	getBirthOrder()	Returns PID-25: "Birth Order" - creates it if necessary
ST	getBirthPlace()	Returns PID-23: "Birth Place" - creates it if necessary
CE	getBreedCode()	Returns PID-36: "Breed Code" - creates it if necessary
CE[]	getCitizenship()	Returns all repetitions of Citizenship (PID-26).
CE	getCitizenship(int rep)	Returns a specific repetition of PID-26: "Citizenship" - creates it if necessary
int	getCitizenshipReps()	Returns a count of the current number of repetitions of Citizenship (PID-26).
IS	getCountyCode()	Returns PID-12: "County Code" - creates it if necessary
TS	getDateTimeOfBirth()	Returns PID-7: "Date/Time of Birth" - creates it if necessary
DLN	getDriverSLicenseNumberPatient()	Returns PID-20: "Driver's License Number - Patient" - creates it if necessary
CE[]	getEthnicGroup()	Returns all repetitions of Ethnic Group (PID-22).
CE	getEthnicGroup(int rep)	Returns a specific repetition of PID-22: "Ethnic Group" - creates it if necessary
int	getEthnicGroupReps()	Returns a count of the current number of repetitions of Ethnic Group (PID-22).
IS[]	getIdentityReliabilityCode()	Returns all repetitions of Identity Reliability Code (PID-32).
IS	getIdentityReliabilityCode(int rep)	Returns a specific repetition of PID-32: "Identity Reliability Code" - creates it if necessary
int	getIdentityReliabilityCodeReps()	Returns a count of the current number of repetitions of Identity Reliability Code (PID-32).
ID	getIdentityUnknownIndicator()	Returns PID-31: "Identity Unknown Indicator" - creates it if necessary
TS	getLastUpdateDateTime()	Returns PID-33: "Last Update Date/Time" - creates it if necessary
HD	getLastUpdateFacility()	Returns PID-34: "Last Update Facility" - creates it if necessary
CE	getMaritalStatus()	Returns PID-16: "Marital Status" - creates it if necessary
CX[]	getMotherSIdentifier()	Returns all repetitions of Mother's Identifier (PID-21).
CX	getMotherSIdentifier(int rep)	Returns a specific repetition of PID-21: "Mother's Identifier" - creates it if necessary
int	getMotherSIdentifierReps()	Returns a count of the current number of repetitions of Mother's Identifier (PID-21).
XPN[]	getMotherSMaidenName()	Returns all repetitions of Mother's Maiden Name (PID-6).
XPN	getMotherSMaidenName(int rep)	Returns a specific repetition of PID-6: "Mother's Maiden Name" - creates it if necessary
int	getMotherSMaidenNameReps()	Returns a count of the current number of repetitions of Mother's Maiden Name (PID-6).
ID	getMultipleBirthIndicator()	Returns PID-24: "Multiple Birth Indicator" - creates it if necessary
CE	getNationality()	Returns PID-28: "Nationality" - creates it if necessary
CX	getPatientAccountNumber()	Returns PID-18: "Patient Account Number" - creates it if necessary
XAD[]	getPatientAddress()	Returns all repetitions of Patient Address (PID-11).
XAD	getPatientAddress(int rep)	Returns a specific repetition of PID-11: "Patient Address" - creates it if necessary
int	getPatientAddressReps()	Returns a count of the current number of repetitions of Patient Address (PID-11).
XPN[]	getPatientAlias()	Returns all repetitions of Patient Alias (PID-9).
XPN	getPatientAlias(int rep)	Returns a specific repetition of PID-9: "Patient Alias" - creates it if necessary
int	getPatientAliasReps()	Returns a count of the current number of repetitions of Patient Alias (PID-9).
TS	getPatientDeathDateAndTime()	Returns PID-29: "Patient Death Date and Time" - creates it if necessary
ID	getPatientDeathIndicator()	Returns PID-30: "Patient Death Indicator" - creates it if necessary
CX	getPatientID()	Returns PID-2: "Patient ID" - creates it if necessary
CX[]	getPatientIdentifierList()	Returns all repetitions of Patient Identifier List (PID-3).
CX	getPatientIdentifierList(int rep)	Returns a specific repetition of PID-3: "Patient Identifier List" - creates it if necessary
int	getPatientIdentifierListReps()	Returns a count of the current number of repetitions of Patient Identifier List (PID-3).
XPN[]	getPatientName()	Returns all repetitions of Patient Name (PID-5).
XPN	getPatientName(int rep)	Returns a specific repetition of PID-5: "Patient Name" - creates it if necessary
int	getPatientNameReps()	Returns a count of the current number of repetitions of Patient Name (PID-5).
XTN[]	getPhoneNumberBusiness()	Returns all repetitions of Phone Number - Business (PID-14).
XTN	getPhoneNumberBusiness(int rep)	Returns a specific repetition of PID-14: "Phone Number - Business" - creates it if necessary
int	getPhoneNumberBusinessReps()	Returns a count of the current number of repetitions of Phone Number - Business (PID-14).
XTN[]	getPhoneNumberHome()	Returns all repetitions of Phone Number - Home (PID-13).
XTN	getPhoneNumberHome(int rep)	Returns a specific repetition of PID-13: "Phone Number - Home" - creates it if necessary
int	getPhoneNumberHomeReps()	Returns a count of the current number of repetitions of Phone Number - Home (PID-13).
SI	getPid1_SetIDPID()	Returns PID-1: "Set ID - PID" - creates it if necessary
CE[]	getPid10_Race()	Returns all repetitions of Race (PID-10).
CE	getPid10_Race(int rep)	Returns a specific repetition of PID-10: "Race" - creates it if necessary
int	getPid10_RaceReps()	Returns a count of the current number of repetitions of Race (PID-10).
XAD[]	getPid11_PatientAddress()	Returns all repetitions of Patient Address (PID-11).
XAD	getPid11_PatientAddress(int rep)	Returns a specific repetition of PID-11: "Patient Address" - creates it if necessary
int	getPid11_PatientAddressReps()	Returns a count of the current number of repetitions of Patient Address (PID-11).
IS	getPid12_CountyCode()	Returns PID-12: "County Code" - creates it if necessary
XTN[]	getPid13_PhoneNumberHome()	Returns all repetitions of Phone Number - Home (PID-13).
XTN	getPid13_PhoneNumberHome(int rep)	Returns a specific repetition of PID-13: "Phone Number - Home" - creates it if necessary
int	getPid13_PhoneNumberHomeReps()	Returns a count of the current number of repetitions of Phone Number - Home (PID-13).
XTN[]	getPid14_PhoneNumberBusiness()	Returns all repetitions of Phone Number - Business (PID-14).
XTN	getPid14_PhoneNumberBusiness(int rep)	Returns a specific repetition of PID-14: "Phone Number - Business" - creates it if necessary
int	getPid14_PhoneNumberBusinessReps()	Returns a count of the current number of repetitions of Phone Number - Business (PID-14).
CE	getPid15_PrimaryLanguage()	Returns PID-15: "Primary Language" - creates it if necessary
CE	getPid16_MaritalStatus()	Returns PID-16: "Marital Status" - creates it if necessary
CE	getPid17_Religion()	Returns PID-17: "Religion" - creates it if necessary
CX	getPid18_PatientAccountNumber()	Returns PID-18: "Patient Account Number" - creates it if necessary
ST	getPid19_SSNNumberPatient()	Returns PID-19: "SSN Number - Patient" - creates it if necessary
CX	getPid2_PatientID()	Returns PID-2: "Patient ID" - creates it if necessary
DLN	getPid20_DriverSLicenseNumberPatient()	Returns PID-20: "Driver's License Number - Patient" - creates it if necessary
CX[]	getPid21_MotherSIdentifier()	Returns all repetitions of Mother's Identifier (PID-21).
CX	getPid21_MotherSIdentifier(int rep)	Returns a specific repetition of PID-21: "Mother's Identifier" - creates it if necessary
int	getPid21_MotherSIdentifierReps()	Returns a count of the current number of repetitions of Mother's Identifier (PID-21).
CE[]	getPid22_EthnicGroup()	Returns all repetitions of Ethnic Group (PID-22).
CE	getPid22_EthnicGroup(int rep)	Returns a specific repetition of PID-22: "Ethnic Group" - creates it if necessary
int	getPid22_EthnicGroupReps()	Returns a count of the current number of repetitions of Ethnic Group (PID-22).
ST	getPid23_BirthPlace()	Returns PID-23: "Birth Place" - creates it if necessary
ID	getPid24_MultipleBirthIndicator()	Returns PID-24: "Multiple Birth Indicator" - creates it if necessary
NM	getPid25_BirthOrder()	Returns PID-25: "Birth Order" - creates it if necessary
CE[]	getPid26_Citizenship()	Returns all repetitions of Citizenship (PID-26).
CE	getPid26_Citizenship(int rep)	Returns a specific repetition of PID-26: "Citizenship" - creates it if necessary
int	getPid26_CitizenshipReps()	Returns a count of the current number of repetitions of Citizenship (PID-26).
CE	getPid27_VeteransMilitaryStatus()	Returns PID-27: "Veterans Military Status" - creates it if necessary
CE	getPid28_Nationality()	Returns PID-28: "Nationality" - creates it if necessary
TS	getPid29_PatientDeathDateAndTime()	Returns PID-29: "Patient Death Date and Time" - creates it if necessary
CX[]	getPid3_PatientIdentifierList()	Returns all repetitions of Patient Identifier List (PID-3).
CX	getPid3_PatientIdentifierList(int rep)	Returns a specific repetition of PID-3: "Patient Identifier List" - creates it if necessary
int	getPid3_PatientIdentifierListReps()	Returns a count of the current number of repetitions of Patient Identifier List (PID-3).
ID	getPid30_PatientDeathIndicator()	Returns PID-30: "Patient Death Indicator" - creates it if necessary
ID	getPid31_IdentityUnknownIndicator()	Returns PID-31: "Identity Unknown Indicator" - creates it if necessary
IS[]	getPid32_IdentityReliabilityCode()	Returns all repetitions of Identity Reliability Code (PID-32).
IS	getPid32_IdentityReliabilityCode(int rep)	Returns a specific repetition of PID-32: "Identity Reliability Code" - creates it if necessary
int	getPid32_IdentityReliabilityCodeReps()	Returns a count of the current number of repetitions of Identity Reliability Code (PID-32).
TS	getPid33_LastUpdateDateTime()	Returns PID-33: "Last Update Date/Time" - creates it if necessary
HD	getPid34_LastUpdateFacility()	Returns PID-34: "Last Update Facility" - creates it if necessary
CE	getPid35_SpeciesCode()	Returns PID-35: "Species Code" - creates it if necessary
CE	getPid36_BreedCode()	Returns PID-36: "Breed Code" - creates it if necessary
ST	getPid37_Strain()	Returns PID-37: "Strain" - creates it if necessary
CE	getPid38_ProductionClassCode()	Returns PID-38: "Production Class Code" - creates it if necessary
CWE[]	getPid39_TribalCitizenship()	Returns all repetitions of Tribal Citizenship (PID-39).
CWE	getPid39_TribalCitizenship(int rep)	Returns a specific repetition of PID-39: "Tribal Citizenship" - creates it if necessary
int	getPid39_TribalCitizenshipReps()	Returns a count of the current number of repetitions of Tribal Citizenship (PID-39).
CX[]	getPid4_AlternatePatientIDPID()	Returns all repetitions of Alternate Patient ID - PID (PID-4).
CX	getPid4_AlternatePatientIDPID(int rep)	Returns a specific repetition of PID-4: "Alternate Patient ID - PID" - creates it if necessary
int	getPid4_AlternatePatientIDPIDReps()	Returns a count of the current number of repetitions of Alternate Patient ID - PID (PID-4).
XPN[]	getPid5_PatientName()	Returns all repetitions of Patient Name (PID-5).
XPN	getPid5_PatientName(int rep)	Returns a specific repetition of PID-5: "Patient Name" - creates it if necessary
int	getPid5_PatientNameReps()	Returns a count of the current number of repetitions of Patient Name (PID-5).
XPN[]	getPid6_MotherSMaidenName()	Returns all repetitions of Mother's Maiden Name (PID-6).
XPN	getPid6_MotherSMaidenName(int rep)	Returns a specific repetition of PID-6: "Mother's Maiden Name" - creates it if necessary
int	getPid6_MotherSMaidenNameReps()	Returns a count of the current number of repetitions of Mother's Maiden Name (PID-6).
TS	getPid7_DateTimeOfBirth()	Returns PID-7: "Date/Time of Birth" - creates it if necessary
IS	getPid8_AdministrativeSex()	Returns PID-8: "Administrative Sex" - creates it if necessary
XPN[]	getPid9_PatientAlias()	Returns all repetitions of Patient Alias (PID-9).
XPN	getPid9_PatientAlias(int rep)	Returns a specific repetition of PID-9: "Patient Alias" - creates it if necessary
int	getPid9_PatientAliasReps()	Returns a count of the current number of repetitions of Patient Alias (PID-9).
CE	getPrimaryLanguage()	Returns PID-15: "Primary Language" - creates it if necessary
CE	getProductionClassCode()	Returns PID-38: "Production Class Code" - creates it if necessary
CE[]	getRace()	Returns all repetitions of Race (PID-10).
CE	getRace(int rep)	Returns a specific repetition of PID-10: "Race" - creates it if necessary
int	getRaceReps()	Returns a count of the current number of repetitions of Race (PID-10).
CE	getReligion()	Returns PID-17: "Religion" - creates it if necessary
SI	getSetIDPID()	Returns PID-1: "Set ID - PID" - creates it if necessary
CE	getSpeciesCode()	Returns PID-35: "Species Code" - creates it if necessary
ST	getSSNNumberPatient()	Returns PID-19: "SSN Number - Patient" - creates it if necessary
ST	getStrain()	Returns PID-37: "Strain" - creates it if necessary
CWE[]	getTribalCitizenship()	Returns all repetitions of Tribal Citizenship (PID-39).
CWE	getTribalCitizenship(int rep)	Returns a specific repetition of PID-39: "Tribal Citizenship" - creates it if necessary
int	getTribalCitizenshipReps()	Returns a count of the current number of repetitions of Tribal Citizenship (PID-39).
CE	getVeteransMilitaryStatus()	Returns PID-27: "Veterans Military Status" - creates it if necessary
CX	insertAlternatePatientIDPID(int rep)	Inserts a repetition of PID-4: "Alternate Patient ID - PID" at a specific index
CE	insertCitizenship(int rep)	Inserts a repetition of PID-26: "Citizenship" at a specific index
CE	insertEthnicGroup(int rep)	Inserts a repetition of PID-22: "Ethnic Group" at a specific index
IS	insertIdentityReliabilityCode(int rep)	Inserts a repetition of PID-32: "Identity Reliability Code" at a specific index
CX	insertMotherSIdentifier(int rep)	Inserts a repetition of PID-21: "Mother's Identifier" at a specific index
XPN	insertMotherSMaidenName(int rep)	Inserts a repetition of PID-6: "Mother's Maiden Name" at a specific index
XAD	insertPatientAddress(int rep)	Inserts a repetition of PID-11: "Patient Address" at a specific index
XPN	insertPatientAlias(int rep)	Inserts a repetition of PID-9: "Patient Alias" at a specific index
CX	insertPatientIdentifierList(int rep)	Inserts a repetition of PID-3: "Patient Identifier List" at a specific index
XPN	insertPatientName(int rep)	Inserts a repetition of PID-5: "Patient Name" at a specific index
XTN	insertPhoneNumberBusiness(int rep)	Inserts a repetition of PID-14: "Phone Number - Business" at a specific index
XTN	insertPhoneNumberHome(int rep)	Inserts a repetition of PID-13: "Phone Number - Home" at a specific index
CE	insertPid10_Race(int rep)	Inserts a repetition of PID-10: "Race" at a specific index
XAD	insertPid11_PatientAddress(int rep)	Inserts a repetition of PID-11: "Patient Address" at a specific index
XTN	insertPid13_PhoneNumberHome(int rep)	Inserts a repetition of PID-13: "Phone Number - Home" at a specific index
XTN	insertPid14_PhoneNumberBusiness(int rep)	Inserts a repetition of PID-14: "Phone Number - Business" at a specific index
CX	insertPid21_MotherSIdentifier(int rep)	Inserts a repetition of PID-21: "Mother's Identifier" at a specific index
CE	insertPid22_EthnicGroup(int rep)	Inserts a repetition of PID-22: "Ethnic Group" at a specific index
CE	insertPid26_Citizenship(int rep)	Inserts a repetition of PID-26: "Citizenship" at a specific index
CX	insertPid3_PatientIdentifierList(int rep)	Inserts a repetition of PID-3: "Patient Identifier List" at a specific index
IS	insertPid32_IdentityReliabilityCode(int rep)	Inserts a repetition of PID-32: "Identity Reliability Code" at a specific index
CWE	insertPid39_TribalCitizenship(int rep)	Inserts a repetition of PID-39: "Tribal Citizenship" at a specific index
CX	insertPid4_AlternatePatientIDPID(int rep)	Inserts a repetition of PID-4: "Alternate Patient ID - PID" at a specific index
XPN	insertPid5_PatientName(int rep)	Inserts a repetition of PID-5: "Patient Name" at a specific index
XPN	insertPid6_MotherSMaidenName(int rep)	Inserts a repetition of PID-6: "Mother's Maiden Name" at a specific index
XPN	insertPid9_PatientAlias(int rep)	Inserts a repetition of PID-9: "Patient Alias" at a specific index
CE	insertRace(int rep)	Inserts a repetition of PID-10: "Race" at a specific index
CWE	insertTribalCitizenship(int rep)	Inserts a repetition of PID-39: "Tribal Citizenship" at a specific index
CX	removeAlternatePatientIDPID(int rep)	Removes a repetition of PID-4: "Alternate Patient ID - PID" at a specific index
CE	removeCitizenship(int rep)	Removes a repetition of PID-26: "Citizenship" at a specific index
CE	removeEthnicGroup(int rep)	Removes a repetition of PID-22: "Ethnic Group" at a specific index
IS	removeIdentityReliabilityCode(int rep)	Removes a repetition of PID-32: "Identity Reliability Code" at a specific index
CX	removeMotherSIdentifier(int rep)	Removes a repetition of PID-21: "Mother's Identifier" at a specific index
XPN	removeMotherSMaidenName(int rep)	Removes a repetition of PID-6: "Mother's Maiden Name" at a specific index
XAD	removePatientAddress(int rep)	Removes a repetition of PID-11: "Patient Address" at a specific index
XPN	removePatientAlias(int rep)	Removes a repetition of PID-9: "Patient Alias" at a specific index
CX	removePatientIdentifierList(int rep)	Removes a repetition of PID-3: "Patient Identifier List" at a specific index
XPN	removePatientName(int rep)	Removes a repetition of PID-5: "Patient Name" at a specific index
XTN	removePhoneNumberBusiness(int rep)	Removes a repetition of PID-14: "Phone Number - Business" at a specific index
XTN	removePhoneNumberHome(int rep)	Removes a repetition of PID-13: "Phone Number - Home" at a specific index
CE	removePid10_Race(int rep)	Removes a repetition of PID-10: "Race" at a specific index
XAD	removePid11_PatientAddress(int rep)	Removes a repetition of PID-11: "Patient Address" at a specific index
XTN	removePid13_PhoneNumberHome(int rep)	Removes a repetition of PID-13: "Phone Number - Home" at a specific index
XTN	removePid14_PhoneNumberBusiness(int rep)	Removes a repetition of PID-14: "Phone Number - Business" at a specific index
CX	removePid21_MotherSIdentifier(int rep)	Removes a repetition of PID-21: "Mother's Identifier" at a specific index
CE	removePid22_EthnicGroup(int rep)	Removes a repetition of PID-22: "Ethnic Group" at a specific index
CE	removePid26_Citizenship(int rep)	Removes a repetition of PID-26: "Citizenship" at a specific index
CX	removePid3_PatientIdentifierList(int rep)	Removes a repetition of PID-3: "Patient Identifier List" at a specific index
IS	removePid32_IdentityReliabilityCode(int rep)	Removes a repetition of PID-32: "Identity Reliability Code" at a specific index
CWE	removePid39_TribalCitizenship(int rep)	Removes a repetition of PID-39: "Tribal Citizenship" at a specific index
CX	removePid4_AlternatePatientIDPID(int rep)	Removes a repetition of PID-4: "Alternate Patient ID - PID" at a specific index
XPN	removePid5_PatientName(int rep)	Removes a repetition of PID-5: "Patient Name" at a specific index
XPN	removePid6_MotherSMaidenName(int rep)	Removes a repetition of PID-6: "Mother's Maiden Name" at a specific index
XPN	removePid9_PatientAlias(int rep)	Removes a repetition of PID-9: "Patient Alias" at a specific index
CE	removeRace(int rep)	Removes a repetition of PID-10: "Race" at a specific index
CWE	removeTribalCitizenship(int rep)	Removes a repetition of PID-39: "Tribal Citizenship" 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

PID

public PID(Group parent,
 ModelClassFactory factory)

Creates a new PID segment

Method Details

getSetIDPID

public SI getSetIDPID()

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

getPid1_SetIDPID

public SI getPid1_SetIDPID()

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

getPatientID

public CX getPatientID()

Returns PID-2: "Patient ID" - creates it if necessary

getPid2_PatientID

public CX getPid2_PatientID()

Returns PID-2: "Patient ID" - creates it if necessary

getPatientIdentifierList

public CX[] getPatientIdentifierList()

Returns all repetitions of Patient Identifier List (PID-3).

getPid3_PatientIdentifierList

public CX[] getPid3_PatientIdentifierList()

Returns all repetitions of Patient Identifier List (PID-3).

getPatientIdentifierListReps

public int getPatientIdentifierListReps()

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

getPatientIdentifierList

public CX getPatientIdentifierList(int rep)

Returns a specific repetition of PID-3: "Patient Identifier List" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid3_PatientIdentifierList

public CX getPid3_PatientIdentifierList(int rep)

Returns a specific repetition of PID-3: "Patient Identifier List" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid3_PatientIdentifierListReps

public int getPid3_PatientIdentifierListReps()

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

insertPatientIdentifierList

public CX insertPatientIdentifierList(int rep)
                               throws HL7Exception

Inserts a repetition of PID-3: "Patient Identifier List" 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)

insertPid3_PatientIdentifierList

public CX insertPid3_PatientIdentifierList(int rep)
                                    throws HL7Exception

Inserts a repetition of PID-3: "Patient Identifier List" 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)

removePatientIdentifierList

public CX removePatientIdentifierList(int rep)
                               throws HL7Exception

Removes a repetition of PID-3: "Patient Identifier List" 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)

removePid3_PatientIdentifierList

public CX removePid3_PatientIdentifierList(int rep)
                                    throws HL7Exception

Removes a repetition of PID-3: "Patient Identifier List" 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)

getAlternatePatientIDPID

public CX[] getAlternatePatientIDPID()

Returns all repetitions of Alternate Patient ID - PID (PID-4).

getPid4_AlternatePatientIDPID

public CX[] getPid4_AlternatePatientIDPID()

Returns all repetitions of Alternate Patient ID - PID (PID-4).

getAlternatePatientIDPIDReps

public int getAlternatePatientIDPIDReps()

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

getAlternatePatientIDPID

public CX getAlternatePatientIDPID(int rep)

Returns a specific repetition of PID-4: "Alternate Patient ID - PID" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid4_AlternatePatientIDPID

public CX getPid4_AlternatePatientIDPID(int rep)

Returns a specific repetition of PID-4: "Alternate Patient ID - PID" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid4_AlternatePatientIDPIDReps

public int getPid4_AlternatePatientIDPIDReps()

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

insertAlternatePatientIDPID

public CX insertAlternatePatientIDPID(int rep)
                               throws HL7Exception

Inserts a repetition of PID-4: "Alternate Patient ID - PID" 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)

insertPid4_AlternatePatientIDPID

public CX insertPid4_AlternatePatientIDPID(int rep)
                                    throws HL7Exception

Inserts a repetition of PID-4: "Alternate Patient ID - PID" 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)

removeAlternatePatientIDPID

public CX removeAlternatePatientIDPID(int rep)
                               throws HL7Exception

Removes a repetition of PID-4: "Alternate Patient ID - PID" 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)

removePid4_AlternatePatientIDPID

public CX removePid4_AlternatePatientIDPID(int rep)
                                    throws HL7Exception

Removes a repetition of PID-4: "Alternate Patient ID - PID" 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)

getPatientName

public XPN[] getPatientName()

Returns all repetitions of Patient Name (PID-5).

getPid5_PatientName

public XPN[] getPid5_PatientName()

Returns all repetitions of Patient Name (PID-5).

getPatientNameReps

public int getPatientNameReps()

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

getPatientName

public XPN getPatientName(int rep)

Returns a specific repetition of PID-5: "Patient Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid5_PatientName

public XPN getPid5_PatientName(int rep)

Returns a specific repetition of PID-5: "Patient Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid5_PatientNameReps

public int getPid5_PatientNameReps()

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

insertPatientName

public XPN insertPatientName(int rep)
                      throws HL7Exception

Inserts a repetition of PID-5: "Patient 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)

insertPid5_PatientName

public XPN insertPid5_PatientName(int rep)
                           throws HL7Exception

Inserts a repetition of PID-5: "Patient 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)

removePatientName

public XPN removePatientName(int rep)
                      throws HL7Exception

Removes a repetition of PID-5: "Patient 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)

removePid5_PatientName

public XPN removePid5_PatientName(int rep)
                           throws HL7Exception

Removes a repetition of PID-5: "Patient 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)

getMotherSMaidenName

public XPN[] getMotherSMaidenName()

Returns all repetitions of Mother's Maiden Name (PID-6).

getPid6_MotherSMaidenName

public XPN[] getPid6_MotherSMaidenName()

Returns all repetitions of Mother's Maiden Name (PID-6).

getMotherSMaidenNameReps

public int getMotherSMaidenNameReps()

Returns a count of the current number of repetitions of Mother's Maiden Name (PID-6). 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 PID-6: "Mother's Maiden Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid6_MotherSMaidenName

public XPN getPid6_MotherSMaidenName(int rep)

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

Parameters:

rep - The repetition index (0-indexed)

getPid6_MotherSMaidenNameReps

public int getPid6_MotherSMaidenNameReps()

Returns a count of the current number of repetitions of Mother's Maiden Name (PID-6). 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 PID-6: "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)

insertPid6_MotherSMaidenName

public XPN insertPid6_MotherSMaidenName(int rep)
                                 throws HL7Exception

Inserts a repetition of PID-6: "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 PID-6: "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)

removePid6_MotherSMaidenName

public XPN removePid6_MotherSMaidenName(int rep)
                                 throws HL7Exception

Removes a repetition of PID-6: "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)

getDateTimeOfBirth

public TS getDateTimeOfBirth()

Returns PID-7: "Date/Time of Birth" - creates it if necessary

getPid7_DateTimeOfBirth

public TS getPid7_DateTimeOfBirth()

Returns PID-7: "Date/Time of Birth" - creates it if necessary

getAdministrativeSex

public IS getAdministrativeSex()

Returns PID-8: "Administrative Sex" - creates it if necessary

getPid8_AdministrativeSex

public IS getPid8_AdministrativeSex()

Returns PID-8: "Administrative Sex" - creates it if necessary

getPatientAlias

public XPN[] getPatientAlias()

Returns all repetitions of Patient Alias (PID-9).

getPid9_PatientAlias

public XPN[] getPid9_PatientAlias()

Returns all repetitions of Patient Alias (PID-9).

getPatientAliasReps

public int getPatientAliasReps()

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

getPatientAlias

public XPN getPatientAlias(int rep)

Returns a specific repetition of PID-9: "Patient Alias" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid9_PatientAlias

public XPN getPid9_PatientAlias(int rep)

Returns a specific repetition of PID-9: "Patient Alias" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid9_PatientAliasReps

public int getPid9_PatientAliasReps()

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

insertPatientAlias

public XPN insertPatientAlias(int rep)
                       throws HL7Exception

Inserts a repetition of PID-9: "Patient Alias" 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)

insertPid9_PatientAlias

public XPN insertPid9_PatientAlias(int rep)
                            throws HL7Exception

Inserts a repetition of PID-9: "Patient Alias" 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)

removePatientAlias

public XPN removePatientAlias(int rep)
                       throws HL7Exception

Removes a repetition of PID-9: "Patient Alias" 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)

removePid9_PatientAlias

public XPN removePid9_PatientAlias(int rep)
                            throws HL7Exception

Removes a repetition of PID-9: "Patient Alias" 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)

getRace

public CE[] getRace()

Returns all repetitions of Race (PID-10).

getPid10_Race

public CE[] getPid10_Race()

Returns all repetitions of Race (PID-10).

getRaceReps

public int getRaceReps()

Returns a count of the current number of repetitions of Race (PID-10). 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 PID-10: "Race" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid10_Race

public CE getPid10_Race(int rep)

Returns a specific repetition of PID-10: "Race" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid10_RaceReps

public int getPid10_RaceReps()

Returns a count of the current number of repetitions of Race (PID-10). 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 PID-10: "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)

insertPid10_Race

public CE insertPid10_Race(int rep)
                    throws HL7Exception

Inserts a repetition of PID-10: "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 PID-10: "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)

removePid10_Race

public CE removePid10_Race(int rep)
                    throws HL7Exception

Removes a repetition of PID-10: "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)

getPatientAddress

public XAD[] getPatientAddress()

Returns all repetitions of Patient Address (PID-11).

getPid11_PatientAddress

public XAD[] getPid11_PatientAddress()

Returns all repetitions of Patient Address (PID-11).

getPatientAddressReps

public int getPatientAddressReps()

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

getPatientAddress

public XAD getPatientAddress(int rep)

Returns a specific repetition of PID-11: "Patient Address" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid11_PatientAddress

public XAD getPid11_PatientAddress(int rep)

Returns a specific repetition of PID-11: "Patient Address" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid11_PatientAddressReps

public int getPid11_PatientAddressReps()

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

insertPatientAddress

public XAD insertPatientAddress(int rep)
                         throws HL7Exception

Inserts a repetition of PID-11: "Patient 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)

insertPid11_PatientAddress

public XAD insertPid11_PatientAddress(int rep)
                               throws HL7Exception

Inserts a repetition of PID-11: "Patient 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)

removePatientAddress

public XAD removePatientAddress(int rep)
                         throws HL7Exception

Removes a repetition of PID-11: "Patient 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)

removePid11_PatientAddress

public XAD removePid11_PatientAddress(int rep)
                               throws HL7Exception

Removes a repetition of PID-11: "Patient 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)

getCountyCode

public IS getCountyCode()

Returns PID-12: "County Code" - creates it if necessary

getPid12_CountyCode

public IS getPid12_CountyCode()

Returns PID-12: "County Code" - creates it if necessary

getPhoneNumberHome

public XTN[] getPhoneNumberHome()

Returns all repetitions of Phone Number - Home (PID-13).

getPid13_PhoneNumberHome

public XTN[] getPid13_PhoneNumberHome()

Returns all repetitions of Phone Number - Home (PID-13).

getPhoneNumberHomeReps

public int getPhoneNumberHomeReps()

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

getPhoneNumberHome

public XTN getPhoneNumberHome(int rep)

Returns a specific repetition of PID-13: "Phone Number - Home" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid13_PhoneNumberHome

public XTN getPid13_PhoneNumberHome(int rep)

Returns a specific repetition of PID-13: "Phone Number - Home" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid13_PhoneNumberHomeReps

public int getPid13_PhoneNumberHomeReps()

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

insertPhoneNumberHome

public XTN insertPhoneNumberHome(int rep)
                          throws HL7Exception

Inserts a repetition of PID-13: "Phone Number - Home" 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)

insertPid13_PhoneNumberHome

public XTN insertPid13_PhoneNumberHome(int rep)
                                throws HL7Exception

Inserts a repetition of PID-13: "Phone Number - Home" 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)

removePhoneNumberHome

public XTN removePhoneNumberHome(int rep)
                          throws HL7Exception

Removes a repetition of PID-13: "Phone Number - Home" 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)

removePid13_PhoneNumberHome

public XTN removePid13_PhoneNumberHome(int rep)
                                throws HL7Exception

Removes a repetition of PID-13: "Phone Number - Home" 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)

getPhoneNumberBusiness

public XTN[] getPhoneNumberBusiness()

Returns all repetitions of Phone Number - Business (PID-14).

getPid14_PhoneNumberBusiness

public XTN[] getPid14_PhoneNumberBusiness()

Returns all repetitions of Phone Number - Business (PID-14).

getPhoneNumberBusinessReps

public int getPhoneNumberBusinessReps()

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

getPhoneNumberBusiness

public XTN getPhoneNumberBusiness(int rep)

Returns a specific repetition of PID-14: "Phone Number - Business" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid14_PhoneNumberBusiness

public XTN getPid14_PhoneNumberBusiness(int rep)

Returns a specific repetition of PID-14: "Phone Number - Business" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid14_PhoneNumberBusinessReps

public int getPid14_PhoneNumberBusinessReps()

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

insertPhoneNumberBusiness

public XTN insertPhoneNumberBusiness(int rep)
                              throws HL7Exception

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

insertPid14_PhoneNumberBusiness

public XTN insertPid14_PhoneNumberBusiness(int rep)
                                    throws HL7Exception

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

removePhoneNumberBusiness

public XTN removePhoneNumberBusiness(int rep)
                              throws HL7Exception

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

removePid14_PhoneNumberBusiness

public XTN removePid14_PhoneNumberBusiness(int rep)
                                    throws HL7Exception

Removes a repetition of PID-14: "Phone Number - Business" 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 PID-15: "Primary Language" - creates it if necessary

getPid15_PrimaryLanguage

public CE getPid15_PrimaryLanguage()

Returns PID-15: "Primary Language" - creates it if necessary

getMaritalStatus

public CE getMaritalStatus()

Returns PID-16: "Marital Status" - creates it if necessary

getPid16_MaritalStatus

public CE getPid16_MaritalStatus()

Returns PID-16: "Marital Status" - creates it if necessary

getReligion

public CE getReligion()

Returns PID-17: "Religion" - creates it if necessary

getPid17_Religion

public CE getPid17_Religion()

Returns PID-17: "Religion" - creates it if necessary

getPatientAccountNumber

public CX getPatientAccountNumber()

Returns PID-18: "Patient Account Number" - creates it if necessary

getPid18_PatientAccountNumber

public CX getPid18_PatientAccountNumber()

Returns PID-18: "Patient Account Number" - creates it if necessary

getSSNNumberPatient

public ST getSSNNumberPatient()

Returns PID-19: "SSN Number - Patient" - creates it if necessary

getPid19_SSNNumberPatient

public ST getPid19_SSNNumberPatient()

Returns PID-19: "SSN Number - Patient" - creates it if necessary

getDriverSLicenseNumberPatient

public DLN getDriverSLicenseNumberPatient()

Returns PID-20: "Driver's License Number - Patient" - creates it if necessary

getPid20_DriverSLicenseNumberPatient

public DLN getPid20_DriverSLicenseNumberPatient()

Returns PID-20: "Driver's License Number - Patient" - creates it if necessary

getMotherSIdentifier

public CX[] getMotherSIdentifier()

Returns all repetitions of Mother's Identifier (PID-21).

getPid21_MotherSIdentifier

public CX[] getPid21_MotherSIdentifier()

Returns all repetitions of Mother's Identifier (PID-21).

getMotherSIdentifierReps

public int getMotherSIdentifierReps()

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

getMotherSIdentifier

public CX getMotherSIdentifier(int rep)

Returns a specific repetition of PID-21: "Mother's Identifier" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid21_MotherSIdentifier

public CX getPid21_MotherSIdentifier(int rep)

Returns a specific repetition of PID-21: "Mother's Identifier" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid21_MotherSIdentifierReps

public int getPid21_MotherSIdentifierReps()

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

insertMotherSIdentifier

public CX insertMotherSIdentifier(int rep)
                           throws HL7Exception

Inserts a repetition of PID-21: "Mother's Identifier" 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)

insertPid21_MotherSIdentifier

public CX insertPid21_MotherSIdentifier(int rep)
                                 throws HL7Exception

Inserts a repetition of PID-21: "Mother's Identifier" 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)

removeMotherSIdentifier

public CX removeMotherSIdentifier(int rep)
                           throws HL7Exception

Removes a repetition of PID-21: "Mother's Identifier" 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)

removePid21_MotherSIdentifier

public CX removePid21_MotherSIdentifier(int rep)
                                 throws HL7Exception

Removes a repetition of PID-21: "Mother's Identifier" 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)

getEthnicGroup

public CE[] getEthnicGroup()

Returns all repetitions of Ethnic Group (PID-22).

getPid22_EthnicGroup

public CE[] getPid22_EthnicGroup()

Returns all repetitions of Ethnic Group (PID-22).

getEthnicGroupReps

public int getEthnicGroupReps()

Returns a count of the current number of repetitions of Ethnic Group (PID-22). 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 PID-22: "Ethnic Group" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid22_EthnicGroup

public CE getPid22_EthnicGroup(int rep)

Returns a specific repetition of PID-22: "Ethnic Group" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid22_EthnicGroupReps

public int getPid22_EthnicGroupReps()

Returns a count of the current number of repetitions of Ethnic Group (PID-22). 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 PID-22: "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)

insertPid22_EthnicGroup

public CE insertPid22_EthnicGroup(int rep)
                           throws HL7Exception

Inserts a repetition of PID-22: "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 PID-22: "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)

removePid22_EthnicGroup

public CE removePid22_EthnicGroup(int rep)
                           throws HL7Exception

Removes a repetition of PID-22: "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)

getBirthPlace

public ST getBirthPlace()

Returns PID-23: "Birth Place" - creates it if necessary

getPid23_BirthPlace

public ST getPid23_BirthPlace()

Returns PID-23: "Birth Place" - creates it if necessary

getMultipleBirthIndicator

public ID getMultipleBirthIndicator()

Returns PID-24: "Multiple Birth Indicator" - creates it if necessary

getPid24_MultipleBirthIndicator

public ID getPid24_MultipleBirthIndicator()

Returns PID-24: "Multiple Birth Indicator" - creates it if necessary

getBirthOrder

public NM getBirthOrder()

Returns PID-25: "Birth Order" - creates it if necessary

getPid25_BirthOrder

public NM getPid25_BirthOrder()

Returns PID-25: "Birth Order" - creates it if necessary

getCitizenship

public CE[] getCitizenship()

Returns all repetitions of Citizenship (PID-26).

getPid26_Citizenship

public CE[] getPid26_Citizenship()

Returns all repetitions of Citizenship (PID-26).

getCitizenshipReps

public int getCitizenshipReps()

Returns a count of the current number of repetitions of Citizenship (PID-26). 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 PID-26: "Citizenship" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid26_Citizenship

public CE getPid26_Citizenship(int rep)

Returns a specific repetition of PID-26: "Citizenship" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid26_CitizenshipReps

public int getPid26_CitizenshipReps()

Returns a count of the current number of repetitions of Citizenship (PID-26). 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 PID-26: "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)

insertPid26_Citizenship

public CE insertPid26_Citizenship(int rep)
                           throws HL7Exception

Inserts a repetition of PID-26: "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 PID-26: "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)

removePid26_Citizenship

public CE removePid26_Citizenship(int rep)
                           throws HL7Exception

Removes a repetition of PID-26: "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)

getVeteransMilitaryStatus

public CE getVeteransMilitaryStatus()

Returns PID-27: "Veterans Military Status" - creates it if necessary

getPid27_VeteransMilitaryStatus

public CE getPid27_VeteransMilitaryStatus()

Returns PID-27: "Veterans Military Status" - creates it if necessary

getNationality

public CE getNationality()

Returns PID-28: "Nationality" - creates it if necessary

getPid28_Nationality

public CE getPid28_Nationality()

Returns PID-28: "Nationality" - creates it if necessary

getPatientDeathDateAndTime

public TS getPatientDeathDateAndTime()

Returns PID-29: "Patient Death Date and Time" - creates it if necessary

getPid29_PatientDeathDateAndTime

public TS getPid29_PatientDeathDateAndTime()

Returns PID-29: "Patient Death Date and Time" - creates it if necessary

getPatientDeathIndicator

public ID getPatientDeathIndicator()

Returns PID-30: "Patient Death Indicator" - creates it if necessary

getPid30_PatientDeathIndicator

public ID getPid30_PatientDeathIndicator()

Returns PID-30: "Patient Death Indicator" - creates it if necessary

getIdentityUnknownIndicator

public ID getIdentityUnknownIndicator()

Returns PID-31: "Identity Unknown Indicator" - creates it if necessary

getPid31_IdentityUnknownIndicator

public ID getPid31_IdentityUnknownIndicator()

Returns PID-31: "Identity Unknown Indicator" - creates it if necessary

getIdentityReliabilityCode

public IS[] getIdentityReliabilityCode()

Returns all repetitions of Identity Reliability Code (PID-32).

getPid32_IdentityReliabilityCode

public IS[] getPid32_IdentityReliabilityCode()

Returns all repetitions of Identity Reliability Code (PID-32).

getIdentityReliabilityCodeReps

public int getIdentityReliabilityCodeReps()

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

getIdentityReliabilityCode

public IS getIdentityReliabilityCode(int rep)

Returns a specific repetition of PID-32: "Identity Reliability Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid32_IdentityReliabilityCode

public IS getPid32_IdentityReliabilityCode(int rep)

Returns a specific repetition of PID-32: "Identity Reliability Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid32_IdentityReliabilityCodeReps

public int getPid32_IdentityReliabilityCodeReps()

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

insertIdentityReliabilityCode

public IS insertIdentityReliabilityCode(int rep)
                                 throws HL7Exception

Inserts a repetition of PID-32: "Identity Reliability Code" 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)

insertPid32_IdentityReliabilityCode

public IS insertPid32_IdentityReliabilityCode(int rep)
                                       throws HL7Exception

Inserts a repetition of PID-32: "Identity Reliability Code" 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)

removeIdentityReliabilityCode

public IS removeIdentityReliabilityCode(int rep)
                                 throws HL7Exception

Removes a repetition of PID-32: "Identity Reliability Code" 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)

removePid32_IdentityReliabilityCode

public IS removePid32_IdentityReliabilityCode(int rep)
                                       throws HL7Exception

Removes a repetition of PID-32: "Identity Reliability Code" 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)

getLastUpdateDateTime

public TS getLastUpdateDateTime()

Returns PID-33: "Last Update Date/Time" - creates it if necessary

getPid33_LastUpdateDateTime

public TS getPid33_LastUpdateDateTime()

Returns PID-33: "Last Update Date/Time" - creates it if necessary

getLastUpdateFacility

public HD getLastUpdateFacility()

Returns PID-34: "Last Update Facility" - creates it if necessary

getPid34_LastUpdateFacility

public HD getPid34_LastUpdateFacility()

Returns PID-34: "Last Update Facility" - creates it if necessary

getSpeciesCode

public CE getSpeciesCode()

Returns PID-35: "Species Code" - creates it if necessary

getPid35_SpeciesCode

public CE getPid35_SpeciesCode()

Returns PID-35: "Species Code" - creates it if necessary

getBreedCode

public CE getBreedCode()

Returns PID-36: "Breed Code" - creates it if necessary

getPid36_BreedCode

public CE getPid36_BreedCode()

Returns PID-36: "Breed Code" - creates it if necessary

getStrain

public ST getStrain()

Returns PID-37: "Strain" - creates it if necessary

getPid37_Strain

public ST getPid37_Strain()

Returns PID-37: "Strain" - creates it if necessary

getProductionClassCode

public CE getProductionClassCode()

Returns PID-38: "Production Class Code" - creates it if necessary

getPid38_ProductionClassCode

public CE getPid38_ProductionClassCode()

Returns PID-38: "Production Class Code" - creates it if necessary

getTribalCitizenship

public CWE[] getTribalCitizenship()

Returns all repetitions of Tribal Citizenship (PID-39).

getPid39_TribalCitizenship

public CWE[] getPid39_TribalCitizenship()

Returns all repetitions of Tribal Citizenship (PID-39).

getTribalCitizenshipReps

public int getTribalCitizenshipReps()

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

getTribalCitizenship

public CWE getTribalCitizenship(int rep)

Returns a specific repetition of PID-39: "Tribal Citizenship" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid39_TribalCitizenship

public CWE getPid39_TribalCitizenship(int rep)

Returns a specific repetition of PID-39: "Tribal Citizenship" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPid39_TribalCitizenshipReps

public int getPid39_TribalCitizenshipReps()

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

insertTribalCitizenship

public CWE insertTribalCitizenship(int rep)
                            throws HL7Exception

Inserts a repetition of PID-39: "Tribal 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)

insertPid39_TribalCitizenship

public CWE insertPid39_TribalCitizenship(int rep)
                                  throws HL7Exception

Inserts a repetition of PID-39: "Tribal 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)

removeTribalCitizenship

public CWE removeTribalCitizenship(int rep)
                            throws HL7Exception

Removes a repetition of PID-39: "Tribal 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)

removePid39_TribalCitizenship

public CWE removePid39_TribalCitizenship(int rep)
                                  throws HL7Exception

Removes a repetition of PID-39: "Tribal 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)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment