Package com.ibm.fhir.model.type

Class Coding

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Coding
extends Element
    A reference to a code defined by a terminology system.

    • Method Detail

      • getSystem

        public Uri getSystem()
        The identification of the code system that defines the meaning of the symbol in the code.
        Returns:
        An immutable object of type Uri that may be null.

      • getVersion

        public String getVersion()
        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.
        Returns:
        An immutable object of type String that may be null.

      • getCode

        public Code getCode()
        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).
        Returns:
        An immutable object of type Code that may be null.

      • getDisplay

        public String getDisplay()
        A representation of the meaning of the code in the system, following the rules of the system.
        Returns:
        An immutable object of type String that may be null.

      • getUserSelected

        public Boolean getUserSelected()
        Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
        Returns:
        An immutable object of type Boolean that may be null.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • toBuilder

        public Coding.Builder toBuilder()
        Description copied from class: Element
        Create a new Builder from the contents of this Element
        Specified by:
        toBuilder in class Element