Package org.linuxforhealth.fhir.model.resource

Class Evidence.Builder

    • Method Detail

      • id

        public Evidence.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public Evidence.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public Evidence.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • language

        public Evidence.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public Evidence.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public Evidence.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public Evidence.Builder contained​(java.util.Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        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:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public Evidence.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. 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 DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public Evidence.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. 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 DomainResource.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 Evidence.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Evidence.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • url

        public Evidence.Builder url​(Uri url)
        An absolute URI that is used to identify this evidence when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.
        Parameters:
        url - Canonical identifier for this evidence, represented as a globally unique URI
        Returns:
        A reference to this Builder instance

      • identifier

        public Evidence.Builder identifier​(Identifier... identifier)
        A formal identifier that is used to identify this summary 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 - Additional identifier for the summary
        Returns:
        A reference to this Builder instance

      • identifier

        public Evidence.Builder identifier​(java.util.Collection<Identifier> identifier)
        A formal identifier that is used to identify this summary 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 - Additional identifier for the summary
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • version

        public Evidence.Builder version​(String version)
        The identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
        Parameters:
        version - Business version of this summary
        Returns:
        A reference to this Builder instance

      • title

        public Evidence.Builder title​(String title)
        A short, descriptive, user-friendly title for the summary.
        Parameters:
        title - Name for this summary (human friendly)
        Returns:
        A reference to this Builder instance

      • citeAs

        public Evidence.Builder citeAs​(Element citeAs)
        Citation Resource or display of suggested citation for this evidence.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        Parameters:
        citeAs - Citation for this evidence
        Returns:
        A reference to this Builder instance

      • status

        public Evidence.Builder status​(PublicationStatus status)
        The status of this summary. Enables tracking the life-cycle of the content.

        This element is required.

        Parameters:
        status - draft | active | retired | unknown
        Returns:
        A reference to this Builder instance

      • date

        public Evidence.Builder date​(DateTime date)
        The date (and optionally time) when the summary was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the summary changes.
        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • useContext

        public Evidence.Builder useContext​(UsageContext... useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence instances.

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

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance

      • useContext

        public Evidence.Builder useContext​(java.util.Collection<UsageContext> useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence instances.

        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:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • approvalDate

        public Evidence.Builder approvalDate​(Date approvalDate)
        The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        Parameters:
        approvalDate - When the summary was approved by publisher
        Returns:
        A reference to this Builder instance

      • lastReviewDate

        public Evidence.Builder lastReviewDate​(Date lastReviewDate)
        The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
        Parameters:
        lastReviewDate - When the summary was last reviewed
        Returns:
        A reference to this Builder instance

      • publisher

        public Evidence.Builder publisher​(String publisher)
        The name of the organization or individual that published the evidence.
        Parameters:
        publisher - Name of the publisher (organization or individual)
        Returns:
        A reference to this Builder instance

      • contact

        public Evidence.Builder contact​(ContactDetail... contact)
        Contact details to assist a user in finding and communicating with the publisher.

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

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance

      • contact

        public Evidence.Builder contact​(java.util.Collection<ContactDetail> contact)
        Contact details to assist a user in finding and communicating with the publisher.

        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:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • author

        public Evidence.Builder author​(ContactDetail... author)
        An individiual, organization, or device primarily involved in the creation and maintenance of the content.

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

        Parameters:
        author - Who authored the content
        Returns:
        A reference to this Builder instance

      • author

        public Evidence.Builder author​(java.util.Collection<ContactDetail> author)
        An individiual, organization, or device primarily involved in the creation and maintenance of the content.

        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:
        author - Who authored the content
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • editor

        public Evidence.Builder editor​(ContactDetail... editor)
        An individiual, organization, or device primarily responsible for internal coherence of the content.

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

        Parameters:
        editor - Who edited the content
        Returns:
        A reference to this Builder instance

      • editor

        public Evidence.Builder editor​(java.util.Collection<ContactDetail> editor)
        An individiual, organization, or device primarily responsible for internal coherence of the content.

        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:
        editor - Who edited the content
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • reviewer

        public Evidence.Builder reviewer​(ContactDetail... reviewer)
        An individiual, organization, or device primarily responsible for review of some aspect of the content.

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

        Parameters:
        reviewer - Who reviewed the content
        Returns:
        A reference to this Builder instance

      • reviewer

        public Evidence.Builder reviewer​(java.util.Collection<ContactDetail> reviewer)
        An individiual, organization, or device primarily responsible for review of some aspect of the content.

        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:
        reviewer - Who reviewed the content
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • endorser

        public Evidence.Builder endorser​(ContactDetail... endorser)
        An individiual, organization, or device responsible for officially endorsing the content for use in some setting.

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

        Parameters:
        endorser - Who endorsed the content
        Returns:
        A reference to this Builder instance

      • endorser

        public Evidence.Builder endorser​(java.util.Collection<ContactDetail> endorser)
        An individiual, organization, or device responsible for officially endorsing the content for use in some setting.

        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:
        endorser - Who endorsed the content
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • relatedArtifact

        public Evidence.Builder relatedArtifact​(RelatedArtifact... relatedArtifact)
        Link or citation to artifact associated with the summary.

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

        Parameters:
        relatedArtifact - Link or citation to artifact associated with the summary
        Returns:
        A reference to this Builder instance

      • relatedArtifact

        public Evidence.Builder relatedArtifact​(java.util.Collection<RelatedArtifact> relatedArtifact)
        Link or citation to artifact associated with the summary.

        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:
        relatedArtifact - Link or citation to artifact associated with the summary
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public Evidence.Builder description​(Markdown description)
        A free text natural language description of the evidence from a consumer's perspective.
        Parameters:
        description - Description of the particular summary
        Returns:
        A reference to this Builder instance

      • assertion

        public Evidence.Builder assertion​(Markdown assertion)
        Declarative description of the Evidence.
        Parameters:
        assertion - Declarative description of the Evidence
        Returns:
        A reference to this Builder instance

      • note

        public Evidence.Builder note​(Annotation... note)
        Footnotes and/or explanatory notes.

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

        Parameters:
        note - Footnotes and/or explanatory notes
        Returns:
        A reference to this Builder instance

      • note

        public Evidence.Builder note​(java.util.Collection<Annotation> note)
        Footnotes and/or explanatory notes.

        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 - Footnotes and/or explanatory notes
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • variableDefinition

        public Evidence.Builder variableDefinition​(Evidence.VariableDefinition... variableDefinition)
        Evidence variable such as population, exposure, or outcome.

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

        This element is required.

        Parameters:
        variableDefinition - Evidence variable such as population, exposure, or outcome
        Returns:
        A reference to this Builder instance

      • variableDefinition

        public Evidence.Builder variableDefinition​(java.util.Collection<Evidence.VariableDefinition> variableDefinition)
        Evidence variable such as population, exposure, or outcome.

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

        This element is required.

        Parameters:
        variableDefinition - Evidence variable such as population, exposure, or outcome
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • synthesisType

        public Evidence.Builder synthesisType​(CodeableConcept synthesisType)
        The method to combine studies.
        Parameters:
        synthesisType - The method to combine studies
        Returns:
        A reference to this Builder instance

      • studyType

        public Evidence.Builder studyType​(CodeableConcept studyType)
        The type of study that produced this evidence.
        Parameters:
        studyType - The type of study that produced this evidence
        Returns:
        A reference to this Builder instance

      • statistic

        public Evidence.Builder statistic​(Evidence.Statistic... statistic)
        Values and parameters for a single statistic.

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

        Parameters:
        statistic - Values and parameters for a single statistic
        Returns:
        A reference to this Builder instance

      • statistic

        public Evidence.Builder statistic​(java.util.Collection<Evidence.Statistic> statistic)
        Values and parameters for a single statistic.

        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:
        statistic - Values and parameters for a single statistic
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • certainty

        public Evidence.Builder certainty​(Evidence.Certainty... certainty)
        Assessment of certainty, confidence in the estimates, or quality of the evidence.

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

        Parameters:
        certainty - Certainty or quality of the evidence
        Returns:
        A reference to this Builder instance

      • certainty

        public Evidence.Builder certainty​(java.util.Collection<Evidence.Certainty> certainty)
        Assessment of certainty, confidence in the estimates, or quality of the evidence.

        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:
        certainty - Certainty or quality of the evidence
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • build

        public Evidence build()
        Build the Evidence

        Required elements:

        • status
        • variableDefinition
        Specified by:
        build in interface Builder<Resource>
        Specified by:
        build in class DomainResource.Builder
        Returns:
        An immutable object of type Evidence
        Throws:
        java.lang.IllegalStateException - if the current state cannot be built into a valid Evidence per the base specification

      • validate

        protected void validate​(Evidence evidence)