Package ca.uhn.hl7v2.model.v24.datatype

Class CN

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

Represents an HL7 CN (composite ID number and name) 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)
See Also:

  • Constructor Details

    • CN

      public CN(Message message)
      Creates a new CN 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 (ST) (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getCn1_IDNumber

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

    • getCn2_FamilyName

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

    • getCn3_GivenName

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

    • getCn4_SecondAndFurtherGivenNamesOrInitialsThereof

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

    • getCn5_SuffixEgJRorIII

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

    • getCn6_PrefixEgDR

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

    • getCn7_DegreeEgMD

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

    • getCn8_SourceTable

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

    • getCn9_AssigningAuthority

      public HD getCn9_AssigningAuthority()
      Returns assigning authority (component 9). This is a convenience method that saves you from casting and handling an exception.