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

Class PRD

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

Represents an HL7 PRD message segment (Provider Data). This segment has the following fields:

  • PRD-1: Role (CE) repeating
  • PRD-2: Provider Name (XPN) optional repeating
  • PRD-3: Provider Address (XAD) optional
  • PRD-4: Provider Location (PL) optional
  • PRD-5: Provider Communication Information (XTN) optional repeating
  • PRD-6: Preferred Method of Contact (CE) optional
  • PRD-7: Provider Identifiers (CM_PI) optional repeating
  • PRD-8: Effective Start Date of Role (TS) optional
  • PRD-9: Effective End Date of Role (TS) optional
See Also:

  • Constructor Details

  • Method Details

    • getRole

      public CE[] getRole()
      Returns all repetitions of Role (PRD-1).

    • getPrd1_Role

      public CE[] getPrd1_Role()
      Returns all repetitions of Role (PRD-1).

    • getRoleReps

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

    • getRole

      public CE getRole(int rep)
      Returns a specific repetition of PRD-1: "Role" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrd1_Role

      public CE getPrd1_Role(int rep)
      Returns a specific repetition of PRD-1: "Role" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrd1_RoleReps

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

    • insertRole

      public CE insertRole(int rep) throws HL7Exception
      Inserts a repetition of PRD-1: "Role" 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)

    • insertPrd1_Role

      public CE insertPrd1_Role(int rep) throws HL7Exception
      Inserts a repetition of PRD-1: "Role" 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)

    • removeRole

      public CE removeRole(int rep) throws HL7Exception
      Removes a repetition of PRD-1: "Role" 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)

    • removePrd1_Role

      public CE removePrd1_Role(int rep) throws HL7Exception
      Removes a repetition of PRD-1: "Role" 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)

    • getProviderName

      public XPN[] getProviderName()
      Returns all repetitions of Provider Name (PRD-2).

    • getPrd2_ProviderName

      public XPN[] getPrd2_ProviderName()
      Returns all repetitions of Provider Name (PRD-2).

    • getProviderNameReps

      public int getProviderNameReps()
      Returns a count of the current number of repetitions of Provider Name (PRD-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getProviderName

      public XPN getProviderName(int rep)
      Returns a specific repetition of PRD-2: "Provider Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrd2_ProviderName

      public XPN getPrd2_ProviderName(int rep)
      Returns a specific repetition of PRD-2: "Provider Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrd2_ProviderNameReps

      public int getPrd2_ProviderNameReps()
      Returns a count of the current number of repetitions of Provider Name (PRD-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertProviderName

      public XPN insertProviderName(int rep) throws HL7Exception
      Inserts a repetition of PRD-2: "Provider Name" 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)

    • insertPrd2_ProviderName

      public XPN insertPrd2_ProviderName(int rep) throws HL7Exception
      Inserts a repetition of PRD-2: "Provider Name" 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)

    • removeProviderName

      public XPN removeProviderName(int rep) throws HL7Exception
      Removes a repetition of PRD-2: "Provider Name" 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)

    • removePrd2_ProviderName

      public XPN removePrd2_ProviderName(int rep) throws HL7Exception
      Removes a repetition of PRD-2: "Provider Name" 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)

    • getProviderAddress

      public XAD getProviderAddress()
      Returns PRD-3: "Provider Address" - creates it if necessary

    • getPrd3_ProviderAddress

      public XAD getPrd3_ProviderAddress()
      Returns PRD-3: "Provider Address" - creates it if necessary

    • getProviderLocation

      public PL getProviderLocation()
      Returns PRD-4: "Provider Location" - creates it if necessary

    • getPrd4_ProviderLocation

      public PL getPrd4_ProviderLocation()
      Returns PRD-4: "Provider Location" - creates it if necessary

    • getProviderCommunicationInformation

      public XTN[] getProviderCommunicationInformation()
      Returns all repetitions of Provider Communication Information (PRD-5).

    • getPrd5_ProviderCommunicationInformation

      public XTN[] getPrd5_ProviderCommunicationInformation()
      Returns all repetitions of Provider Communication Information (PRD-5).

    • getProviderCommunicationInformationReps

      public int getProviderCommunicationInformationReps()
      Returns a count of the current number of repetitions of Provider Communication Information (PRD-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getProviderCommunicationInformation

      public XTN getProviderCommunicationInformation(int rep)
      Returns a specific repetition of PRD-5: "Provider Communication Information" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrd5_ProviderCommunicationInformation

      public XTN getPrd5_ProviderCommunicationInformation(int rep)
      Returns a specific repetition of PRD-5: "Provider Communication Information" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrd5_ProviderCommunicationInformationReps

      public int getPrd5_ProviderCommunicationInformationReps()
      Returns a count of the current number of repetitions of Provider Communication Information (PRD-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertProviderCommunicationInformation

      public XTN insertProviderCommunicationInformation(int rep) throws HL7Exception
      Inserts a repetition of PRD-5: "Provider Communication Information" 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)

    • insertPrd5_ProviderCommunicationInformation

      public XTN insertPrd5_ProviderCommunicationInformation(int rep) throws HL7Exception
      Inserts a repetition of PRD-5: "Provider Communication Information" 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)

    • removeProviderCommunicationInformation

      public XTN removeProviderCommunicationInformation(int rep) throws HL7Exception
      Removes a repetition of PRD-5: "Provider Communication Information" 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)

    • removePrd5_ProviderCommunicationInformation

      public XTN removePrd5_ProviderCommunicationInformation(int rep) throws HL7Exception
      Removes a repetition of PRD-5: "Provider Communication Information" 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)

    • getPreferredMethodOfContact

      public CE getPreferredMethodOfContact()
      Returns PRD-6: "Preferred Method of Contact" - creates it if necessary

    • getPrd6_PreferredMethodOfContact

      public CE getPrd6_PreferredMethodOfContact()
      Returns PRD-6: "Preferred Method of Contact" - creates it if necessary

    • getProviderIdentifiers

      public CM_PI[] getProviderIdentifiers()
      Returns all repetitions of Provider Identifiers (PRD-7).

    • getPrd7_ProviderIdentifiers

      public CM_PI[] getPrd7_ProviderIdentifiers()
      Returns all repetitions of Provider Identifiers (PRD-7).

    • getProviderIdentifiersReps

      public int getProviderIdentifiersReps()
      Returns a count of the current number of repetitions of Provider Identifiers (PRD-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getProviderIdentifiers

      public CM_PI getProviderIdentifiers(int rep)
      Returns a specific repetition of PRD-7: "Provider Identifiers" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrd7_ProviderIdentifiers

      public CM_PI getPrd7_ProviderIdentifiers(int rep)
      Returns a specific repetition of PRD-7: "Provider Identifiers" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrd7_ProviderIdentifiersReps

      public int getPrd7_ProviderIdentifiersReps()
      Returns a count of the current number of repetitions of Provider Identifiers (PRD-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertProviderIdentifiers

      public CM_PI insertProviderIdentifiers(int rep) throws HL7Exception
      Inserts a repetition of PRD-7: "Provider Identifiers" 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)

    • insertPrd7_ProviderIdentifiers

      public CM_PI insertPrd7_ProviderIdentifiers(int rep) throws HL7Exception
      Inserts a repetition of PRD-7: "Provider Identifiers" 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)

    • removeProviderIdentifiers

      public CM_PI removeProviderIdentifiers(int rep) throws HL7Exception
      Removes a repetition of PRD-7: "Provider Identifiers" 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)

    • removePrd7_ProviderIdentifiers

      public CM_PI removePrd7_ProviderIdentifiers(int rep) throws HL7Exception
      Removes a repetition of PRD-7: "Provider Identifiers" 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)

    • getEffectiveStartDateOfRole

      public TS getEffectiveStartDateOfRole()
      Returns PRD-8: "Effective Start Date of Role" - creates it if necessary

    • getPrd8_EffectiveStartDateOfRole

      public TS getPrd8_EffectiveStartDateOfRole()
      Returns PRD-8: "Effective Start Date of Role" - creates it if necessary

    • getEffectiveEndDateOfRole

      public TS getEffectiveEndDateOfRole()
      Returns PRD-9: "Effective End Date of Role" - creates it if necessary

    • getPrd9_EffectiveEndDateOfRole

      public TS getPrd9_EffectiveEndDateOfRole()
      Returns PRD-9: "Effective End Date of Role" - creates it if necessary

    • createNewTypeWithoutReflection

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