Package ca.uhn.hl7v2.model.v23.segment

Class LDP

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v23.segment.LDP
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class LDP extends AbstractSegment

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

  • LDP-1: LDP Primary Key Value (PL)
  • LDP-2: Location Department (IS)
  • LDP-3: Location Service (IS) optional repeating
  • LDP-4: Speciality Type (CE) optional repeating
  • LDP-5: Valid Patient Classes (ID) optional repeating
  • LDP-6: Active/Inactive Flag (ID) optional
  • LDP-7: Activation Date (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
See Also:

  • Constructor Details

  • Method Details

    • getLDPPrimaryKeyValue

      public PL getLDPPrimaryKeyValue()
      Returns LDP-1: "LDP Primary Key Value" - creates it if necessary

    • getLdp1_LDPPrimaryKeyValue

      public PL getLdp1_LDPPrimaryKeyValue()
      Returns LDP-1: "LDP Primary Key Value" - creates it if necessary

    • getLocationDepartment

      public IS getLocationDepartment()
      Returns LDP-2: "Location Department" - creates it if necessary

    • getLdp2_LocationDepartment

      public IS getLdp2_LocationDepartment()
      Returns LDP-2: "Location Department" - creates it if necessary

    • getLocationService

      public IS[] getLocationService()
      Returns all repetitions of Location Service (LDP-3).

    • getLdp3_LocationService

      public IS[] getLdp3_LocationService()
      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)

    • getSpecialityType

      public CE[] getSpecialityType()
      Returns all repetitions of Speciality Type (LDP-4).

    • getLdp4_SpecialityType

      public CE[] getLdp4_SpecialityType()
      Returns all repetitions of Speciality Type (LDP-4).

    • getSpecialityTypeReps

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

    • getSpecialityType

      public CE getSpecialityType(int rep)
      Returns a specific repetition of LDP-4: "Speciality Type" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getLdp4_SpecialityType

      public CE getLdp4_SpecialityType(int rep)
      Returns a specific repetition of LDP-4: "Speciality Type" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getLdp4_SpecialityTypeReps

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

    • insertSpecialityType

      public CE insertSpecialityType(int rep) throws HL7Exception
      Inserts a repetition of LDP-4: "Speciality 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_SpecialityType

      public CE insertLdp4_SpecialityType(int rep) throws HL7Exception
      Inserts a repetition of LDP-4: "Speciality 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)

    • removeSpecialityType

      public CE removeSpecialityType(int rep) throws HL7Exception
      Removes a repetition of LDP-4: "Speciality 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_SpecialityType

      public CE removeLdp4_SpecialityType(int rep) throws HL7Exception
      Removes a repetition of LDP-4: "Speciality 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 ID[] getValidPatientClasses()
      Returns all repetitions of Valid Patient Classes (LDP-5).

    • getLdp5_ValidPatientClasses

      public ID[] getLdp5_ValidPatientClasses()
      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 ID 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 ID 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 ID 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 ID 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 ID 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 ID 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

    • getActivationDate

      public TS getActivationDate()
      Returns LDP-7: "Activation Date" - creates it if necessary

    • getLdp7_ActivationDate

      public TS getLdp7_ActivationDate()
      Returns LDP-7: "Activation Date" - 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).

    • getLdp10_VisitingHours

      public VH[] getLdp10_VisitingHours()
      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

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment