Package com.ibm.fhir.model.type

Class RelatedArtifact.Builder

    • Method Detail

      • id

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

      • type

        public RelatedArtifact.Builder type​(RelatedArtifactType type)
        The type of relationship to the related artifact.

        This element is required.

        Parameters:
        type - documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
        Returns:
        A reference to this Builder instance

      • label

        public RelatedArtifact.Builder label​(String label)
        A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
        Parameters:
        label - Short label
        Returns:
        A reference to this Builder instance

      • display

        public RelatedArtifact.Builder display​(String display)
        A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
        Parameters:
        display - Brief description of the related artifact
        Returns:
        A reference to this Builder instance

      • citation

        public RelatedArtifact.Builder citation​(Markdown citation)
        A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
        Parameters:
        citation - Bibliographic citation for the artifact
        Returns:
        A reference to this Builder instance

      • url

        public RelatedArtifact.Builder url​(Url url)
        A url for the artifact that can be followed to access the actual content.
        Parameters:
        url - Where the artifact can be accessed
        Returns:
        A reference to this Builder instance

      • document

        public RelatedArtifact.Builder document​(Attachment document)
        The document being referenced, represented as an attachment. This is exclusive with the resource element.
        Parameters:
        document - What document is being referenced
        Returns:
        A reference to this Builder instance

      • resource

        public RelatedArtifact.Builder resource​(Canonical resource)
        The related resource, such as a library, value set, profile, or other knowledge resource.
        Parameters:
        resource - What resource is being referenced
        Returns:
        A reference to this Builder instance