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

Class XCN

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

Represents an HL7 XCN (Extended Composite ID Number and Name for Persons) 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)
  • 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

    • XCN

      public XCN(Message message)
      Creates a new XCN 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.

    • getXcn1_IDNumber

      public ST getXcn1_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.

    • getXcn2_FamilyName

      public FN getXcn2_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.

    • getXcn3_GivenName

      public ST getXcn3_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.

    • getXcn4_SecondAndFurtherGivenNamesOrInitialsThereof

      public ST getXcn4_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.

    • getXcn5_SuffixEgJRorIII

      public ST getXcn5_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.

    • getXcn6_PrefixEgDR

      public ST getXcn6_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.

    • getXcn7_DegreeEgMD

      public IS getXcn7_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.

    • getXcn8_SourceTable

      public IS getXcn8_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.

    • getXcn9_AssigningAuthority

      public HD getXcn9_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.

    • getXcn10_NameTypeCode

      public ID getXcn10_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.

    • getXcn11_IdentifierCheckDigit

      public ST getXcn11_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.

    • getXcn12_CheckDigitScheme

      public ID getXcn12_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.

    • getXcn13_IdentifierTypeCode

      public ID getXcn13_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.

    • getXcn14_AssigningFacility

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

    • getNameRepresentationCode

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

    • getXcn15_NameRepresentationCode

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

    • getNameContext

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

    • getXcn16_NameContext

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

    • getNameValidityRange

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

    • getXcn17_NameValidityRange

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

    • getNameAssemblyOrder

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

    • getXcn18_NameAssemblyOrder

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

    • getEffectiveDate

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

    • getXcn19_EffectiveDate

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

    • getExpirationDate

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

    • getXcn20_ExpirationDate

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

    • getProfessionalSuffix

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

    • getXcn21_ProfessionalSuffix

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

    • getAssigningJurisdiction

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

    • getXcn22_AssigningJurisdiction

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

    • getAssigningAgencyOrDepartment

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

    • getXcn23_AssigningAgencyOrDepartment

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