Package org.linuxforhealth.fhir.model.resource

Class Citation.CitedArtifact.Builder

    • Method Detail

      • id

        public Citation.CitedArtifact.Builder id​(java.lang.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 BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public Citation.CitedArtifact.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. If any of the elements are null, calling build() will fail.

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

      • extension

        public Citation.CitedArtifact.Builder extension​(java.util.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. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public Citation.CitedArtifact.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Citation.CitedArtifact.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • identifier

        public Citation.CitedArtifact.Builder identifier​(Identifier... identifier)
        A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - May include DOI, PMID, PMCID, etc.
        Returns:
        A reference to this Builder instance

      • identifier

        public Citation.CitedArtifact.Builder identifier​(java.util.Collection<Identifier> identifier)
        A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - May include DOI, PMID, PMCID, etc.
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • relatedIdentifier

        public Citation.CitedArtifact.Builder relatedIdentifier​(Identifier... relatedIdentifier)
        A formal identifier that is used to identify things closely related to this citation.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        relatedIdentifier - May include trial registry identifiers
        Returns:
        A reference to this Builder instance

      • relatedIdentifier

        public Citation.CitedArtifact.Builder relatedIdentifier​(java.util.Collection<Identifier> relatedIdentifier)
        A formal identifier that is used to identify things closely related to this citation.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        relatedIdentifier - May include trial registry identifiers
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • dateAccessed

        public Citation.CitedArtifact.Builder dateAccessed​(DateTime dateAccessed)
        When the cited artifact was accessed.
        Parameters:
        dateAccessed - When the cited artifact was accessed
        Returns:
        A reference to this Builder instance

      • currentState

        public Citation.CitedArtifact.Builder currentState​(CodeableConcept... currentState)
        The status of the cited artifact.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        currentState - The status of the cited artifact
        Returns:
        A reference to this Builder instance

      • currentState

        public Citation.CitedArtifact.Builder currentState​(java.util.Collection<CodeableConcept> currentState)
        The status of the cited artifact.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        currentState - The status of the cited artifact
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • statusDate

        public Citation.CitedArtifact.Builder statusDate​(Citation.CitedArtifact.StatusDate... statusDate)
        An effective date or period for a status of the cited artifact.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        statusDate - An effective date or period for a status of the cited artifact
        Returns:
        A reference to this Builder instance

      • statusDate

        public Citation.CitedArtifact.Builder statusDate​(java.util.Collection<Citation.CitedArtifact.StatusDate> statusDate)
        An effective date or period for a status of the cited artifact.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        statusDate - An effective date or period for a status of the cited artifact
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • title

        public Citation.CitedArtifact.Builder title​(Citation.CitedArtifact.Title... title)
        The title details of the article or artifact.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        title - The title details of the article or artifact
        Returns:
        A reference to this Builder instance

      • title

        public Citation.CitedArtifact.Builder title​(java.util.Collection<Citation.CitedArtifact.Title> title)
        The title details of the article or artifact.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        title - The title details of the article or artifact
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • _abstract

        public Citation.CitedArtifact.Builder _abstract​(Citation.CitedArtifact.Abstract... _abstract)
        Summary of the article or artifact.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        _abstract - Summary of the article or artifact
        Returns:
        A reference to this Builder instance

      • _abstract

        public Citation.CitedArtifact.Builder _abstract​(java.util.Collection<Citation.CitedArtifact.Abstract> _abstract)
        Summary of the article or artifact.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        _abstract - Summary of the article or artifact
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • relatesTo

        public Citation.CitedArtifact.Builder relatesTo​(Citation.CitedArtifact.RelatesTo... relatesTo)
        The artifact related to the cited artifact.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        relatesTo - The artifact related to the cited artifact
        Returns:
        A reference to this Builder instance

      • relatesTo

        public Citation.CitedArtifact.Builder relatesTo​(java.util.Collection<Citation.CitedArtifact.RelatesTo> relatesTo)
        The artifact related to the cited artifact.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        relatesTo - The artifact related to the cited artifact
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • publicationForm

        public Citation.CitedArtifact.Builder publicationForm​(Citation.CitedArtifact.PublicationForm... publicationForm)
        If multiple, used to represent alternative forms of the article that are not separate citations.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        publicationForm - If multiple, used to represent alternative forms of the article that are not separate citations
        Returns:
        A reference to this Builder instance

      • publicationForm

        public Citation.CitedArtifact.Builder publicationForm​(java.util.Collection<Citation.CitedArtifact.PublicationForm> publicationForm)
        If multiple, used to represent alternative forms of the article that are not separate citations.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        publicationForm - If multiple, used to represent alternative forms of the article that are not separate citations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • webLocation

        public Citation.CitedArtifact.Builder webLocation​(Citation.CitedArtifact.WebLocation... webLocation)
        Used for any URL for the article or artifact cited.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        webLocation - Used for any URL for the article or artifact cited
        Returns:
        A reference to this Builder instance

      • webLocation

        public Citation.CitedArtifact.Builder webLocation​(java.util.Collection<Citation.CitedArtifact.WebLocation> webLocation)
        Used for any URL for the article or artifact cited.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        webLocation - Used for any URL for the article or artifact cited
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • classification

        public Citation.CitedArtifact.Builder classification​(Citation.CitedArtifact.Classification... classification)
        The assignment to an organizing scheme.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        classification - The assignment to an organizing scheme
        Returns:
        A reference to this Builder instance

      • classification

        public Citation.CitedArtifact.Builder classification​(java.util.Collection<Citation.CitedArtifact.Classification> classification)
        The assignment to an organizing scheme.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        classification - The assignment to an organizing scheme
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • contributorship

        public Citation.CitedArtifact.Builder contributorship​(Citation.CitedArtifact.Contributorship contributorship)
        This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements.
        Parameters:
        contributorship - Attribution of authors and other contributors
        Returns:
        A reference to this Builder instance

      • note

        public Citation.CitedArtifact.Builder note​(Annotation... note)
        Any additional information or content for the article or artifact.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        note - Any additional information or content for the article or artifact
        Returns:
        A reference to this Builder instance

      • note

        public Citation.CitedArtifact.Builder note​(java.util.Collection<Annotation> note)
        Any additional information or content for the article or artifact.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        note - Any additional information or content for the article or artifact
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null