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

Class CF

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

Represents an HL7 CF (Coded Element with Formatted Values) data type. This type consists of the following components:

  • Identifier (ST)
  • Formatted Text (FT)
  • Name of Coding System (ID)
  • Alternate Identifier (ST)
  • Alternate Formatted Text (FT)
  • Name of Alternate Coding System (ID)
See Also:

  • Constructor Details

    • CF

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

    • getIdentifier

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

    • getCf1_Identifier

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

    • getFormattedText

      public FT getFormattedText()
      Returns Formatted Text (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getCf2_FormattedText

      public FT getCf2_FormattedText()
      Returns Formatted Text (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getNameOfCodingSystem

      public ID getNameOfCodingSystem()
      Returns Name of Coding System (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getCf3_NameOfCodingSystem

      public ID getCf3_NameOfCodingSystem()
      Returns Name of Coding System (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getAlternateIdentifier

      public ST getAlternateIdentifier()
      Returns Alternate Identifier (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getCf4_AlternateIdentifier

      public ST getCf4_AlternateIdentifier()
      Returns Alternate Identifier (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getAlternateFormattedText

      public FT getAlternateFormattedText()
      Returns Alternate Formatted Text (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getCf5_AlternateFormattedText

      public FT getCf5_AlternateFormattedText()
      Returns Alternate Formatted Text (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getNameOfAlternateCodingSystem

      public ID getNameOfAlternateCodingSystem()
      Returns Name of Alternate Coding System (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getCf6_NameOfAlternateCodingSystem

      public ID getCf6_NameOfAlternateCodingSystem()
      Returns Name of Alternate Coding System (component 6). This is a convenience method that saves you from casting and handling an exception.