Package ca.uhn.hl7v2.model.v251.datatype

Class PPN

java.lang.Object
ca.uhn.hl7v2.model.AbstractType
ca.uhn.hl7v2.model.AbstractComposite
ca.uhn.hl7v2.model.v251.datatype.PPN
All Implemented Interfaces:
Composite, Type, Visitable, Serializable
public class PPN extends AbstractComposite

Represents an HL7 PPN (Performing Person Time Stamp) data type. This type consists of the following components:

  • ID Number (ST)
  • Family Name (FN)
  • Given Name (ST)
  • Second and Further Given Names or Initials Thereof (ST)
  • Suffix (e.g., JR or III) (ST)
  • Prefix (e.g., DR) (ST)
  • Degree (e.g., MD) (IS)
  • Source Table (IS)
  • Assigning Authority (HD)
  • Name Type Code (ID)
  • Identifier Check Digit (ST)
  • Check Digit Scheme (ID)
  • Identifier Type Code (ID)
  • Assigning Facility (HD)
  • Date/Time Action Performed (TS)
  • Name Representation Code (ID)
  • Name Context (CE)
  • Name Validity Range (DR)
  • Name Assembly Order (ID)
  • Effective Date (TS)
  • Expiration Date (TS)
  • Professional Suffix (ST)
  • Assigning Jurisdiction (CWE)
  • Assigning Agency or Department (CWE)
