ca.uhn.hl7v2.model.v24.datatype
Class PPN

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.v24.datatype.PPN

All Implemented Interfaces:

Composite, Type, Serializable

public class PPN
extends AbstractType
implements Composite

Represents an HL7 PPN (performing person time stamp) data type. This type consists of the following components:

• ID number (ST) (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)
• code identifying the check digit scheme employed (ID)
• identifier type code (IS) (IS)
• assigning facility (HD)
• Date/Time Action Performed (TS)
• Name Representation code (ID)
• name context (CE)
• name validity range (DR)
• name assembly order (ID)

See Also:

Serialized Form

Constructor Summary

PPN(Message message)
Creates a new PPN type

Method Summary

HD	getAssigningAuthority() Returns assigning authority (component #9).
HD	getAssigningFacility() Returns assigning facility (component #14).
ID	getCodeIdentifyingTheCheckDigitSchemeEmployed() Returns code identifying the check digit scheme employed (component #12).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
TS	getDateTimeActionPerformed() Returns Date/Time Action Performed (component #15).
IS	getDegreeEgMD() Returns degree (e.g., MD) (component #7).
FN	getFamilyName() Returns family name (component #2).
ST	getGivenName() Returns given name (component #3).
ST	getIdentifierCheckDigit() Returns identifier check digit (component #11).
IS	getIdentifierTypeCode() Returns identifier type code (IS) (component #13).
ST	getIDNumber() Returns ID number (ST) (component #1).
ID	getNameAssemblyOrder() Returns name assembly order (component #19).
CE	getNameContext() Returns name context (component #17).
ID	getNameRepresentationCode() Returns Name Representation code (component #16).
ID	getNameTypeCode() Returns name type code (component #10).
DR	getNameValidityRange() Returns name validity range (component #18).
ST	getPpn1_IDNumber() Returns ID number (ST) (component #1).
ID	getPpn10_NameTypeCode() Returns name type code (component #10).
ST	getPpn11_IdentifierCheckDigit() Returns identifier check digit (component #11).
ID	getPpn12_CodeIdentifyingTheCheckDigitSchemeEmployed() Returns code identifying the check digit scheme employed (component #12).
IS	getPpn13_IdentifierTypeCode() Returns identifier type code (IS) (component #13).
HD	getPpn14_AssigningFacility() Returns assigning facility (component #14).
TS	getPpn15_DateTimeActionPerformed() Returns Date/Time Action Performed (component #15).
ID	getPpn16_NameRepresentationCode() Returns Name Representation code (component #16).
CE	getPpn17_NameContext() Returns name context (component #17).
DR	getPpn18_NameValidityRange() Returns name validity range (component #18).
ID	getPpn19_NameAssemblyOrder() Returns name assembly order (component #19).
FN	getPpn2_FamilyName() Returns family name (component #2).
ST	getPpn3_GivenName() Returns given name (component #3).
ST	getPpn4_SecondAndFurtherGivenNamesOrInitialsThereof() Returns second and further given names or initials thereof (component #4).
ST	getPpn5_SuffixEgJRorIII() Returns suffix (e.g., JR or III) (component #5).
ST	getPpn6_PrefixEgDR() Returns prefix (e.g., DR) (component #6).
IS	getPpn7_DegreeEgMD() Returns degree (e.g., MD) (component #7).
IS	getPpn8_SourceTable() Returns source table (component #8).
HD	getPpn9_AssigningAuthority() Returns assigning authority (component #9).
ST	getPrefixEgDR() Returns prefix (e.g., DR) (component #6).
ST	getSecondAndFurtherGivenNamesOrInitialsThereof() Returns second and further given names or initials thereof (component #4).
IS	getSourceTable() Returns source table (component #8).
ST	getSuffixEgJRorIII() Returns suffix (e.g., JR or III) (component #5).

Methods inherited from class ca.uhn.hl7v2.model.AbstractType

clear, encode, getExtraComponents, getMessage, getName, parse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Type

clear, encode, getExtraComponents, getMessage, getName, parse

Constructor Detail

PPN

public PPN(Message message)

Creates a new PPN type

Method Detail

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

Specified by:

getComponents in interface Composite

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Specified by:

getComponent in interface Composite

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

getCodeIdentifyingTheCheckDigitSchemeEmployed

public ID getCodeIdentifyingTheCheckDigitSchemeEmployed()

Returns code identifying the check digit scheme employed (component #12). This is a convenience method that saves you from casting and handling an exception.

getPpn12_CodeIdentifyingTheCheckDigitSchemeEmployed

public ID getPpn12_CodeIdentifyingTheCheckDigitSchemeEmployed()

Returns code identifying the check digit scheme employed (component #12). This is a convenience method that saves you from casting and handling an exception.

getIdentifierTypeCode

public IS getIdentifierTypeCode()

Returns identifier type code (IS) (component #13). This is a convenience method that saves you from casting and handling an exception.

getPpn13_IdentifierTypeCode

public IS getPpn13_IdentifierTypeCode()

Returns identifier type code (IS) (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.