Package com.ibm.fhir.model.type

Class Annotation.Builder

    • Method Detail

      • id

        public Annotation.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 Annotation.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 Annotation.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

      • author

        public Annotation.Builder author​(Element author)
        The individual responsible for making the annotation.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        • Practitioner
        • Patient
        • RelatedPerson
        • Organization
        Parameters:
        author - Individual responsible for the annotation
        Returns:
        A reference to this Builder instance

      • time

        public Annotation.Builder time​(DateTime time)
        Indicates when this particular annotation was made.
        Parameters:
        time - When the annotation was made
        Returns:
        A reference to this Builder instance

      • text

        public Annotation.Builder text​(Markdown text)
        The text of the annotation in markdown format.

        This element is required.

        Parameters:
        text - The annotation - text content (as markdown)
        Returns:
        A reference to this Builder instance