Class CodeableConceptDt

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.dstu2.composite.CodeableConceptDt
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeDatatype, ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IDatatype, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType
Direct Known Subclasses:
BoundCodeableConceptDt

public class CodeableConceptDt
extends ca.uhn.fhir.model.api.BaseIdentifiableElement
implements ca.uhn.fhir.model.api.ICompositeDatatype
HAPI/FHIR CodeableConceptDt Datatype ()

Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text

Requirements: This is a common pattern in healthcare - a concept that may be defined by one or more codes from formal definitions including LOINC and SNOMED CT, and/or defined by the provision of text that captures a human sense of the concept

See Also:
Serialized Form
  • Constructor Summary

    Constructors
    Constructor Description
    CodeableConceptDt()
    Constructor
    CodeableConceptDt​(String theSystem, String theCode)
    Constructor which creates a CodeableConceptDt with one coding repetition, containing the given system and code
  • Method Summary

    Modifier and Type Method Description
    CodingDt addCoding()
    Adds and returns a new value for coding ()
    CodeableConceptDt addCoding​(CodingDt theValue)
    Adds a given new value for coding ()
    <T extends ca.uhn.fhir.model.api.IElement>
    List<T>
    getAllPopulatedChildElementsOfType​(Class<T> theType)  
    List<CodingDt> getCoding()
    Gets the value(s) for coding ().
    CodingDt getCodingFirstRep()
    Gets the first repetition for coding (), creating it if it does not already exist.
    String getText()
    Gets the value(s) for text ().
    ca.uhn.fhir.model.primitive.StringDt getTextElement()
    Gets the value(s) for text ().
    boolean isEmpty()  
    CodeableConceptDt setCoding​(List<CodingDt> theValue)
    Sets the value(s) for coding ()
    CodeableConceptDt setText​(ca.uhn.fhir.model.primitive.StringDt theValue)
    Sets the value(s) for text ()
    CodeableConceptDt setText​(String theString)
    Sets the value for text ()

    Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

    getElementSpecificId, getId, setElementSpecificId, setId, setId

    Methods inherited from class ca.uhn.fhir.model.api.BaseElement

    addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, isBaseEmpty, setUserData

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

    fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
  • Constructor Details

    • CodeableConceptDt

      Constructor
    • CodeableConceptDt

      public CodeableConceptDt​(String theSystem, String theCode)
      Constructor which creates a CodeableConceptDt with one coding repetition, containing the given system and code
  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getCoding

      public List<CodingDt> getCoding()
      Gets the value(s) for coding (). creating it if it does not exist. Will not return null.

      Definition: A reference to a code defined by a terminology system

    • setCoding

      public CodeableConceptDt setCoding​(List<CodingDt> theValue)
      Sets the value(s) for coding ()

      Definition: A reference to a code defined by a terminology system

    • addCoding

      public CodingDt addCoding()
      Adds and returns a new value for coding ()

      Definition: A reference to a code defined by a terminology system

    • addCoding

      public CodeableConceptDt addCoding​(CodingDt theValue)
      Adds a given new value for coding ()

      Definition: A reference to a code defined by a terminology system

      Parameters:
      theValue - The coding to add (must not be null)
    • getCodingFirstRep

      Gets the first repetition for coding (), creating it if it does not already exist.

      Definition: A reference to a code defined by a terminology system

    • getTextElement

      public ca.uhn.fhir.model.primitive.StringDt getTextElement()
      Gets the value(s) for text (). creating it if it does not exist. Will not return null.

      Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user

    • getText

      public String getText()
      Gets the value(s) for text (). creating it if it does not exist. This method may return null.

      Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user

    • setText

      public CodeableConceptDt setText​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for text ()

      Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user

    • setText

      public CodeableConceptDt setText​(String theString)
      Sets the value for text ()

      Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user