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

Class CX

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

Represents an HL7 CX (Extended Composite ID with Check Digit) data type. This type consists of the following components:

  • ID Number (ST)
  • Check Digit (ST)
  • Check Digit Scheme (ID)
  • Assigning Authority (HD)
  • Identifier Type Code (ID)
  • Assigning Facility (HD)
  • Effective Date (DT)
  • Expiration Date (DT)
  • Assigning Jurisdiction (CWE)
  • Assigning Agency or Department (CWE)
See Also:

  • Constructor Details

    • CX

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

    • getCx1_IDNumber

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

    • getCheckDigit

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

    • getCx2_CheckDigit

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

    • getCheckDigitScheme

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

    • getCx3_CheckDigitScheme

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

    • getAssigningAuthority

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

    • getCx4_AssigningAuthority

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

    • getIdentifierTypeCode

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

    • getCx5_IdentifierTypeCode

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

    • getAssigningFacility

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

    • getCx6_AssigningFacility

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

    • getEffectiveDate

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

    • getCx7_EffectiveDate

      public DT getCx7_EffectiveDate()
      Returns Effective Date (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getExpirationDate

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

    • getCx8_ExpirationDate

      public DT getCx8_ExpirationDate()
      Returns Expiration Date (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getAssigningJurisdiction

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

    • getCx9_AssigningJurisdiction

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

    • getAssigningAgencyOrDepartment

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

    • getCx10_AssigningAgencyOrDepartment

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