ca.uhn.hl7v2.model.v231.segment
Class PD1

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v231.segment.PD1

All Implemented Interfaces:

Segment, Structure, Serializable

public class PD1
extends AbstractSegment

Represents an HL7 PD1 message segment (PD1 - patient additional demographic segment). This segment has the following fields:

• PD1-1: Living Dependency (IS) optional repeating
• PD1-2: Living Arrangement (IS) optional
• PD1-3: Patient Primary Facility (XON) optional repeating
• PD1-4: Patient Primary Care Provider Name & ID No. (XCN) optional repeating
• PD1-5: Student Indicator (IS) optional
• PD1-6: Handicap (IS) optional
• PD1-7: Living Will (IS) optional
• PD1-8: Organ Donor (IS) optional
• PD1-9: Separate Bill (ID) optional
• PD1-10: Duplicate Patient (CX) optional repeating
• PD1-11: Publicity Code (CE) optional
• PD1-12: Protection Indicator (ID) optional

See Also:

Serialized Form

Constructor Summary

PD1(Group parent, ModelClassFactory factory)
Creates a new PD1 segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
CX[]	getDuplicatePatient() Returns all repetitions of Duplicate Patient (PD1-10).
CX	getDuplicatePatient(int rep) Returns a specific repetition of PD1-10: "Duplicate Patient" - creates it if necessary
int	getDuplicatePatientReps() Returns a count of the current number of repetitions of Duplicate Patient (PD1-10).
IS	getHandicap() Returns PD1-6: "Handicap" - creates it if necessary
IS	getLivingArrangement() Returns PD1-2: "Living Arrangement" - creates it if necessary
IS[]	getLivingDependency() Returns all repetitions of Living Dependency (PD1-1).
IS	getLivingDependency(int rep) Returns a specific repetition of PD1-1: "Living Dependency" - creates it if necessary
int	getLivingDependencyReps() Returns a count of the current number of repetitions of Living Dependency (PD1-1).
IS	getLivingWill() Returns PD1-7: "Living Will" - creates it if necessary
IS	getOrganDonor() Returns PD1-8: "Organ Donor" - creates it if necessary
XCN[]	getPatientPrimaryCareProviderNameIDNo() Returns all repetitions of Patient Primary Care Provider Name & ID No.
XCN	getPatientPrimaryCareProviderNameIDNo(int rep) Returns a specific repetition of PD1-4: "Patient Primary Care Provider Name & ID No." - creates it if necessary
int	getPatientPrimaryCareProviderNameIDNoReps() Returns a count of the current number of repetitions of Patient Primary Care Provider Name & ID No.
XON[]	getPatientPrimaryFacility() Returns all repetitions of Patient Primary Facility (PD1-3).
XON	getPatientPrimaryFacility(int rep) Returns a specific repetition of PD1-3: "Patient Primary Facility" - creates it if necessary
int	getPatientPrimaryFacilityReps() Returns a count of the current number of repetitions of Patient Primary Facility (PD1-3).
IS	getPd11_LivingDependency(int rep) Returns a specific repetition of PD1-1: "Living Dependency" - creates it if necessary
int	getPd11_LivingDependencyReps() Returns a count of the current number of repetitions of Living Dependency (PD1-1).
CX	getPd110_DuplicatePatient(int rep) Returns a specific repetition of PD1-10: "Duplicate Patient" - creates it if necessary
int	getPd110_DuplicatePatientReps() Returns a count of the current number of repetitions of Duplicate Patient (PD1-10).
CE	getPd111_PublicityCode() Returns PD1-11: "Publicity Code" - creates it if necessary
ID	getPd112_ProtectionIndicator() Returns PD1-12: "Protection Indicator" - creates it if necessary
IS	getPd12_LivingArrangement() Returns PD1-2: "Living Arrangement" - creates it if necessary
XON	getPd13_PatientPrimaryFacility(int rep) Returns a specific repetition of PD1-3: "Patient Primary Facility" - creates it if necessary
int	getPd13_PatientPrimaryFacilityReps() Returns a count of the current number of repetitions of Patient Primary Facility (PD1-3).
XCN	getPd14_PatientPrimaryCareProviderNameIDNo(int rep) Returns a specific repetition of PD1-4: "Patient Primary Care Provider Name & ID No." - creates it if necessary
int	getPd14_PatientPrimaryCareProviderNameIDNoReps() Returns a count of the current number of repetitions of Patient Primary Care Provider Name & ID No.
IS	getPd15_StudentIndicator() Returns PD1-5: "Student Indicator" - creates it if necessary
IS	getPd16_Handicap() Returns PD1-6: "Handicap" - creates it if necessary
IS	getPd17_LivingWill() Returns PD1-7: "Living Will" - creates it if necessary
IS	getPd18_OrganDonor() Returns PD1-8: "Organ Donor" - creates it if necessary
ID	getPd19_SeparateBill() Returns PD1-9: "Separate Bill" - creates it if necessary
ID	getProtectionIndicator() Returns PD1-12: "Protection Indicator" - creates it if necessary
CE	getPublicityCode() Returns PD1-11: "Publicity Code" - creates it if necessary
ID	getSeparateBill() Returns PD1-9: "Separate Bill" - creates it if necessary
IS	getStudentIndicator() Returns PD1-5: "Student Indicator" - creates it if necessary
CX	insertDuplicatePatient(int rep) Inserts a repetition of PD1-10: "Duplicate Patient" at a specific index
IS	insertLivingDependency(int rep) Inserts a repetition of PD1-1: "Living Dependency" at a specific index
XCN	insertPatientPrimaryCareProviderNameIDNo(int rep) Inserts a repetition of PD1-4: "Patient Primary Care Provider Name & ID No." at a specific index
XON	insertPatientPrimaryFacility(int rep) Inserts a repetition of PD1-3: "Patient Primary Facility" at a specific index
IS	insertPd11_LivingDependency(int rep) Inserts a repetition of PD1-1: "Living Dependency" at a specific index
CX	insertPd110_DuplicatePatient(int rep) Inserts a repetition of PD1-10: "Duplicate Patient" at a specific index
XON	insertPd13_PatientPrimaryFacility(int rep) Inserts a repetition of PD1-3: "Patient Primary Facility" at a specific index
XCN	insertPd14_PatientPrimaryCareProviderNameIDNo(int rep) Inserts a repetition of PD1-4: "Patient Primary Care Provider Name & ID No." at a specific index
CX	removeDuplicatePatient(int rep) Removes a repetition of PD1-10: "Duplicate Patient" at a specific index
IS	removeLivingDependency(int rep) Removes a repetition of PD1-1: "Living Dependency" at a specific index
XCN	removePatientPrimaryCareProviderNameIDNo(int rep) Removes a repetition of PD1-4: "Patient Primary Care Provider Name & ID No." at a specific index
XON	removePatientPrimaryFacility(int rep) Removes a repetition of PD1-3: "Patient Primary Facility" at a specific index
IS	removePd11_LivingDependency(int rep) Removes a repetition of PD1-1: "Living Dependency" at a specific index
CX	removePd110_DuplicatePatient(int rep) Removes a repetition of PD1-10: "Duplicate Patient" at a specific index
XON	removePd13_PatientPrimaryFacility(int rep) Removes a repetition of PD1-3: "Patient Primary Facility" at a specific index
XCN	removePd14_PatientPrimaryCareProviderNameIDNo(int rep) Removes a repetition of PD1-4: "Patient Primary Care Provider Name & ID No." at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PD1

