Class 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

    public class Coding
    extends Type
    implements org.hl7.fhir.instance.model.api.IBaseCoding, org.hl7.fhir.instance.model.api.ICompositeType
    A reference to a code defined by a terminology system.
    See Also:
    Serialized Form
    • Field Detail

      • 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 - i.e. off a pick list of available items (codes or displays).
    • Method Detail

      • 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
      • 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
        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
      • 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()
        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)
        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
      • hasCode

        public boolean hasCode()
      • 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
        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
      • 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
        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 - i.e. 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
      • setUserSelectedElement

        public Coding setUserSelectedElement​(BooleanType value)
        Parameters:
        value - userSelected (Indicates that this coding was chosen by a user directly - i.e. 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()
        Returns:
        Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
      • setUserSelected

        public Coding setUserSelected​(boolean value)
        Parameters:
        value - Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
      • 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
      • 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 Element
      • isEmpty

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