Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  extended by ca.uhn.hl7v2.model.AbstractSegment
      extended by ca.uhn.hl7v2.model.v24.segment.PRD
All Implemented Interfaces:
Segment, Structure, Serializable
public class PRD
extends AbstractSegment

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

See Also:
Serialized Form

Constructor Summary
PRD(Group parent, ModelClassFactory factory)
          Creates a new PRD segment
 
Method Summary
protected  Type createNewTypeWithoutReflection(int field)
          
 TS getEffectiveEndDateOfProviderRole()
          Returns PRD-9: "Effective End Date of Provider Role" - creates it if necessary
 TS getEffectiveStartDateOfProviderRole()
          Returns PRD-8: "Effective Start Date of Provider Role" - creates it if necessary
 CE getPrd1_ProviderRole(int rep)
          Returns a specific repetition of PRD-1: "Provider Role" - creates it if necessary
 int getPrd1_ProviderRoleReps()
          Returns a count of the current number of repetitions of Provider Role (PRD-1).
 XPN getPrd2_ProviderName(int rep)
          Returns a specific repetition of PRD-2: "Provider Name" - creates it if necessary
 int getPrd2_ProviderNameReps()
          Returns a count of the current number of repetitions of Provider Name (PRD-2).
 XAD getPrd3_ProviderAddress(int rep)
          Returns a specific repetition of PRD-3: "Provider Address" - creates it if necessary
 int getPrd3_ProviderAddressReps()
          Returns a count of the current number of repetitions of Provider Address (PRD-3).
 PL getPrd4_ProviderLocation()
          Returns PRD-4: "Provider Location" - creates it if necessary
 XTN getPrd5_ProviderCommunicationInformation(int rep)
          Returns a specific repetition of PRD-5: "Provider Communication Information" - creates it if necessary
 int getPrd5_ProviderCommunicationInformationReps()
          Returns a count of the current number of repetitions of Provider Communication Information (PRD-5).
 CE getPrd6_PreferredMethodOfContact()
          Returns PRD-6: "Preferred Method of Contact" - creates it if necessary
 PI getPrd7_ProviderIdentifiers(int rep)
          Returns a specific repetition of PRD-7: "Provider Identifiers" - creates it if necessary
 int getPrd7_ProviderIdentifiersReps()
          Returns a count of the current number of repetitions of Provider Identifiers (PRD-7).
 TS getPrd8_EffectiveStartDateOfProviderRole()
          Returns PRD-8: "Effective Start Date of Provider Role" - creates it if necessary
 TS getPrd9_EffectiveEndDateOfProviderRole()
          Returns PRD-9: "Effective End Date of Provider Role" - creates it if necessary
 CE getPreferredMethodOfContact()
          Returns PRD-6: "Preferred Method of Contact" - creates it if necessary
 XAD[] getProviderAddress()
          Returns all repetitions of Provider Address (PRD-3).
 XAD getProviderAddress(int rep)
          Returns a specific repetition of PRD-3: "Provider Address" - creates it if necessary
 int getProviderAddressReps()
          Returns a count of the current number of repetitions of Provider Address (PRD-3).
 XTN[] getProviderCommunicationInformation()
          Returns all repetitions of Provider Communication Information (PRD-5).
 XTN getProviderCommunicationInformation(int rep)
          Returns a specific repetition of PRD-5: "Provider Communication Information" - creates it if necessary
 int getProviderCommunicationInformationReps()
          Returns a count of the current number of repetitions of Provider Communication Information (PRD-5).
 PI[] getProviderIdentifiers()
          Returns all repetitions of Provider Identifiers (PRD-7).
 PI getProviderIdentifiers(int rep)
          Returns a specific repetition of PRD-7: "Provider Identifiers" - creates it if necessary
 int getProviderIdentifiersReps()
          Returns a count of the current number of repetitions of Provider Identifiers (PRD-7).
 PL getProviderLocation()
          Returns PRD-4: "Provider Location" - creates it if necessary
 XPN[] getProviderName()
          Returns all repetitions of Provider Name (PRD-2).
 XPN getProviderName(int rep)
          Returns a specific repetition of PRD-2: "Provider Name" - creates it if necessary
 int getProviderNameReps()
          Returns a count of the current number of repetitions of Provider Name (PRD-2).
 CE[] getProviderRole()
          Returns all repetitions of Provider Role (PRD-1).
 CE getProviderRole(int rep)
          Returns a specific repetition of PRD-1: "Provider Role" - creates it if necessary
 int getProviderRoleReps()
          Returns a count of the current number of repetitions of Provider Role (PRD-1).
 CE insertPrd1_ProviderRole(int rep)
          Inserts a repetition of PRD-1: "Provider Role" at a specific index
 XPN insertPrd2_ProviderName(int rep)
          Inserts a repetition of PRD-2: "Provider Name" at a specific index
 XAD insertPrd3_ProviderAddress(int rep)
          Inserts a repetition of PRD-3: "Provider Address" at a specific index
 XTN insertPrd5_ProviderCommunicationInformation(int rep)
          Inserts a repetition of PRD-5: "Provider Communication Information" at a specific index
 PI insertPrd7_ProviderIdentifiers(int rep)
          Inserts a repetition of PRD-7: "Provider Identifiers" at a specific index
 XAD insertProviderAddress(int rep)
          Inserts a repetition of PRD-3: "Provider Address" at a specific index
 XTN insertProviderCommunicationInformation(int rep)
          Inserts a repetition of PRD-5: "Provider Communication Information" at a specific index
 PI insertProviderIdentifiers(int rep)
          Inserts a repetition of PRD-7: "Provider Identifiers" at a specific index
 XPN insertProviderName(int rep)
          Inserts a repetition of PRD-2: "Provider Name" at a specific index
 CE insertProviderRole(int rep)
          Inserts a repetition of PRD-1: "Provider Role" at a specific index
 CE removePrd1_ProviderRole(int rep)
          Removes a repetition of PRD-1: "Provider Role" at a specific index
 XPN removePrd2_ProviderName(int rep)
          Removes a repetition of PRD-2: "Provider Name" at a specific index
 XAD removePrd3_ProviderAddress(int rep)
          Removes a repetition of PRD-3: "Provider Address" at a specific index
 XTN removePrd5_ProviderCommunicationInformation(int rep)
          Removes a repetition of PRD-5: "Provider Communication Information" at a specific index
 PI removePrd7_ProviderIdentifiers(int rep)
          Removes a repetition of PRD-7: "Provider Identifiers" at a specific index
 XAD removeProviderAddress(int rep)
          Removes a repetition of PRD-3: "Provider Address" at a specific index
 XTN removeProviderCommunicationInformation(int rep)
          Removes a repetition of PRD-5: "Provider Communication Information" at a specific index
 PI removeProviderIdentifiers(int rep)
          Removes a repetition of PRD-7: "Provider Identifiers" at a specific index
 XPN removeProviderName(int rep)
          Removes a repetition of PRD-2: "Provider Name" at a specific index
 CE removeProviderRole(int rep)
          Removes a repetition of PRD-1: "Provider Role" 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

