Package org.hl7.fhir.r5.model

Class Coding

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.DataType
org.hl7.fhir.r5.model.Coding
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseCoding, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType, ICoding
public class Coding extends DataType implements org.hl7.fhir.instance.model.api.IBaseCoding, org.hl7.fhir.instance.model.api.ICompositeType, ICoding
Coding Type: A reference to a code defined by a terminology system.
See Also:

  • Field Details

    • system

      protected UriType system
      The identification of the code system that defines the meaning of the symbol in the code.

    • version

      protected StringType version
      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.

    • code

      protected CodeType code
      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).

    • display

      protected StringType display
      A representation of the meaning of the code in the system, following the rules of the system.

    • userSelected

      protected BooleanType userSelected
      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

  • Constructor Details

  • Method Details

    • getSystemElement

      public UriType getSystemElement()
      Returns:
      system (The identification of the code system that defines the meaning of the symbol in the code.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value

    • hasSystemElement

      public boolean hasSystemElement()

    • hasSystem

      public boolean hasSystem()
      Specified by:
      hasSystem in interface ICoding

    • setSystemElement

      public Coding setSystemElement(UriType value)
      Parameters:
      value - system (The identification of the code system that defines the meaning of the symbol in the code.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value

    • getSystem

      public String getSystem()
      Specified by:
      getSystem in interface org.hl7.fhir.instance.model.api.IBaseCoding
      Specified by:
      getSystem in interface ICoding
      Returns:
      The identification of the code system that defines the meaning of the symbol in the code.

    • setSystem

      public Coding setSystem(String value)
      Specified by:
      setSystem in interface org.hl7.fhir.instance.model.api.IBaseCoding
      Parameters:
      value - The identification of the code system that defines the meaning of the symbol in the code.

    • getVersionElement

      public StringType getVersionElement()
      Returns:
      version (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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

    • hasVersionElement

      public boolean hasVersionElement()

    • hasVersion

      public boolean hasVersion()
      Specified by:
      hasVersion in interface ICoding

    • setVersionElement

      public Coding setVersionElement(StringType value)
      Parameters:
      value - version (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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

    • getVersion

      public String getVersion()
      Specified by:
      getVersion in interface org.hl7.fhir.instance.model.api.IBaseCoding
      Specified by:
      getVersion in interface ICoding
      Returns:
      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 Coding setVersion(String value)
      Specified by:
      setVersion in interface org.hl7.fhir.instance.model.api.IBaseCoding
      Parameters:
      value - 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

      public CodeType getCodeElement()
      Returns:
      code (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).). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

    • hasCodeElement

      public boolean hasCodeElement()

    • hasCode

      public boolean hasCode()
      Specified by:
      hasCode in interface ICoding

    • setCodeElement

      public Coding setCodeElement(CodeType value)
      Parameters:
      value - code (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).). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

    • getCode

      public String getCode()
      Specified by:
      getCode in interface org.hl7.fhir.instance.model.api.IBaseCoding
      Specified by:
      getCode in interface ICoding
      Returns:
      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 Coding setCode(String value)
      Specified by:
      setCode in interface org.hl7.fhir.instance.model.api.IBaseCoding
      Parameters:
      value - 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).

    • getDisplayElement

      public StringType getDisplayElement()
      Returns:
      display (A representation of the meaning of the code in the system, following the rules of the system.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value

    • hasDisplayElement

      public boolean hasDisplayElement()

    • hasDisplay

      public boolean hasDisplay()
      Specified by:
      hasDisplay in interface ICoding

    • setDisplayElement

      public Coding setDisplayElement(StringType value)
      Parameters:
      value - display (A representation of the meaning of the code in the system, following the rules of the system.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value

    • getDisplay

      public String getDisplay()
      Specified by:
      getDisplay in interface org.hl7.fhir.instance.model.api.IBaseCoding
      Specified by:
      getDisplay in interface ICoding
      Returns:
      A representation of the meaning of the code in the system, following the rules of the system.

    • setDisplay

      public Coding setDisplay(String value)
      Specified by:
      setDisplay in interface org.hl7.fhir.instance.model.api.IBaseCoding
      Parameters:
      value - A representation of the meaning of the code in the system, following the rules of the system.

    • getUserSelectedElement

      public BooleanType getUserSelectedElement()
      Returns:
      userSelected (Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).). This is the underlying object with id, value and extensions. The accessor "getUserSelected" gives direct access to the value

    • hasUserSelectedElement

      public boolean hasUserSelectedElement()

    • hasUserSelected

      public boolean hasUserSelected()

    • setUserSelectedElement

      public Coding setUserSelectedElement(BooleanType value)
      Parameters:
      value - userSelected (Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).). This is the underlying object with id, value and extensions. The accessor "getUserSelected" gives direct access to the value

    • getUserSelected

      public boolean getUserSelected()
      Specified by:
      getUserSelected in interface org.hl7.fhir.instance.model.api.IBaseCoding
      Returns:
      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

    • setUserSelected

      public Coding setUserSelected(boolean value)
      Specified by:
      setUserSelected in interface org.hl7.fhir.instance.model.api.IBaseCoding
      Parameters:
      value - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Element

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • removeChild

      public void removeChild(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      removeChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DataType
      Returns:
      the FHIR type name of the instance (not the java class name)

    • copy

      public Coding copy()
      Specified by:
      copy in class DataType

    • copyValues

      public void copyValues(Coding dst)

    • typedCopy

      protected Coding typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Element

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Element

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class Element

    • supportsVersion

      public boolean supportsVersion()
      Specified by:
      supportsVersion in interface ICoding

    • supportsDisplay

      public boolean supportsDisplay()
      Specified by:
      supportsDisplay in interface ICoding

    • is

      public boolean is(String system, String code)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • fromLiteral

      public static Coding fromLiteral(String value)

    • matches

      public boolean matches(Coding other)

    • merge

      public static Coding merge(Coding l, Coding r)

    • intersect

      public static Coding intersect(Coding l, Coding r)

    • getVersionedSystem

      public String getVersionedSystem()