public PD1(Group parent,
           ModelClassFactory factory)

Creates a new PD1 segment

Method Detail

getLivingDependency

public IS[] getLivingDependency()

Returns all repetitions of Living Dependency (PD1-1).

getLivingDependencyReps

public int getLivingDependencyReps()

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

getLivingDependency

public IS getLivingDependency(int rep)

Returns a specific repetition of PD1-1: "Living Dependency" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPd11_LivingDependency

public IS getPd11_LivingDependency(int rep)

Returns a specific repetition of PD1-1: "Living Dependency" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPd11_LivingDependencyReps

public int getPd11_LivingDependencyReps()

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

insertLivingDependency

public IS insertLivingDependency(int rep)
                          throws HL7Exception

Inserts a repetition of PD1-1: "Living Dependency" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

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

insertPd11_LivingDependency

public IS insertPd11_LivingDependency(int rep)
                               throws HL7Exception

Inserts a repetition of PD1-1: "Living Dependency" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

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

removeLivingDependency

public IS removeLivingDependency(int rep)
                          throws HL7Exception

Removes a repetition of PD1-1: "Living Dependency" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

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

removePd11_LivingDependency

public IS removePd11_LivingDependency(int rep)
                               throws HL7Exception

Removes a repetition of PD1-1: "Living Dependency" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

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

