ca.uhn.hl7v2.model.v24.segment
Class LDP

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.LDP

All Implemented Interfaces:

Segment, Structure, Serializable

public class LDP
extends AbstractSegment

Represents an HL7 LDP message segment (Location Department). This segment has the following fields:

• LDP-1: Primary Key Value - LDP (PL)
• LDP-2: Location Department (CE)
• LDP-3: Location Service (IS) optional repeating
• LDP-4: Specialty Type (CE) optional repeating
• LDP-5: Valid Patient Classes (IS) optional repeating
• LDP-6: Active/Inactive Flag (ID) optional
• LDP-7: Activation Date LDP (TS) optional
• LDP-8: Inactivation Date - LDP (TS) optional
• LDP-9: Inactivated Reason (ST) optional
• LDP-10: Visiting Hours (VH) optional repeating
• LDP-11: Contact Phone (XTN) optional
• LDP-12: Location Cost Center (CE) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
TS	getActivationDateLDP() Returns LDP-7: "Activation Date LDP" - creates it if necessary
ID	getActiveInactiveFlag() Returns LDP-6: "Active/Inactive Flag" - creates it if necessary
XTN	getContactPhone() Returns LDP-11: "Contact Phone" - creates it if necessary
ST	getInactivatedReason() Returns LDP-9: "Inactivated Reason" - creates it if necessary
TS	getInactivationDateLDP() Returns LDP-8: "Inactivation Date - LDP" - creates it if necessary
PL	getLdp1_PrimaryKeyValueLDP() Returns LDP-1: "Primary Key Value - LDP" - creates it if necessary
VH	getLdp10_VisitingHours(int rep) Returns a specific repetition of LDP-10: "Visiting Hours" - creates it if necessary
int	getLdp10_VisitingHoursReps() Returns a count of the current number of repetitions of Visiting Hours (LDP-10).
XTN	getLdp11_ContactPhone() Returns LDP-11: "Contact Phone" - creates it if necessary
CE	getLdp12_LocationCostCenter() Returns LDP-12: "Location Cost Center" - creates it if necessary
CE	getLdp2_LocationDepartment() Returns LDP-2: "Location Department" - creates it if necessary
IS	getLdp3_LocationService(int rep) Returns a specific repetition of LDP-3: "Location Service" - creates it if necessary
int	getLdp3_LocationServiceReps() Returns a count of the current number of repetitions of Location Service (LDP-3).
CE	getLdp4_SpecialtyType(int rep) Returns a specific repetition of LDP-4: "Specialty Type" - creates it if necessary
int	getLdp4_SpecialtyTypeReps() Returns a count of the current number of repetitions of Specialty Type (LDP-4).
IS	getLdp5_ValidPatientClasses(int rep) Returns a specific repetition of LDP-5: "Valid Patient Classes" - creates it if necessary
int	getLdp5_ValidPatientClassesReps() Returns a count of the current number of repetitions of Valid Patient Classes (LDP-5).
ID	getLdp6_ActiveInactiveFlag() Returns LDP-6: "Active/Inactive Flag" - creates it if necessary
TS	getLdp7_ActivationDateLDP() Returns LDP-7: "Activation Date LDP" - creates it if necessary
TS	getLdp8_InactivationDateLDP() Returns LDP-8: "Inactivation Date - LDP" - creates it if necessary
ST	getLdp9_InactivatedReason() Returns LDP-9: "Inactivated Reason" - creates it if necessary
CE	getLocationCostCenter() Returns LDP-12: "Location Cost Center" - creates it if necessary
CE	getLocationDepartment() Returns LDP-2: "Location Department" - creates it if necessary
IS[]	getLocationService() Returns all repetitions of Location Service (LDP-3).
IS	getLocationService(int rep) Returns a specific repetition of LDP-3: "Location Service" - creates it if necessary
int	getLocationServiceReps() Returns a count of the current number of repetitions of Location Service (LDP-3).
PL	getPrimaryKeyValueLDP() Returns LDP-1: "Primary Key Value - LDP" - creates it if necessary
CE[]	getSpecialtyType() Returns all repetitions of Specialty Type (LDP-4).
CE	getSpecialtyType(int rep) Returns a specific repetition of LDP-4: "Specialty Type" - creates it if necessary
int	getSpecialtyTypeReps() Returns a count of the current number of repetitions of Specialty Type (LDP-4).
IS[]	getValidPatientClasses() Returns all repetitions of Valid Patient Classes (LDP-5).
IS	getValidPatientClasses(int rep) Returns a specific repetition of LDP-5: "Valid Patient Classes" - creates it if necessary
int	getValidPatientClassesReps() Returns a count of the current number of repetitions of Valid Patient Classes (LDP-5).
VH[]	getVisitingHours() Returns all repetitions of Visiting Hours (LDP-10).
VH	getVisitingHours(int rep) Returns a specific repetition of LDP-10: "Visiting Hours" - creates it if necessary
int	getVisitingHoursReps() Returns a count of the current number of repetitions of Visiting Hours (LDP-10).
VH	insertLdp10_VisitingHours(int rep) Inserts a repetition of LDP-10: "Visiting Hours" at a specific index
IS	insertLdp3_LocationService(int rep) Inserts a repetition of LDP-3: "Location Service" at a specific index
CE	insertLdp4_SpecialtyType(int rep) Inserts a repetition of LDP-4: "Specialty Type" at a specific index
IS	insertLdp5_ValidPatientClasses(int rep) Inserts a repetition of LDP-5: "Valid Patient Classes" at a specific index
IS	insertLocationService(int rep) Inserts a repetition of LDP-3: "Location Service" at a specific index
CE	insertSpecialtyType(int rep) Inserts a repetition of LDP-4: "Specialty Type" at a specific index
IS	insertValidPatientClasses(int rep) Inserts a repetition of LDP-5: "Valid Patient Classes" at a specific index
VH	insertVisitingHours(int rep) Inserts a repetition of LDP-10: "Visiting Hours" at a specific index
VH	removeLdp10_VisitingHours(int rep) Removes a repetition of LDP-10: "Visiting Hours" at a specific index
IS	removeLdp3_LocationService(int rep) Removes a repetition of LDP-3: "Location Service" at a specific index
CE	removeLdp4_SpecialtyType(int rep) Removes a repetition of LDP-4: "Specialty Type" at a specific index
IS	removeLdp5_ValidPatientClasses(int rep) Removes a repetition of LDP-5: "Valid Patient Classes" at a specific index
IS	removeLocationService(int rep) Removes a repetition of LDP-3: "Location Service" at a specific index
CE	removeSpecialtyType(int rep) Removes a repetition of LDP-4: "Specialty Type" at a specific index
IS	removeValidPatientClasses(int rep) Removes a repetition of LDP-5: "Valid Patient Classes" at a specific index
VH	removeVisitingHours(int rep) Removes a repetition of LDP-10: "Visiting Hours" 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

