Package org.hl7.v3

Class CD

java.lang.Object
org.hl7.v3.ANY
org.hl7.v3.CD
Direct Known Subclasses:
BXITCD, CE, SXCMCD
public class CD extends ANY
A concept descriptor represents any kind of concept usually by giving a code defined in a code system. A concept descriptor can contain the original text or phrase that served as the basis of the coding and one or more translations into different coding systems. A concept descriptor can also contain qualifiers to describe, e.g., the concept of a "left foot" as a postcoordinated term built from the primary code "FOOT" and the qualifier "LEFT". In exceptional cases, the concept descriptor need not contain a code but only the original text describing that concept.

Java class for CD complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="CD">
   <complexContent>
     <extension base="{urn:hl7-org:v3}ANY">
       <sequence>
         <element name="originalText" type="{urn:hl7-org:v3}ED" minOccurs="0"/>
         <element name="qualifier" type="{urn:hl7-org:v3}CR" maxOccurs="unbounded" minOccurs="0"/>
         <element name="translation" type="{urn:hl7-org:v3}CD" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="code" type="{urn:hl7-org:v3}cs" />
       <attribute name="codeSystem" type="{urn:hl7-org:v3}uid" />
       <attribute name="codeSystemName" type="{urn:hl7-org:v3}st" />
       <attribute name="codeSystemVersion" type="{urn:hl7-org:v3}st" />
       <attribute name="displayName" type="{urn:hl7-org:v3}st" />
     </extension>
   </complexContent>
 </complexType>

  • Field Details

    • originalText

      protected ED originalText

    • qualifier

      protected List<CR> qualifier

    • translation

      protected List<CD> translation

    • code

      protected String code

    • codeSystem

      protected String codeSystem

    • codeSystemName

      protected String codeSystemName

    • codeSystemVersion

      protected String codeSystemVersion

    • displayName

      protected String displayName

  • Constructor Details

    • CD

      public CD()

  • Method Details

    • getOriginalText

      public ED getOriginalText()
      Gets the value of the originalText property.
      Returns:
      possible object is ED

    • setOriginalText

      public void setOriginalText(ED value)
      Sets the value of the originalText property.
      Parameters:
      value - allowed object is ED

    • getQualifier

      public List<CR> getQualifier()
      Gets the value of the qualifier property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the qualifier property.

      For example, to add a new item, do as follows: 

          getQualifier().add(newItem);

      Objects of the following type(s) are allowed in the list CR

    • getTranslation

      public List<CD> getTranslation()
      Gets the value of the translation property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the translation property.

      For example, to add a new item, do as follows: 

          getTranslation().add(newItem);

      Objects of the following type(s) are allowed in the list CD

    • getCode

      public String getCode()
      Gets the value of the code property.
      Returns:
      possible object is String

    • setCode

      public void setCode(String value)
      Sets the value of the code property.
      Parameters:
      value - allowed object is String

    • getCodeSystem

      public String getCodeSystem()
      Gets the value of the codeSystem property.
      Returns:
      possible object is String

    • setCodeSystem

      public void setCodeSystem(String value)
      Sets the value of the codeSystem property.
      Parameters:
      value - allowed object is String

    • getCodeSystemName

      public String getCodeSystemName()
      Gets the value of the codeSystemName property.
      Returns:
      possible object is String

    • setCodeSystemName

      public void setCodeSystemName(String value)
      Sets the value of the codeSystemName property.
      Parameters:
      value - allowed object is String

    • getCodeSystemVersion

      public String getCodeSystemVersion()
      Gets the value of the codeSystemVersion property.
      Returns:
      possible object is String

    • setCodeSystemVersion

      public void setCodeSystemVersion(String value)
      Sets the value of the codeSystemVersion property.
      Parameters:
      value - allowed object is String

    • getDisplayName

      public String getDisplayName()
      Gets the value of the displayName property.
      Returns:
      possible object is String

    • setDisplayName

      public void setDisplayName(String value)
      Sets the value of the displayName property.
      Parameters:
      value - allowed object is String

    • withOriginalText

      public CD withOriginalText(ED value)

    • withQualifier

      public CD withQualifier(CR... values)

    • withQualifier

      public CD withQualifier(Collection<CR> values)

    • withTranslation

      public CD withTranslation(CD... values)

    • withTranslation

      public CD withTranslation(Collection<CD> values)

    • withCode

      public CD withCode(String value)

    • withCodeSystem

      public CD withCodeSystem(String value)

    • withCodeSystemName

      public CD withCodeSystemName(String value)

    • withCodeSystemVersion

      public CD withCodeSystemVersion(String value)

    • withDisplayName

      public CD withDisplayName(String value)

    • withNullFlavor

      public CD withNullFlavor(String... values)
      Overrides:
      withNullFlavor in class ANY

    • withNullFlavor

      public CD withNullFlavor(Collection<String> values)
      Overrides:
      withNullFlavor in class ANY

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class ANY

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class ANY

    • toString

      public String toString()
      Generates a String representation of the contents of this type. This is an extension method, produced by the 'ts' xjc plugin
      Overrides:
      toString in class ANY