Class Coding.Builder

    • Method Detail

      • id

        public Coding.Builder id​(String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class Element.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance
      • extension

        public Coding.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list

        Overrides:
        extension in class Element.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
      • extension

        public Coding.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        extension in class Element.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
      • system

        public Coding.Builder system​(Uri system)
        The identification of the code system that defines the meaning of the symbol in the code.
        Parameters:
        system - Identity of the terminology system
        Returns:
        A reference to this Builder instance
      • version

        public Coding.Builder version​(String 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.
        Parameters:
        version - Version of the system - if relevant
        Returns:
        A reference to this Builder instance
      • code

        public Coding.Builder code​(Code 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).
        Parameters:
        code - Symbol in syntax defined by the system
        Returns:
        A reference to this Builder instance
      • display

        public Coding.Builder display​(String display)
        A representation of the meaning of the code in the system, following the rules of the system.
        Parameters:
        display - Representation defined by the system
        Returns:
        A reference to this Builder instance
      • userSelected

        public Coding.Builder userSelected​(Boolean userSelected)
        Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
        Parameters:
        userSelected - If this coding was chosen directly by the user
        Returns:
        A reference to this Builder instance