getLivingArrangement

public IS getLivingArrangement()

Returns PD1-2: "Living Arrangement" - creates it if necessary

getPd12_LivingArrangement

public IS getPd12_LivingArrangement()

Returns PD1-2: "Living Arrangement" - creates it if necessary

getPatientPrimaryFacility

public XON[] getPatientPrimaryFacility()

Returns all repetitions of Patient Primary Facility (PD1-3).

getPatientPrimaryFacilityReps

public int getPatientPrimaryFacilityReps()

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

getPatientPrimaryFacility

public XON getPatientPrimaryFacility(int rep)

Returns a specific repetition of PD1-3: "Patient Primary Facility" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPd13_PatientPrimaryFacility

public XON getPd13_PatientPrimaryFacility(int rep)

Returns a specific repetition of PD1-3: "Patient Primary Facility" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPd13_PatientPrimaryFacilityReps

public int getPd13_PatientPrimaryFacilityReps()

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

insertPatientPrimaryFacility

public XON insertPatientPrimaryFacility(int rep)
                                 throws HL7Exception

Inserts a repetition of PD1-3: "Patient Primary Facility" 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)

insertPd13_PatientPrimaryFacility

public XON insertPd13_PatientPrimaryFacility(int rep)
                                      throws HL7Exception

Inserts a repetition of PD1-3: "Patient Primary Facility" 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)

removePatientPrimaryFacility

public XON removePatientPrimaryFacility(int rep)
                                 throws HL7Exception

Removes a repetition of PD1-3: "Patient Primary Facility" 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)

removePd13_PatientPrimaryFacility

public XON removePd13_PatientPrimaryFacility(int rep)
                                      throws HL7Exception

Removes a repetition of PD1-3: "Patient Primary Facility" 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)

getPatientPrimaryCareProviderNameIDNo

public XCN[] getPatientPrimaryCareProviderNameIDNo()

Returns all repetitions of Patient Primary Care Provider Name & ID No. (PD1-4).

getPatientPrimaryCareProviderNameIDNoReps

public int getPatientPrimaryCareProviderNameIDNoReps()

Returns a count of the current number of repetitions of Patient Primary Care Provider Name & ID No. (PD1-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getPatientPrimaryCareProviderNameIDNo

public XCN getPatientPrimaryCareProviderNameIDNo(int rep)

Returns a specific repetition of PD1-4: "Patient Primary Care Provider Name & ID No." - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPd14_PatientPrimaryCareProviderNameIDNo

public XCN getPd14_PatientPrimaryCareProviderNameIDNo(int rep)

Returns a specific repetition of PD1-4: "Patient Primary Care Provider Name & ID No." - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPd14_PatientPrimaryCareProviderNameIDNoReps

public int getPd14_PatientPrimaryCareProviderNameIDNoReps()

Returns a count of the current number of repetitions of Patient Primary Care Provider Name & ID No. (PD1-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertPatientPrimaryCareProviderNameIDNo

public XCN insertPatientPrimaryCareProviderNameIDNo(int rep)
                                             throws HL7Exception

Inserts a repetition of PD1-4: "Patient Primary Care Provider Name & ID No." 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)

insertPd14_PatientPrimaryCareProviderNameIDNo

public XCN insertPd14_PatientPrimaryCareProviderNameIDNo(int rep)
                                                  throws HL7Exception

Inserts a repetition of PD1-4: "Patient Primary Care Provider Name & ID No." 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)

