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) |
ST |
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
|
ID[] |
getCitizenship()
Returns all repetitions of Citizenship (PID-26).
|
ID |
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).
|
ID |
getCountyCode()
Returns
PID-12: "County code" - creates it if necessary
|
TS |
getDateOfBirth()
Returns
PID-7: "Date of Birth" - creates it if necessary
|
CM_LICENSE_NO |
getDriverSLicenseNumberPatient()
Returns
PID-20: "Driver's license number - patient" - creates it if necessary
|
ID |
getEthnicGroup()
Returns
PID-22: "Ethnic Group" - creates it if necessary
|
ST |
getLanguagePatient()
Returns
PID-15: "Language - Patient" - creates it if necessary
|
ID |
getMaritalStatus()
Returns
PID-16: "Marital Status" - creates it if necessary
|
CK |
getMotherSIdentifier()
Returns
PID-21: "Mother's Identifier" - creates it if necessary
|
ST |
getMotherSMaidenName()
Returns
PID-6: "Mother's Maiden Name" - creates it if necessary
|
ID |
getMultipleBirthIndicator()
Returns
PID-24: "Multiple Birth Indicator" - creates it if necessary
|
CK |
getPatientAccountNumber()
Returns
PID-18: "Patient Account Number" - creates it if necessary
|
AD[] |
getPatientAddress()
Returns all repetitions of Patient Address (PID-11).
|
AD |
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).
|
PN[] |
getPatientAlias()
Returns all repetitions of Patient Alias (PID-9).
|
PN |
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).
|
CK |
getPatientIDExternalID()
Returns
PID-2: "Patient ID (External ID)" - creates it if necessary
|
CM_PAT_ID[] |
getPatientIDInternalID()
Returns all repetitions of Patient ID (Internal ID) (PID-3).
|
CM_PAT_ID |
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).
|
PN |
getPatientName()
Returns
PID-5: "Patient Name" - creates it if necessary
|
TN[] |
getPhoneNumberBusiness()
Returns all repetitions of Phone Number - Business (PID-14).
|
TN |
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).
|
TN[] |
getPhoneNumberHome()
Returns all repetitions of Phone Number - Home (PID-13).
|
TN |
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
|
ID |
getPid10_Race()
Returns
PID-10: "Race" - creates it if necessary
|
AD[] |
getPid11_PatientAddress()
Returns all repetitions of Patient Address (PID-11).
|
AD |
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).
|
ID |
getPid12_CountyCode()
Returns
PID-12: "County code" - creates it if necessary
|
TN[] |
getPid13_PhoneNumberHome()
Returns all repetitions of Phone Number - Home (PID-13).
|
TN |
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).
|
TN[] |
getPid14_PhoneNumberBusiness()
Returns all repetitions of Phone Number - Business (PID-14).
|
TN |
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).
|
ST |
getPid15_LanguagePatient()
Returns
PID-15: "Language - Patient" - creates it if necessary
|
ID |
getPid16_MaritalStatus()
Returns
PID-16: "Marital Status" - creates it if necessary
|
ID |
getPid17_Religion()
Returns
PID-17: "Religion" - creates it if necessary
|
CK |
getPid18_PatientAccountNumber()
Returns
PID-18: "Patient Account Number" - creates it if necessary
|
ST |
getPid19_SocialSecurityNumberPatient()
Returns
PID-19: "Social security number - patient" - creates it if necessary
|
CK |
getPid2_PatientIDExternalID()
Returns
PID-2: "Patient ID (External ID)" - creates it if necessary
|
CM_LICENSE_NO |
getPid20_DriverSLicenseNumberPatient()
Returns
PID-20: "Driver's license number - patient" - creates it if necessary
|
CK |
getPid21_MotherSIdentifier()
Returns
PID-21: "Mother's Identifier" - creates it if necessary
|
ID |
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
|
ID[] |
getPid26_Citizenship()
Returns all repetitions of Citizenship (PID-26).
|
ID |
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).
|
ST |
getPid27_VeteransMilitaryStatus()
Returns
PID-27: "Veterans Military Status" - creates it if necessary
|
CM_PAT_ID[] |
getPid3_PatientIDInternalID()
Returns all repetitions of Patient ID (Internal ID) (PID-3).
|
CM_PAT_ID |
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).
|
ST |
getPid4_AlternatePatientID()
Returns
PID-4: "Alternate Patient ID" - creates it if necessary
|
PN |
getPid5_PatientName()
Returns
PID-5: "Patient Name" - creates it if necessary
|
ST |
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
|
ID |
getPid8_Sex()
Returns
PID-8: "Sex" - creates it if necessary
|
PN[] |
getPid9_PatientAlias()
Returns all repetitions of Patient Alias (PID-9).
|
PN |
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).
|
ID |
getRace()
Returns
PID-10: "Race" - creates it if necessary
|
ID |
getReligion()
Returns
PID-17: "Religion" - creates it if necessary
|
SI |
getSetIDPatientID()
Returns
PID-1: "Set ID - Patient ID" - creates it if necessary
|
ID |
getSex()
Returns
PID-8: "Sex" - creates it if necessary
|
ST |
getSocialSecurityNumberPatient()
Returns
PID-19: "Social security number - patient" - creates it if necessary
|
ST |
getVeteransMilitaryStatus()
Returns
PID-27: "Veterans Military Status" - creates it if necessary
|
ID |
insertCitizenship(int rep)
Inserts a repetition of
PID-26: "Citizenship" at a specific index
|
AD |
insertPatientAddress(int rep)
Inserts a repetition of
PID-11: "Patient Address" at a specific index
|
PN |
insertPatientAlias(int rep)
Inserts a repetition of
PID-9: "Patient Alias" at a specific index
|
CM_PAT_ID |
insertPatientIDInternalID(int rep)
Inserts a repetition of
PID-3: "Patient ID (Internal ID)" at a specific index
|
TN |
insertPhoneNumberBusiness(int rep)
Inserts a repetition of
PID-14: "Phone Number - Business" at a specific index
|
TN |
insertPhoneNumberHome(int rep)
Inserts a repetition of
PID-13: "Phone Number - Home" at a specific index
|
AD |
insertPid11_PatientAddress(int rep)
Inserts a repetition of
PID-11: "Patient Address" at a specific index
|
TN |
insertPid13_PhoneNumberHome(int rep)
Inserts a repetition of
PID-13: "Phone Number - Home" at a specific index
|
TN |
insertPid14_PhoneNumberBusiness(int rep)
Inserts a repetition of
PID-14: "Phone Number - Business" at a specific index
|
ID |
insertPid26_Citizenship(int rep)
Inserts a repetition of
PID-26: "Citizenship" at a specific index
|
CM_PAT_ID |
insertPid3_PatientIDInternalID(int rep)
Inserts a repetition of
PID-3: "Patient ID (Internal ID)" at a specific index
|
PN |
insertPid9_PatientAlias(int rep)
Inserts a repetition of
PID-9: "Patient Alias" at a specific index
|
ID |
removeCitizenship(int rep)
Removes a repetition of
PID-26: "Citizenship" at a specific index
|
AD |
removePatientAddress(int rep)
Removes a repetition of
PID-11: "Patient Address" at a specific index
|
PN |
removePatientAlias(int rep)
Removes a repetition of
PID-9: "Patient Alias" at a specific index
|
CM_PAT_ID |
removePatientIDInternalID(int rep)
Removes a repetition of
PID-3: "Patient ID (Internal ID)" at a specific index
|
TN |
removePhoneNumberBusiness(int rep)
Removes a repetition of
PID-14: "Phone Number - Business" at a specific index
|
TN |
removePhoneNumberHome(int rep)
Removes a repetition of
PID-13: "Phone Number - Home" at a specific index
|
AD |
removePid11_PatientAddress(int rep)
Removes a repetition of
PID-11: "Patient Address" at a specific index
|
TN |
removePid13_PhoneNumberHome(int rep)
Removes a repetition of
PID-13: "Phone Number - Home" at a specific index
|
TN |
removePid14_PhoneNumberBusiness(int rep)
Removes a repetition of
PID-14: "Phone Number - Business" at a specific index
|
ID |
removePid26_Citizenship(int rep)
Removes a repetition of
PID-26: "Citizenship" at a specific index
|
CM_PAT_ID |
removePid3_PatientIDInternalID(int rep)
Removes a repetition of
PID-3: "Patient ID (Internal ID)" at a specific index
|
PN |
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 CK getPatientIDExternalID()
public CK getPid2_PatientIDExternalID()
public CM_PAT_ID[] getPatientIDInternalID()
public CM_PAT_ID[] getPid3_PatientIDInternalID()
public int getPatientIDInternalIDReps()
public CM_PAT_ID getPatientIDInternalID(int rep)
rep
- The repetition index (0-indexed)public CM_PAT_ID getPid3_PatientIDInternalID(int rep)
rep
- The repetition index (0-indexed)public int getPid3_PatientIDInternalIDReps()
public CM_PAT_ID 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 CM_PAT_ID 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 CM_PAT_ID 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 CM_PAT_ID 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 ST getAlternatePatientID()
public ST getPid4_AlternatePatientID()
public PN getPatientName()
public PN getPid5_PatientName()
public ST getMotherSMaidenName()
public ST getPid6_MotherSMaidenName()
public TS getDateOfBirth()
public TS getPid7_DateOfBirth()
public ID getPid8_Sex()
public PN[] getPatientAlias()
public PN[] getPid9_PatientAlias()
public int getPatientAliasReps()
public PN getPatientAlias(int rep)
rep
- The repetition index (0-indexed)public PN getPid9_PatientAlias(int rep)
rep
- The repetition index (0-indexed)public int getPid9_PatientAliasReps()
public PN 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 PN 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 PN 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 PN 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 ID getPid10_Race()
public AD[] getPatientAddress()
public AD[] getPid11_PatientAddress()
public int getPatientAddressReps()
public AD getPatientAddress(int rep)
rep
- The repetition index (0-indexed)public AD getPid11_PatientAddress(int rep)
rep
- The repetition index (0-indexed)public int getPid11_PatientAddressReps()
public AD 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 AD 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 AD 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 AD 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 ID getCountyCode()
public ID getPid12_CountyCode()
public TN[] getPhoneNumberHome()
public TN[] getPid13_PhoneNumberHome()
public int getPhoneNumberHomeReps()
public TN getPhoneNumberHome(int rep)
rep
- The repetition index (0-indexed)public TN getPid13_PhoneNumberHome(int rep)
rep
- The repetition index (0-indexed)public int getPid13_PhoneNumberHomeReps()
public TN 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 TN 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 TN 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 TN 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 TN[] getPhoneNumberBusiness()
public TN[] getPid14_PhoneNumberBusiness()
public int getPhoneNumberBusinessReps()
public TN getPhoneNumberBusiness(int rep)
rep
- The repetition index (0-indexed)public TN getPid14_PhoneNumberBusiness(int rep)
rep
- The repetition index (0-indexed)public int getPid14_PhoneNumberBusinessReps()
public TN 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 TN 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 TN 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 TN 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 ST getLanguagePatient()
public ST getPid15_LanguagePatient()
public ID getMaritalStatus()
public ID getPid16_MaritalStatus()
public ID getReligion()
public ID getPid17_Religion()
public CK getPatientAccountNumber()
public CK getPid18_PatientAccountNumber()
public ST getSocialSecurityNumberPatient()
public ST getPid19_SocialSecurityNumberPatient()
public CM_LICENSE_NO getDriverSLicenseNumberPatient()
public CM_LICENSE_NO getPid20_DriverSLicenseNumberPatient()
public CK getMotherSIdentifier()
public CK getPid21_MotherSIdentifier()
public ID getEthnicGroup()
public ID getPid22_EthnicGroup()
public ST getBirthPlace()
public ST getPid23_BirthPlace()
public ID getMultipleBirthIndicator()
public ID getPid24_MultipleBirthIndicator()
public NM getBirthOrder()
public NM getPid25_BirthOrder()
public ID[] getCitizenship()
public ID[] getPid26_Citizenship()
public int getCitizenshipReps()
public ID getCitizenship(int rep)
rep
- The repetition index (0-indexed)public ID getPid26_Citizenship(int rep)
rep
- The repetition index (0-indexed)public int getPid26_CitizenshipReps()
public ID insertCitizenship(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 ID insertPid26_Citizenship(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 ID removeCitizenship(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 ID removePid26_Citizenship(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 ST getVeteransMilitaryStatus()
public ST getPid27_VeteransMilitaryStatus()
protected Type createNewTypeWithoutReflection(int field)
createNewTypeWithoutReflection
in class AbstractSegment
Copyright © 2001–2017 University Health Network. All rights reserved.