PRD

public PRD(Group parent,
           ModelClassFactory factory)
Creates a new PRD segment

Method Detail

getProviderRole

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

getProviderRoleReps

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

getProviderRole

public CE getProviderRole(int rep)
Returns a specific repetition of PRD-1: "Provider Role" - creates it if necessary

Parameters:
rep - The repetition index (0-indexed)

getPrd1_ProviderRole

public CE getPrd1_ProviderRole(int rep)
Returns a specific repetition of PRD-1: "Provider Role" - creates it if necessary

Parameters:
rep - The repetition index (0-indexed)

getPrd1_ProviderRoleReps

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

insertProviderRole

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

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

removeProviderRole

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

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

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 all repetitions of Provider Address (PRD-3).

getProviderAddressReps

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

getProviderAddress

public XAD getProviderAddress(int rep)
Returns a specific repetition of PRD-3: "Provider Address" - creates it if necessary

Parameters:
rep - The repetition index (0-indexed)

getPrd3_ProviderAddress

public XAD getPrd3_ProviderAddress(int rep)
Returns a specific repetition of PRD-3: "Provider Address" - creates it if necessary

Parameters:
rep - The repetition index (0-indexed)

getPrd3_ProviderAddressReps

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

insertProviderAddress

public XAD insertProviderAddress(int rep)
                          throws HL7Exception
Inserts a repetition of PRD-3: "Provider Address" 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)

insertPrd3_ProviderAddress

public XAD insertPrd3_ProviderAddress(int rep)
                               throws HL7Exception
Inserts a repetition of PRD-3: "Provider Address" 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)

removeProviderAddress

public XAD removeProviderAddress(int rep)
                          throws HL7Exception
Removes a repetition of PRD-3: "Provider Address" 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)

removePrd3_ProviderAddress

public XAD removePrd3_ProviderAddress(int rep)
                               throws HL7Exception
Removes a repetition of PRD-3: "Provider Address" 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)

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).

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 PI[] getProviderIdentifiers()
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 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 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 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 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 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 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)

getEffectiveStartDateOfProviderRole

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

getPrd8_EffectiveStartDateOfProviderRole

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

getEffectiveEndDateOfProviderRole

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

getPrd9_EffectiveEndDateOfProviderRole

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

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:
createNewTypeWithoutReflection in class AbstractSegment
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2001-2011 University Health Network. All Rights Reserved.