See Also:

  • Constructor Details

    • PPN

      public PPN(Message message)
      Creates a new PPN type

  • Method Details

    • getComponents

      public Type[] getComponents()
      Returns an array containing the data elements.

    • getComponent

      public Type getComponent(int number) throws DataTypeException
      Returns an individual data component.
      Parameters:
      number - The component number (0-indexed)
      Throws:
      DataTypeException - if the given element number is out of range.

    • getIDNumber

      public ST getIDNumber()
      Returns ID Number (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getPpn1_IDNumber

      public ST getPpn1_IDNumber()
      Returns ID Number (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getFamilyName

      public FN getFamilyName()
      Returns Family Name (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getPpn2_FamilyName

      public FN getPpn2_FamilyName()
      Returns Family Name (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getGivenName

      public ST getGivenName()
      Returns Given Name (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getPpn3_GivenName

      public ST getPpn3_GivenName()
      Returns Given Name (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getSecondAndFurtherGivenNamesOrInitialsThereof

      public ST getSecondAndFurtherGivenNamesOrInitialsThereof()
      Returns Second and Further Given Names or Initials Thereof (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getPpn4_SecondAndFurtherGivenNamesOrInitialsThereof

      public ST getPpn4_SecondAndFurtherGivenNamesOrInitialsThereof()
      Returns Second and Further Given Names or Initials Thereof (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getSuffixEgJRorIII

      public ST getSuffixEgJRorIII()
      Returns Suffix (e.g., JR or III) (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getPpn5_SuffixEgJRorIII

      public ST getPpn5_SuffixEgJRorIII()
      Returns Suffix (e.g., JR or III) (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getPrefixEgDR

      public ST getPrefixEgDR()
      Returns Prefix (e.g., DR) (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getPpn6_PrefixEgDR

      public ST getPpn6_PrefixEgDR()
      Returns Prefix (e.g., DR) (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getDegreeEgMD

      public IS getDegreeEgMD()
      Returns Degree (e.g., MD) (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getPpn7_DegreeEgMD

      public IS getPpn7_DegreeEgMD()
      Returns Degree (e.g., MD) (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getSourceTable

      public IS getSourceTable()
      Returns Source Table (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getPpn8_SourceTable

      public IS getPpn8_SourceTable()
      Returns Source Table (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getAssigningAuthority

      public HD getAssigningAuthority()
      Returns Assigning Authority (component 9). This is a convenience method that saves you from casting and handling an exception.

    • getPpn9_AssigningAuthority

      public HD getPpn9_AssigningAuthority()
      Returns Assigning Authority (component 9). This is a convenience method that saves you from casting and handling an exception.

    • getNameTypeCode

      public ID getNameTypeCode()
      Returns Name Type Code (component 10). This is a convenience method that saves you from casting and handling an exception.

    • getPpn10_NameTypeCode

      public ID getPpn10_NameTypeCode()
      Returns Name Type Code (component 10). This is a convenience method that saves you from casting and handling an exception.

    • getIdentifierCheckDigit

      public ST getIdentifierCheckDigit()
      Returns Identifier Check Digit (component 11). This is a convenience method that saves you from casting and handling an exception.

    • getPpn11_IdentifierCheckDigit

      public ST getPpn11_IdentifierCheckDigit()
      Returns Identifier Check Digit (component 11). This is a convenience method that saves you from casting and handling an exception.

    • getCheckDigitScheme

      public ID getCheckDigitScheme()
      Returns Check Digit Scheme (component 12). This is a convenience method that saves you from casting and handling an exception.

    • getPpn12_CheckDigitScheme

      public ID getPpn12_CheckDigitScheme()
      Returns Check Digit Scheme (component 12). This is a convenience method that saves you from casting and handling an exception.

    • getIdentifierTypeCode

      public ID getIdentifierTypeCode()
      Returns Identifier Type Code (component 13). This is a convenience method that saves you from casting and handling an exception.

    • getPpn13_IdentifierTypeCode

      public ID getPpn13_IdentifierTypeCode()
      Returns Identifier Type Code (component 13). This is a convenience method that saves you from casting and handling an exception.

    • getAssigningFacility

      public HD getAssigningFacility()
      Returns Assigning Facility (component 14). This is a convenience method that saves you from casting and handling an exception.

    • getPpn14_AssigningFacility

      public HD getPpn14_AssigningFacility()
      Returns Assigning Facility (component 14). This is a convenience method that saves you from casting and handling an exception.

    • getDateTimeActionPerformed

      public TS getDateTimeActionPerformed()
      Returns Date/Time Action Performed (component 15). This is a convenience method that saves you from casting and handling an exception.

    • getPpn15_DateTimeActionPerformed

      public TS getPpn15_DateTimeActionPerformed()
      Returns Date/Time Action Performed (component 15). This is a convenience method that saves you from casting and handling an exception.

    • getNameRepresentationCode

      public ID getNameRepresentationCode()
      Returns Name Representation Code (component 16). This is a convenience method that saves you from casting and handling an exception.

    • getPpn16_NameRepresentationCode

      public ID getPpn16_NameRepresentationCode()
      Returns Name Representation Code (component 16). This is a convenience method that saves you from casting and handling an exception.

    • getNameContext

      public CE getNameContext()
      Returns Name Context (component 17). This is a convenience method that saves you from casting and handling an exception.

    • getPpn17_NameContext

      public CE getPpn17_NameContext()
      Returns Name Context (component 17). This is a convenience method that saves you from casting and handling an exception.

    • getNameValidityRange

      public DR getNameValidityRange()
      Returns Name Validity Range (component 18). This is a convenience method that saves you from casting and handling an exception.

    • getPpn18_NameValidityRange

      public DR getPpn18_NameValidityRange()
      Returns Name Validity Range (component 18). This is a convenience method that saves you from casting and handling an exception.

    • getNameAssemblyOrder

      public ID getNameAssemblyOrder()
      Returns Name Assembly Order (component 19). This is a convenience method that saves you from casting and handling an exception.

    • getPpn19_NameAssemblyOrder

      public ID getPpn19_NameAssemblyOrder()
      Returns Name Assembly Order (component 19). This is a convenience method that saves you from casting and handling an exception.

    • getEffectiveDate

      public TS getEffectiveDate()
      Returns Effective Date (component 20). This is a convenience method that saves you from casting and handling an exception.

    • getPpn20_EffectiveDate

      public TS getPpn20_EffectiveDate()
      Returns Effective Date (component 20). This is a convenience method that saves you from casting and handling an exception.

    • getExpirationDate

      public TS getExpirationDate()
      Returns Expiration Date (component 21). This is a convenience method that saves you from casting and handling an exception.

    • getPpn21_ExpirationDate

      public TS getPpn21_ExpirationDate()
      Returns Expiration Date (component 21). This is a convenience method that saves you from casting and handling an exception.

    • getProfessionalSuffix

      public ST getProfessionalSuffix()
      Returns Professional Suffix (component 22). This is a convenience method that saves you from casting and handling an exception.

    • getPpn22_ProfessionalSuffix

      public ST getPpn22_ProfessionalSuffix()
      Returns Professional Suffix (component 22). This is a convenience method that saves you from casting and handling an exception.

    • getAssigningJurisdiction

      public CWE getAssigningJurisdiction()
      Returns Assigning Jurisdiction (component 23). This is a convenience method that saves you from casting and handling an exception.

    • getPpn23_AssigningJurisdiction

      public CWE getPpn23_AssigningJurisdiction()
      Returns Assigning Jurisdiction (component 23). This is a convenience method that saves you from casting and handling an exception.

    • getAssigningAgencyOrDepartment

      public CWE getAssigningAgencyOrDepartment()
      Returns Assigning Agency or Department (component 24). This is a convenience method that saves you from casting and handling an exception.

    • getPpn24_AssigningAgencyOrDepartment

      public CWE getPpn24_AssigningAgencyOrDepartment()
      Returns Assigning Agency or Department (component 24). This is a convenience method that saves you from casting and handling an exception.