Package org.linuxforhealth.fhir.model.resource

Class AdverseEvent.Builder

    • Method Detail

      • id

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

      • identifier

        public AdverseEvent.Builder identifier​(Identifier identifier)
        Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        Parameters:
        identifier - Business identifier for the event
        Returns:
        A reference to this Builder instance

      • actuality

        public AdverseEvent.Builder actuality​(AdverseEventActuality actuality)
        Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.

        This element is required.

        Parameters:
        actuality - actual | potential
        Returns:
        A reference to this Builder instance

      • category

        public AdverseEvent.Builder category​(CodeableConcept... category)
        The overall type of event, intended for search and filtering purposes.

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

        Parameters:
        category - product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong- technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device- use-error | problem-different-manufacturer | unsafe-physical-environment
        Returns:
        A reference to this Builder instance

      • category

        public AdverseEvent.Builder category​(java.util.Collection<CodeableConcept> category)
        The overall type of event, intended for search and filtering purposes.

        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:
        category - product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong- technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device- use-error | problem-different-manufacturer | unsafe-physical-environment
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • event

        public AdverseEvent.Builder event​(CodeableConcept event)
        This element defines the specific type of event that occurred or that was prevented from occurring.
        Parameters:
        event - Type of the event itself in relation to the subject
        Returns:
        A reference to this Builder instance

      • encounter

        public AdverseEvent.Builder encounter​(Reference encounter)
        The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.

        Allowed resource types for this reference:

        Parameters:
        encounter - Encounter created as part of
        Returns:
        A reference to this Builder instance

      • date

        public AdverseEvent.Builder date​(DateTime date)
        The date (and perhaps time) when the adverse event occurred.
        Parameters:
        date - When the event occurred
        Returns:
        A reference to this Builder instance

      • detected

        public AdverseEvent.Builder detected​(DateTime detected)
        Estimated or actual date the AdverseEvent began, in the opinion of the reporter.
        Parameters:
        detected - When the event was detected
        Returns:
        A reference to this Builder instance

      • recordedDate

        public AdverseEvent.Builder recordedDate​(DateTime recordedDate)
        The date on which the existence of the AdverseEvent was first recorded.
        Parameters:
        recordedDate - When the event was recorded
        Returns:
        A reference to this Builder instance

      • resultingCondition

        public AdverseEvent.Builder resultingCondition​(Reference... resultingCondition)
        Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).

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

        Allowed resource types for the references:

        Parameters:
        resultingCondition - Effect on the subject due to this event
        Returns:
        A reference to this Builder instance

      • resultingCondition

        public AdverseEvent.Builder resultingCondition​(java.util.Collection<Reference> resultingCondition)
        Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).

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

        Allowed resource types for the references:

        Parameters:
        resultingCondition - Effect on the subject due to this event
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • location

        public AdverseEvent.Builder location​(Reference location)
        The information about where the adverse event occurred.

        Allowed resource types for this reference:

        Parameters:
        location - Location where adverse event occurred
        Returns:
        A reference to this Builder instance

      • seriousness

        public AdverseEvent.Builder seriousness​(CodeableConcept seriousness)
        Assessment whether this event was of real importance.
        Parameters:
        seriousness - Seriousness of the event
        Returns:
        A reference to this Builder instance

      • severity

        public AdverseEvent.Builder severity​(CodeableConcept severity)
        Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.
        Parameters:
        severity - mild | moderate | severe
        Returns:
        A reference to this Builder instance

      • outcome

        public AdverseEvent.Builder outcome​(CodeableConcept outcome)
        Describes the type of outcome from the adverse event.
        Parameters:
        outcome - resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
        Returns:
        A reference to this Builder instance

      • contributor

        public AdverseEvent.Builder contributor​(Reference... contributor)
        Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).

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

        Allowed resource types for the references:

        Parameters:
        contributor - Who was involved in the adverse event or the potential adverse event
        Returns:
        A reference to this Builder instance

      • contributor

        public AdverseEvent.Builder contributor​(java.util.Collection<Reference> contributor)
        Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).

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

        Allowed resource types for the references:

        Parameters:
        contributor - Who was involved in the adverse event or the potential adverse event
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • suspectEntity

        public AdverseEvent.Builder suspectEntity​(AdverseEvent.SuspectEntity... suspectEntity)
        Describes the entity that is suspected to have caused the adverse event.

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

        Parameters:
        suspectEntity - The suspected agent causing the adverse event
        Returns:
        A reference to this Builder instance

      • suspectEntity

        public AdverseEvent.Builder suspectEntity​(java.util.Collection<AdverseEvent.SuspectEntity> suspectEntity)
        Describes the entity that is suspected to have caused the adverse event.

        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:
        suspectEntity - The suspected agent causing the adverse event
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • referenceDocument

        public AdverseEvent.Builder referenceDocument​(Reference... referenceDocument)
        AdverseEvent.referenceDocument.

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

        Allowed resource types for the references:

        Parameters:
        referenceDocument - AdverseEvent.referenceDocument
        Returns:
        A reference to this Builder instance

      • referenceDocument

        public AdverseEvent.Builder referenceDocument​(java.util.Collection<Reference> referenceDocument)
        AdverseEvent.referenceDocument.

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

        Allowed resource types for the references:

        Parameters:
        referenceDocument - AdverseEvent.referenceDocument
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • study

        public AdverseEvent.Builder study​(Reference... study)
        AdverseEvent.study.

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

        Allowed resource types for the references:

        Parameters:
        study - AdverseEvent.study
        Returns:
        A reference to this Builder instance

      • study

        public AdverseEvent.Builder study​(java.util.Collection<Reference> study)
        AdverseEvent.study.

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

        Allowed resource types for the references:

        Parameters:
        study - AdverseEvent.study
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • validate

        protected void validate​(AdverseEvent adverseEvent)