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

Class PRA

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

Represents an HL7 PRA message segment (Practitioner detail segment). This segment has the following fields:

  • PRA-1: PRA - Primary Key Value (ST)
  • PRA-2: Practioner Group (CE) optional repeating
  • PRA-3: Practioner Category (ID) optional repeating
  • PRA-4: Provider Billing (ID) optional
  • PRA-5: Specialty (CM_SPD) optional repeating
  • PRA-6: Practitioner ID Numbers (CM_PLN) optional repeating
  • PRA-7: Privileges (CM_PIP) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getPRAPrimaryKeyValue

      public ST getPRAPrimaryKeyValue()
      Returns PRA-1: "PRA - Primary Key Value" - creates it if necessary

    • getPra1_PRAPrimaryKeyValue

      public ST getPra1_PRAPrimaryKeyValue()
      Returns PRA-1: "PRA - Primary Key Value" - creates it if necessary

    • getPractionerGroup

      public CE[] getPractionerGroup()
      Returns all repetitions of Practioner Group (PRA-2).

    • getPra2_PractionerGroup

      public CE[] getPra2_PractionerGroup()
      Returns all repetitions of Practioner Group (PRA-2).

    • getPractionerGroupReps

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

    • getPractionerGroup

      public CE getPractionerGroup(int rep)
      Returns a specific repetition of PRA-2: "Practioner Group" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPra2_PractionerGroup

      public CE getPra2_PractionerGroup(int rep)
      Returns a specific repetition of PRA-2: "Practioner Group" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPra2_PractionerGroupReps

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

    • insertPractionerGroup

      public CE insertPractionerGroup(int rep) throws HL7Exception
      Inserts a repetition of PRA-2: "Practioner Group" 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)

    • insertPra2_PractionerGroup

      public CE insertPra2_PractionerGroup(int rep) throws HL7Exception
      Inserts a repetition of PRA-2: "Practioner Group" 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)

    • removePractionerGroup

      public CE removePractionerGroup(int rep) throws HL7Exception
      Removes a repetition of PRA-2: "Practioner Group" 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)

    • removePra2_PractionerGroup

      public CE removePra2_PractionerGroup(int rep) throws HL7Exception
      Removes a repetition of PRA-2: "Practioner Group" 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)

    • getPractionerCategory

      public ID[] getPractionerCategory()
      Returns all repetitions of Practioner Category (PRA-3).

    • getPra3_PractionerCategory

      public ID[] getPra3_PractionerCategory()
      Returns all repetitions of Practioner Category (PRA-3).

    • getPractionerCategoryReps

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

    • getPractionerCategory

      public ID getPractionerCategory(int rep)
      Returns a specific repetition of PRA-3: "Practioner Category" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPra3_PractionerCategory

      public ID getPra3_PractionerCategory(int rep)
      Returns a specific repetition of PRA-3: "Practioner Category" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPra3_PractionerCategoryReps

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

    • insertPractionerCategory

      public ID insertPractionerCategory(int rep) throws HL7Exception
      Inserts a repetition of PRA-3: "Practioner Category" 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)

    • insertPra3_PractionerCategory

      public ID insertPra3_PractionerCategory(int rep) throws HL7Exception
      Inserts a repetition of PRA-3: "Practioner Category" 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)

    • removePractionerCategory

      public ID removePractionerCategory(int rep) throws HL7Exception
      Removes a repetition of PRA-3: "Practioner Category" 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)

    • removePra3_PractionerCategory

      public ID removePra3_PractionerCategory(int rep) throws HL7Exception
      Removes a repetition of PRA-3: "Practioner Category" 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)

    • getProviderBilling

      public ID getProviderBilling()
      Returns PRA-4: "Provider Billing" - creates it if necessary

    • getPra4_ProviderBilling

      public ID getPra4_ProviderBilling()
      Returns PRA-4: "Provider Billing" - creates it if necessary

    • getSpecialty

      public CM_SPD[] getSpecialty()
      Returns all repetitions of Specialty (PRA-5).

    • getPra5_Specialty

      public CM_SPD[] getPra5_Specialty()
      Returns all repetitions of Specialty (PRA-5).

    • getSpecialtyReps

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

    • getSpecialty

      public CM_SPD getSpecialty(int rep)
      Returns a specific repetition of PRA-5: "Specialty" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPra5_Specialty

      public CM_SPD getPra5_Specialty(int rep)
      Returns a specific repetition of PRA-5: "Specialty" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPra5_SpecialtyReps

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

    • insertSpecialty

      public CM_SPD insertSpecialty(int rep) throws HL7Exception
      Inserts a repetition of PRA-5: "Specialty" 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)

    • insertPra5_Specialty

      public CM_SPD insertPra5_Specialty(int rep) throws HL7Exception
      Inserts a repetition of PRA-5: "Specialty" 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)

    • removeSpecialty

      public CM_SPD removeSpecialty(int rep) throws HL7Exception
      Removes a repetition of PRA-5: "Specialty" 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)

    • removePra5_Specialty

      public CM_SPD removePra5_Specialty(int rep) throws HL7Exception
      Removes a repetition of PRA-5: "Specialty" 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)

    • getPractitionerIDNumbers

      public CM_PLN[] getPractitionerIDNumbers()
      Returns all repetitions of Practitioner ID Numbers (PRA-6).

    • getPra6_PractitionerIDNumbers

      public CM_PLN[] getPra6_PractitionerIDNumbers()
      Returns all repetitions of Practitioner ID Numbers (PRA-6).

    • getPractitionerIDNumbersReps

      public int getPractitionerIDNumbersReps()
      Returns a count of the current number of repetitions of Practitioner ID Numbers (PRA-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getPractitionerIDNumbers

      public CM_PLN getPractitionerIDNumbers(int rep)
      Returns a specific repetition of PRA-6: "Practitioner ID Numbers" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPra6_PractitionerIDNumbers

      public CM_PLN getPra6_PractitionerIDNumbers(int rep)
      Returns a specific repetition of PRA-6: "Practitioner ID Numbers" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPra6_PractitionerIDNumbersReps

      public int getPra6_PractitionerIDNumbersReps()
      Returns a count of the current number of repetitions of Practitioner ID Numbers (PRA-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertPractitionerIDNumbers

      public CM_PLN insertPractitionerIDNumbers(int rep) throws HL7Exception
      Inserts a repetition of PRA-6: "Practitioner ID Numbers" 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)

    • insertPra6_PractitionerIDNumbers

      public CM_PLN insertPra6_PractitionerIDNumbers(int rep) throws HL7Exception
      Inserts a repetition of PRA-6: "Practitioner ID Numbers" 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)

    • removePractitionerIDNumbers

      public CM_PLN removePractitionerIDNumbers(int rep) throws HL7Exception
      Removes a repetition of PRA-6: "Practitioner ID Numbers" 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)

    • removePra6_PractitionerIDNumbers

      public CM_PLN removePra6_PractitionerIDNumbers(int rep) throws HL7Exception
      Removes a repetition of PRA-6: "Practitioner ID Numbers" 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)

    • getPrivileges

      public CM_PIP[] getPrivileges()
      Returns all repetitions of Privileges (PRA-7).

    • getPra7_Privileges

      public CM_PIP[] getPra7_Privileges()
      Returns all repetitions of Privileges (PRA-7).

    • getPrivilegesReps

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

    • getPrivileges

      public CM_PIP getPrivileges(int rep)
      Returns a specific repetition of PRA-7: "Privileges" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPra7_Privileges

      public CM_PIP getPra7_Privileges(int rep)
      Returns a specific repetition of PRA-7: "Privileges" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPra7_PrivilegesReps

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

    • insertPrivileges

      public CM_PIP insertPrivileges(int rep) throws HL7Exception
      Inserts a repetition of PRA-7: "Privileges" 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)

    • insertPra7_Privileges

      public CM_PIP insertPra7_Privileges(int rep) throws HL7Exception
      Inserts a repetition of PRA-7: "Privileges" 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)

    • removePrivileges

      public CM_PIP removePrivileges(int rep) throws HL7Exception
      Removes a repetition of PRA-7: "Privileges" 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)

    • removePra7_Privileges

      public CM_PIP removePra7_Privileges(int rep) throws HL7Exception
      Removes a repetition of PRA-7: "Privileges" 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)

    • createNewTypeWithoutReflection

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