LDP

public LDP(Group parent,
           ModelClassFactory factory)

Creates a new LDP segment

Method Detail

getPrimaryKeyValueLDP

public PL getPrimaryKeyValueLDP()

Returns LDP-1: "Primary Key Value - LDP" - creates it if necessary

getLdp1_PrimaryKeyValueLDP

public PL getLdp1_PrimaryKeyValueLDP()

Returns LDP-1: "Primary Key Value - LDP" - creates it if necessary

getLocationDepartment

public CE getLocationDepartment()

Returns LDP-2: "Location Department" - creates it if necessary

getLdp2_LocationDepartment

public CE getLdp2_LocationDepartment()

Returns LDP-2: "Location Department" - creates it if necessary

getLocationService

public IS[] getLocationService()

Returns all repetitions of Location Service (LDP-3).

getLocationServiceReps

public int getLocationServiceReps()

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

getLocationService

public IS getLocationService(int rep)

Returns a specific repetition of LDP-3: "Location Service" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLdp3_LocationService

public IS getLdp3_LocationService(int rep)

Returns a specific repetition of LDP-3: "Location Service" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLdp3_LocationServiceReps

public int getLdp3_LocationServiceReps()

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

insertLocationService

public IS insertLocationService(int rep)
                         throws HL7Exception

Inserts a repetition of LDP-3: "Location Service" 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)

insertLdp3_LocationService

public IS insertLdp3_LocationService(int rep)
                              throws HL7Exception

Inserts a repetition of LDP-3: "Location Service" 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)

removeLocationService

public IS removeLocationService(int rep)
                         throws HL7Exception

Removes a repetition of LDP-3: "Location Service" 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)

removeLdp3_LocationService

public IS removeLdp3_LocationService(int rep)
                              throws HL7Exception

Removes a repetition of LDP-3: "Location Service" 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)

getSpecialtyType

public CE[] getSpecialtyType()

Returns all repetitions of Specialty Type (LDP-4).

getSpecialtyTypeReps

public int getSpecialtyTypeReps()

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

getSpecialtyType

public CE getSpecialtyType(int rep)

Returns a specific repetition of LDP-4: "Specialty Type" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLdp4_SpecialtyType

public CE getLdp4_SpecialtyType(int rep)

Returns a specific repetition of LDP-4: "Specialty Type" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLdp4_SpecialtyTypeReps