removePatientPrimaryCareProviderNameIDNo

public XCN removePatientPrimaryCareProviderNameIDNo(int rep)
                                             throws HL7Exception

Removes a repetition of PD1-4: "Patient Primary Care Provider Name & ID No." 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)

removePd14_PatientPrimaryCareProviderNameIDNo

public XCN removePd14_PatientPrimaryCareProviderNameIDNo(int rep)
                                                  throws HL7Exception

Removes a repetition of PD1-4: "Patient Primary Care Provider Name & ID No." 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)

getStudentIndicator

public IS getStudentIndicator()

Returns PD1-5: "Student Indicator" - creates it if necessary

getPd15_StudentIndicator

public IS getPd15_StudentIndicator()

Returns PD1-5: "Student Indicator" - creates it if necessary

getHandicap

public IS getHandicap()

Returns PD1-6: "Handicap" - creates it if necessary

getPd16_Handicap

public IS getPd16_Handicap()

Returns PD1-6: "Handicap" - creates it if necessary

getLivingWill

public IS getLivingWill()

Returns PD1-7: "Living Will" - creates it if necessary

getPd17_LivingWill

public IS getPd17_LivingWill()

Returns PD1-7: "Living Will" - creates it if necessary

getOrganDonor

public IS getOrganDonor()

Returns PD1-8: "Organ Donor" - creates it if necessary

getPd18_OrganDonor

public IS getPd18_OrganDonor()

Returns PD1-8: "Organ Donor" - creates it if necessary

getSeparateBill

public ID getSeparateBill()

Returns PD1-9: "Separate Bill" - creates it if necessary

getPd19_SeparateBill

public ID getPd19_SeparateBill()

Returns PD1-9: "Separate Bill" - creates it if necessary

getDuplicatePatient

public CX[] getDuplicatePatient()

Returns all repetitions of Duplicate Patient (PD1-10).

getDuplicatePatientReps

public int getDuplicatePatientReps()

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

getDuplicatePatient

public CX getDuplicatePatient(int rep)

Returns a specific repetition of PD1-10: "Duplicate Patient" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPd110_DuplicatePatient

public CX getPd110_DuplicatePatient(int rep)

Returns a specific repetition of PD1-10: "Duplicate Patient" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPd110_DuplicatePatientReps

public int getPd110_DuplicatePatientReps()

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

insertDuplicatePatient

public CX insertDuplicatePatient(int rep)
                          throws HL7Exception

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

insertPd110_DuplicatePatient

public CX insertPd110_DuplicatePatient(int rep)
                                throws HL7Exception

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

removeDuplicatePatient

public CX removeDuplicatePatient(int rep)
                          throws HL7Exception

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

removePd110_DuplicatePatient

public CX removePd110_DuplicatePatient(int rep)
                                throws HL7Exception

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

getPublicityCode

public CE getPublicityCode()

Returns PD1-11: "Publicity Code" - creates it if necessary

getPd111_PublicityCode

public CE getPd111_PublicityCode()

Returns PD1-11: "Publicity Code" - creates it if necessary

getProtectionIndicator

public ID getProtectionIndicator()

Returns PD1-12: "Protection Indicator" - creates it if necessary

getPd112_ProtectionIndicator

public ID getPd112_ProtectionIndicator()

Returns PD1-12: "Protection Indicator" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment