public class PID extends AbstractSegment
Represents an HL7 PID message segment (Patient Identification). This segment has the following fields:
log
Constructor and Description |
---|
PID(Group parent,
ModelClassFactory factory)
Creates a new PID segment
|
Modifier and Type | Method and Description |
---|---|
protected Type |
createNewTypeWithoutReflection(int field) |
CX |
getAlternatePatientID()
Returns
PID-4: "Alternate Patient ID" - creates it if necessary
|
NM |
getBirthOrder()
Returns
PID-25: "Birth Order" - creates it if necessary
|
ST |
getBirthPlace()
Returns
PID-23: "Birth Place" - creates it if necessary
|
IS |
getCitizenship()
Returns
PID-26: "Citizenship" - creates it if necessary
|
IS |
getCountyCode()
Returns
PID-12: "County Code" - creates it if necessary
|
TS |
getDateOfBirth()
Returns
PID-7: "Date of Birth" - creates it if necessary
|
DLN |
getDriverSLicenseNumber()
Returns
PID-20: "Driver's License Number" - creates it if necessary
|
IS |
getEthnicGroup()
Returns
PID-22: "Ethnic Group" - creates it if necessary
|
IS[] |
getMaritalStatus()
Returns all repetitions of Marital Status (PID-16).
|
IS |
getMaritalStatus(int rep)
Returns a specific repetition of
PID-16: "Marital Status" - creates it if necessary
|
int |
getMaritalStatusReps()
Returns a count of the current number of repetitions of Marital Status (PID-16).
|
CX |
getMotherSIdentifier()
Returns
PID-21: "Mother's Identifier" - creates it if necessary
|
XPN |
getMotherSMaidenName()
Returns
PID-6: "Mother's Maiden Name" - creates it if necessary
|
ID |
getMultipleBirthIndicator()
Returns
PID-24: "Multiple Birth Indicator" - creates it if necessary
|
CE |
getNationalityCode()
Returns
PID-28: "Nationality Code" - 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 |
getPatientIDExternalID()
Returns
PID-2: "Patient ID (External ID)" - creates it if necessary
|
CX[] |
getPatientIDInternalID()
Returns all repetitions of Patient ID (Internal ID) (PID-3).
|
CX |
getPatientIDInternalID(int rep)
Returns a specific repetition of
PID-3: "Patient ID (Internal ID)" - creates it if necessary
|
int |
getPatientIDInternalIDReps()
Returns a count of the current number of repetitions of Patient ID (Internal ID) (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_SetIDPatientID()
Returns
PID-1: "Set ID - Patient ID" - creates it if necessary
|
IS |
getPid10_Race()
Returns
PID-10: "Race" - creates it if necessary
|
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
|
IS[] |
getPid16_MaritalStatus()
Returns all repetitions of Marital Status (PID-16).
|
IS |
getPid16_MaritalStatus(int rep)
Returns a specific repetition of
PID-16: "Marital Status" - creates it if necessary
|
int |
getPid16_MaritalStatusReps()
Returns a count of the current number of repetitions of Marital Status (PID-16).
|
IS |
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_PatientIDExternalID()
Returns
PID-2: "Patient ID (External ID)" - creates it if necessary
|
DLN |
getPid20_DriverSLicenseNumber()
Returns
PID-20: "Driver's License Number" - creates it if necessary
|
CX |
getPid21_MotherSIdentifier()
Returns
PID-21: "Mother's Identifier" - creates it if necessary
|
IS |
getPid22_EthnicGroup()
Returns
PID-22: "Ethnic Group" - creates it if necessary
|
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
|
IS |
getPid26_Citizenship()
Returns
PID-26: "Citizenship" - creates it if necessary
|
CE |
getPid27_VeteransMilitaryStatus()
Returns
PID-27: "Veterans Military Status" - creates it if necessary
|
CE |
getPid28_NationalityCode()
Returns
PID-28: "Nationality Code" - creates it if necessary
|
TS |
getPid29_PatientDeathDateAndTime()
Returns
PID-29: "Patient Death Date and Time" - creates it if necessary
|
CX[] |
getPid3_PatientIDInternalID()
Returns all repetitions of Patient ID (Internal ID) (PID-3).
|
CX |
getPid3_PatientIDInternalID(int rep)
Returns a specific repetition of
PID-3: "Patient ID (Internal ID)" - creates it if necessary
|
int |
getPid3_PatientIDInternalIDReps()
Returns a count of the current number of repetitions of Patient ID (Internal ID) (PID-3).
|
ID |
getPid30_PatientDeathIndicator()
Returns
PID-30: "Patient Death Indicator" - creates it if necessary
|
CX |
getPid4_AlternatePatientID()
Returns
PID-4: "Alternate Patient ID" - creates it if necessary
|
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
PID-6: "Mother's Maiden Name" - creates it if necessary
|
TS |
getPid7_DateOfBirth()
Returns
PID-7: "Date of Birth" - creates it if necessary
|
IS |
getPid8_Sex()
Returns
PID-8: "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
|
IS |
getRace()
Returns
PID-10: "Race" - creates it if necessary
|
IS |
getReligion()
Returns
PID-17: "Religion" - creates it if necessary
|
SI |
getSetIDPatientID()
Returns
PID-1: "Set ID - Patient ID" - creates it if necessary
|
IS |
getSex()
Returns
PID-8: "Sex" - creates it if necessary
|
ST |
getSSNNumberPatient()
Returns
PID-19: "SSN Number - Patient" - creates it if necessary
|
CE |
getVeteransMilitaryStatus()
Returns
PID-27: "Veterans Military Status" - creates it if necessary
|
IS |
insertMaritalStatus(int rep)
Inserts a repetition of
PID-16: "Marital Status" 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 |
insertPatientIDInternalID(int rep)
Inserts a repetition of
PID-3: "Patient ID (Internal ID)" 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
|
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
|
IS |
insertPid16_MaritalStatus(int rep)
Inserts a repetition of
PID-16: "Marital Status" at a specific index
|
CX |
insertPid3_PatientIDInternalID(int rep)
Inserts a repetition of
PID-3: "Patient ID (Internal ID)" at a specific index
|
XPN |
insertPid5_PatientName(int rep)
Inserts a repetition of
PID-5: "Patient Name" at a specific index
|
XPN |
insertPid9_PatientAlias(int rep)
Inserts a repetition of
PID-9: "Patient Alias" at a specific index
|
IS |
removeMaritalStatus(int rep)
Removes a repetition of
PID-16: "Marital Status" 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 |
removePatientIDInternalID(int rep)
Removes a repetition of
PID-3: "Patient ID (Internal ID)" 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
|
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
|
IS |
removePid16_MaritalStatus(int rep)
Removes a repetition of
PID-16: "Marital Status" at a specific index
|
CX |
removePid3_PatientIDInternalID(int rep)
Removes a repetition of
PID-3: "Patient ID (Internal ID)" at a specific index
|
XPN |
removePid5_PatientName(int rep)
Removes a repetition of
PID-5: "Patient Name" at a specific index
|
XPN |
removePid9_PatientAlias(int rep)
Removes a repetition of
PID-9: "Patient Alias" at a specific index
|
accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition
getMessage, getParent
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMessage, getParent
public PID(Group parent, ModelClassFactory factory)
public SI getSetIDPatientID()
public SI getPid1_SetIDPatientID()
public CX getPatientIDExternalID()
public CX getPid2_PatientIDExternalID()
public CX[] getPatientIDInternalID()
public CX[] getPid3_PatientIDInternalID()
public int getPatientIDInternalIDReps()
public CX getPatientIDInternalID(int rep)
rep
- The repetition index (0-indexed)public CX getPid3_PatientIDInternalID(int rep)
rep
- The repetition index (0-indexed)public int getPid3_PatientIDInternalIDReps()
public CX insertPatientIDInternalID(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public CX insertPid3_PatientIDInternalID(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public CX removePatientIDInternalID(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public CX removePid3_PatientIDInternalID(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public CX getAlternatePatientID()
public CX getPid4_AlternatePatientID()
public XPN[] getPatientName()
public XPN[] getPid5_PatientName()
public int getPatientNameReps()
public XPN getPatientName(int rep)
rep
- The repetition index (0-indexed)public XPN getPid5_PatientName(int rep)
rep
- The repetition index (0-indexed)public int getPid5_PatientNameReps()
public XPN insertPatientName(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XPN insertPid5_PatientName(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XPN removePatientName(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XPN removePid5_PatientName(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XPN getMotherSMaidenName()
public XPN getPid6_MotherSMaidenName()
public TS getDateOfBirth()
public TS getPid7_DateOfBirth()
public IS getPid8_Sex()
public XPN[] getPatientAlias()
public XPN[] getPid9_PatientAlias()
public int getPatientAliasReps()
public XPN getPatientAlias(int rep)
rep
- The repetition index (0-indexed)public XPN getPid9_PatientAlias(int rep)
rep
- The repetition index (0-indexed)public int getPid9_PatientAliasReps()
public XPN insertPatientAlias(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XPN insertPid9_PatientAlias(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XPN removePatientAlias(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XPN removePid9_PatientAlias(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public IS getPid10_Race()
public XAD[] getPatientAddress()
public XAD[] getPid11_PatientAddress()
public int getPatientAddressReps()
public XAD getPatientAddress(int rep)
rep
- The repetition index (0-indexed)public XAD getPid11_PatientAddress(int rep)
rep
- The repetition index (0-indexed)public int getPid11_PatientAddressReps()
public XAD insertPatientAddress(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XAD insertPid11_PatientAddress(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XAD removePatientAddress(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XAD removePid11_PatientAddress(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public IS getCountyCode()
public IS getPid12_CountyCode()
public XTN[] getPhoneNumberHome()
public XTN[] getPid13_PhoneNumberHome()
public int getPhoneNumberHomeReps()
public XTN getPhoneNumberHome(int rep)
rep
- The repetition index (0-indexed)public XTN getPid13_PhoneNumberHome(int rep)
rep
- The repetition index (0-indexed)public int getPid13_PhoneNumberHomeReps()
public XTN insertPhoneNumberHome(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XTN insertPid13_PhoneNumberHome(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XTN removePhoneNumberHome(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XTN removePid13_PhoneNumberHome(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XTN[] getPhoneNumberBusiness()
public XTN[] getPid14_PhoneNumberBusiness()
public int getPhoneNumberBusinessReps()
public XTN getPhoneNumberBusiness(int rep)
rep
- The repetition index (0-indexed)public XTN getPid14_PhoneNumberBusiness(int rep)
rep
- The repetition index (0-indexed)public int getPid14_PhoneNumberBusinessReps()
public XTN insertPhoneNumberBusiness(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XTN insertPid14_PhoneNumberBusiness(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XTN removePhoneNumberBusiness(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public XTN removePid14_PhoneNumberBusiness(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public CE getPrimaryLanguage()
public CE getPid15_PrimaryLanguage()
public IS[] getMaritalStatus()
public IS[] getPid16_MaritalStatus()
public int getMaritalStatusReps()
public IS getMaritalStatus(int rep)
rep
- The repetition index (0-indexed)public IS getPid16_MaritalStatus(int rep)
rep
- The repetition index (0-indexed)public int getPid16_MaritalStatusReps()
public IS insertMaritalStatus(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public IS insertPid16_MaritalStatus(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public IS removeMaritalStatus(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public IS removePid16_MaritalStatus(int rep) throws HL7Exception
rep
- The repetition index (0-indexed)HL7Exception
- If the rep is invalid (below 0, or too high for the allowable repetitions)public IS getReligion()
public IS getPid17_Religion()
public CX getPatientAccountNumber()
public CX getPid18_PatientAccountNumber()
public ST getSSNNumberPatient()
public ST getPid19_SSNNumberPatient()
public DLN getDriverSLicenseNumber()
public DLN getPid20_DriverSLicenseNumber()
public CX getMotherSIdentifier()
public CX getPid21_MotherSIdentifier()
public IS getEthnicGroup()
public IS getPid22_EthnicGroup()
public ST getBirthPlace()
public ST getPid23_BirthPlace()
public ID getMultipleBirthIndicator()
public ID getPid24_MultipleBirthIndicator()
public NM getBirthOrder()
public NM getPid25_BirthOrder()
public IS getCitizenship()
public IS getPid26_Citizenship()
public CE getVeteransMilitaryStatus()
public CE getPid27_VeteransMilitaryStatus()
public CE getNationalityCode()
public CE getPid28_NationalityCode()
public TS getPatientDeathDateAndTime()
public TS getPid29_PatientDeathDateAndTime()
public ID getPatientDeathIndicator()
public ID getPid30_PatientDeathIndicator()
protected Type createNewTypeWithoutReflection(int field)
createNewTypeWithoutReflection
in class AbstractSegment
Copyright © 2001–2017 University Health Network. All rights reserved.