public int getLdp4_SpecialtyTypeReps()

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

insertSpecialtyType

public CE insertSpecialtyType(int rep)
                       throws HL7Exception

Inserts a repetition of LDP-4: "Specialty Type" 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)

insertLdp4_SpecialtyType

public CE insertLdp4_SpecialtyType(int rep)
                            throws HL7Exception

Inserts a repetition of LDP-4: "Specialty Type" 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)

removeSpecialtyType

public CE removeSpecialtyType(int rep)
                       throws HL7Exception

Removes a repetition of LDP-4: "Specialty Type" 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)

removeLdp4_SpecialtyType

public CE removeLdp4_SpecialtyType(int rep)
                            throws HL7Exception

Removes a repetition of LDP-4: "Specialty Type" 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)

getValidPatientClasses

public IS[] getValidPatientClasses()

Returns all repetitions of Valid Patient Classes (LDP-5).

getValidPatientClassesReps

public int getValidPatientClassesReps()

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

getValidPatientClasses

public IS getValidPatientClasses(int rep)

Returns a specific repetition of LDP-5: "Valid Patient Classes" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLdp5_ValidPatientClasses

public IS getLdp5_ValidPatientClasses(int rep)

Returns a specific repetition of LDP-5: "Valid Patient Classes" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLdp5_ValidPatientClassesReps

public int getLdp5_ValidPatientClassesReps()

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

insertValidPatientClasses

public IS insertValidPatientClasses(int rep)
                             throws HL7Exception

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

insertLdp5_ValidPatientClasses

public IS insertLdp5_ValidPatientClasses(int rep)
                                  throws HL7Exception

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

removeValidPatientClasses

public IS removeValidPatientClasses(int rep)
                             throws HL7Exception

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

removeLdp5_ValidPatientClasses

public IS removeLdp5_ValidPatientClasses(int rep)
                                  throws HL7Exception

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

getActiveInactiveFlag

public ID getActiveInactiveFlag()

Returns LDP-6: "Active/Inactive Flag" - creates it if necessary

getLdp6_ActiveInactiveFlag

public ID getLdp6_ActiveInactiveFlag()

Returns LDP-6: "Active/Inactive Flag" - creates it if necessary

getActivationDateLDP

public TS getActivationDateLDP()

Returns LDP-7: "Activation Date LDP" - creates it if necessary

getLdp7_ActivationDateLDP

public TS getLdp7_ActivationDateLDP()

Returns LDP-7: "Activation Date LDP" - creates it if necessary

getInactivationDateLDP

public TS getInactivationDateLDP()

Returns LDP-8: "Inactivation Date - LDP" - creates it if necessary

getLdp8_InactivationDateLDP

public TS getLdp8_InactivationDateLDP()

Returns LDP-8: "Inactivation Date - LDP" - creates it if necessary

getInactivatedReason

public ST getInactivatedReason()

Returns LDP-9: "Inactivated Reason" - creates it if necessary

getLdp9_InactivatedReason

public ST getLdp9_InactivatedReason()

Returns LDP-9: "Inactivated Reason" - creates it if necessary

getVisitingHours

public VH[] getVisitingHours()

Returns all repetitions of Visiting Hours (LDP-10).

getVisitingHoursReps

public int getVisitingHoursReps()

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

getVisitingHours

public VH getVisitingHours(int rep)

Returns a specific repetition of LDP-10: "Visiting Hours" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLdp10_VisitingHours

public VH getLdp10_VisitingHours(int rep)

Returns a specific repetition of LDP-10: "Visiting Hours" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLdp10_VisitingHoursReps

public int getLdp10_VisitingHoursReps()

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

insertVisitingHours

public VH insertVisitingHours(int rep)
                       throws HL7Exception

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

insertLdp10_VisitingHours

public VH insertLdp10_VisitingHours(int rep)
                             throws HL7Exception

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

removeVisitingHours

public VH removeVisitingHours(int rep)
                       throws HL7Exception

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

removeLdp10_VisitingHours

public VH removeLdp10_VisitingHours(int rep)
                             throws HL7Exception

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

getContactPhone

public XTN getContactPhone()

Returns LDP-11: "Contact Phone" - creates it if necessary

getLdp11_ContactPhone

public XTN getLdp11_ContactPhone()

Returns LDP-11: "Contact Phone" - creates it if necessary

getLocationCostCenter

public CE getLocationCostCenter()

Returns LDP-12: "Location Cost Center" - creates it if necessary

getLdp12_LocationCostCenter

public CE getLdp12_LocationCostCenter()

Returns LDP-12: "Location Cost Center" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment