Class InternalCodingDt

All Implemented Interfaces:
ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, IQueryParameterType, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseDatatype, ICompositeType

public class InternalCodingDt extends BaseCodingDt implements ICompositeDatatype
See Also:
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface IBase
    • getAllPopulatedChildElementsOfType

      @Deprecated public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Deprecated.
      Description copied from interface: ICompositeElement
      Returns a list containing all child elements matching a given type
      Specified by:
      getAllPopulatedChildElementsOfType in interface ICompositeElement
      Parameters:
      theType - The type to match. If set to null, all child elements will be returned
    • getSystemElement

      Gets the value(s) for system (Identity of the terminology system). creating it if it does not exist. Will not return null.

      Definition: The identification of the code system that defines the meaning of the symbol in the code.

      Specified by:
      getSystemElement in class BaseCodingDt
    • setSystem

      public InternalCodingDt setSystem(UriDt theValue)
      Sets the value(s) for system (Identity of the terminology system)

      Definition: The identification of the code system that defines the meaning of the symbol in the code.

    • setSystem

      Sets the value for system (Identity of the terminology system)

      Definition: The identification of the code system that defines the meaning of the symbol in the code.

      Specified by:
      setSystem in class BaseCodingDt
    • getVersionElement

      Gets the value(s) for version (Version of the system - if relevant). creating it if it does not exist. Will not return null.

      Definition: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged

      Specified by:
      getVersionElement in class BaseCodingDt
    • getUserSelectedElement

      Specified by:
      getUserSelectedElement in class BaseCodingDt
    • getVersion

      @Deprecated(since="7.0.0") public StringDt getVersion()
      Deprecated.
      Legacy name for getVersionElement()
    • setVersion

      Sets the value(s) for version (Version of the system - if relevant)

      Definition: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged

    • setVersion

      public InternalCodingDt setVersion(String theString)
      Sets the value for version (Version of the system - if relevant)

      Definition: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged

    • getCodeElement

      Gets the value(s) for code (Symbol in syntax defined by the system). creating it if it does not exist. Will not return null.

      Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)

      Specified by:
      getCodeElement in class BaseCodingDt
    • setCode

      public InternalCodingDt setCode(CodeDt theValue)
      Sets the value(s) for code (Symbol in syntax defined by the system)

      Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)

    • setCode

      public InternalCodingDt setCode(String theCode)
      Sets the value for code (Symbol in syntax defined by the system)

      Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)

      Specified by:
      setCode in class BaseCodingDt
    • getDisplay

      public StringDt getDisplay()
      Gets the value(s) for display (Representation defined by the system). creating it if it does not exist. Will not return null.

      Definition: A representation of the meaning of the code in the system, following the rules of the system.

    • setDisplay

      Sets the value(s) for display (Representation defined by the system)

      Definition: A representation of the meaning of the code in the system, following the rules of the system.

    • setDisplay

      public InternalCodingDt setDisplay(String theString)
      Sets the value for display (Representation defined by the system)

      Definition: A representation of the meaning of the code in the system, following the rules of the system.

      Specified by:
      setDisplay in class BaseCodingDt
    • getPrimary

      Gets the value(s) for primary (If this code was chosen directly by the user). creating it if it does not exist. Will not return null.

      Definition: Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)

    • setPrimary

      Sets the value(s) for primary (If this code was chosen directly by the user)

      Definition: Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)

    • setPrimary

      public InternalCodingDt setPrimary(boolean theBoolean)
      Sets the value for primary (If this code was chosen directly by the user)

      Definition: Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)

    • getValueSet

      Gets the value(s) for valueSet (Set this coding was chosen from). creating it if it does not exist. Will not return null.

      Definition: The set of possible coded values this coding was chosen from or constrained by

    • getDisplayElement

      Description copied from class: BaseCodingDt
      Gets the value(s) for display (Representation defined by the system). creating it if it does not exist. Will not return null.

      Definition: A representation of the meaning of the code in the system, following the rules of the system.

      Specified by:
      getDisplayElement in class BaseCodingDt
    • getMissing

      Deprecated.
      Description copied from class: BaseCodingDt
      Not supported!
      Specified by:
      getMissing in interface IQueryParameterType
      Overrides:
      getMissing in class BaseCodingDt
    • setMissing

      Deprecated.
      Description copied from class: BaseCodingDt
      Not supported!
      Specified by:
      setMissing in interface IQueryParameterType
      Overrides:
      setMissing in class BaseCodingDt
      Returns:
      Returns a reference to this for easier method chaining