Package com.ibm.fhir.model.resource

Class Immunization.Builder

    • Method Detail

      • id

        public Immunization.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 Immunization.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 Immunization.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 Immunization.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 Immunization.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 Immunization.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 Immunization.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 Immunization.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 Immunization.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 Immunization.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 Immunization.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 Immunization.Builder identifier​(Identifier... identifier)
        A unique identifier assigned to this immunization record.

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

        Parameters:
        identifier - Business identifier
        Returns:
        A reference to this Builder instance

      • identifier

        public Immunization.Builder identifier​(java.util.Collection<Identifier> identifier)
        A unique identifier assigned to this immunization record.

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

      • status

        public Immunization.Builder status​(ImmunizationStatus status)
        Indicates the current status of the immunization event.

        This element is required.

        Parameters:
        status - completed | entered-in-error | not-done
        Returns:
        A reference to this Builder instance

      • statusReason

        public Immunization.Builder statusReason​(CodeableConcept statusReason)
        Indicates the reason the immunization event was not performed.
        Parameters:
        statusReason - Reason not done
        Returns:
        A reference to this Builder instance

      • vaccineCode

        public Immunization.Builder vaccineCode​(CodeableConcept vaccineCode)
        Vaccine that was administered or was to be administered.

        This element is required.

        Parameters:
        vaccineCode - Vaccine product administered
        Returns:
        A reference to this Builder instance

      • patient

        public Immunization.Builder patient​(Reference patient)
        The patient who either received or did not receive the immunization.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        patient - Who was immunized
        Returns:
        A reference to this Builder instance

      • encounter

        public Immunization.Builder encounter​(Reference encounter)
        The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

        Allowed resource types for this reference:

        Parameters:
        encounter - Encounter immunization was part of
        Returns:
        A reference to this Builder instance

      • occurrence

        public Immunization.Builder occurrence​(java.lang.String occurrence)
        Convenience method for setting occurrence with choice type String.

        This element is required.

        Parameters:
        occurrence - Vaccine administration date
        Returns:
        A reference to this Builder instance
        See Also:
        occurrence(Element)

      • occurrence

        public Immunization.Builder occurrence​(Element occurrence)
        Date vaccine administered or was to be administered.

        This element is required.

        This is a choice element with the following allowed types:

        Parameters:
        occurrence - Vaccine administration date
        Returns:
        A reference to this Builder instance

      • recorded

        public Immunization.Builder recorded​(DateTime recorded)
        The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
        Parameters:
        recorded - When the immunization was first captured in the subject's record
        Returns:
        A reference to this Builder instance

      • primarySource

        public Immunization.Builder primarySource​(Boolean primarySource)
        An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
        Parameters:
        primarySource - Indicates context the data was recorded in
        Returns:
        A reference to this Builder instance

      • reportOrigin

        public Immunization.Builder reportOrigin​(CodeableConcept reportOrigin)
        The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
        Parameters:
        reportOrigin - Indicates the source of a secondarily reported record
        Returns:
        A reference to this Builder instance

      • location

        public Immunization.Builder location​(Reference location)
        The service delivery location where the vaccine administration occurred.

        Allowed resource types for this reference:

        Parameters:
        location - Where immunization occurred
        Returns:
        A reference to this Builder instance

      • manufacturer

        public Immunization.Builder manufacturer​(Reference manufacturer)
        Name of vaccine manufacturer.

        Allowed resource types for this reference:

        Parameters:
        manufacturer - Vaccine manufacturer
        Returns:
        A reference to this Builder instance

      • lotNumber

        public Immunization.Builder lotNumber​(String lotNumber)
        Lot number of the vaccine product.
        Parameters:
        lotNumber - Vaccine lot number
        Returns:
        A reference to this Builder instance

      • expirationDate

        public Immunization.Builder expirationDate​(Date expirationDate)
        Date vaccine batch expires.
        Parameters:
        expirationDate - Vaccine expiration date
        Returns:
        A reference to this Builder instance

      • site

        public Immunization.Builder site​(CodeableConcept site)
        Body site where vaccine was administered.
        Parameters:
        site - Body site vaccine was administered
        Returns:
        A reference to this Builder instance

      • route

        public Immunization.Builder route​(CodeableConcept route)
        The path by which the vaccine product is taken into the body.
        Parameters:
        route - How vaccine entered body
        Returns:
        A reference to this Builder instance

      • doseQuantity

        public Immunization.Builder doseQuantity​(SimpleQuantity doseQuantity)
        The quantity of vaccine product that was administered.
        Parameters:
        doseQuantity - Amount of vaccine administered
        Returns:
        A reference to this Builder instance

      • performer

        public Immunization.Builder performer​(Immunization.Performer... performer)
        Indicates who performed the immunization event.

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

        Parameters:
        performer - Who performed event
        Returns:
        A reference to this Builder instance

      • performer

        public Immunization.Builder performer​(java.util.Collection<Immunization.Performer> performer)
        Indicates who performed the immunization 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:
        performer - Who performed event
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • note

        public Immunization.Builder note​(Annotation... note)
        Extra information about the immunization that is not conveyed by the other attributes.

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

        Parameters:
        note - Additional immunization notes
        Returns:
        A reference to this Builder instance

      • note

        public Immunization.Builder note​(java.util.Collection<Annotation> note)
        Extra information about the immunization that is not conveyed by the other attributes.

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

      • reasonCode

        public Immunization.Builder reasonCode​(CodeableConcept... reasonCode)
        Reasons why the vaccine was administered.

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

        Parameters:
        reasonCode - Why immunization occurred
        Returns:
        A reference to this Builder instance

      • reasonCode

        public Immunization.Builder reasonCode​(java.util.Collection<CodeableConcept> reasonCode)
        Reasons why the vaccine was administered.

        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:
        reasonCode - Why immunization occurred
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • reasonReference

        public Immunization.Builder reasonReference​(Reference... reasonReference)
        Condition, Observation or DiagnosticReport that supports why the immunization was administered.

        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:
        reasonReference - Why immunization occurred
        Returns:
        A reference to this Builder instance

      • reasonReference

        public Immunization.Builder reasonReference​(java.util.Collection<Reference> reasonReference)
        Condition, Observation or DiagnosticReport that supports why the immunization was administered.

        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:
        reasonReference - Why immunization occurred
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • isSubpotent

        public Immunization.Builder isSubpotent​(Boolean isSubpotent)
        Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
        Parameters:
        isSubpotent - Dose potency
        Returns:
        A reference to this Builder instance

      • subpotentReason

        public Immunization.Builder subpotentReason​(CodeableConcept... subpotentReason)
        Reason why a dose is considered to be subpotent.

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

        Parameters:
        subpotentReason - Reason for being subpotent
        Returns:
        A reference to this Builder instance

      • subpotentReason

        public Immunization.Builder subpotentReason​(java.util.Collection<CodeableConcept> subpotentReason)
        Reason why a dose is considered to be subpotent.

        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:
        subpotentReason - Reason for being subpotent
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • education

        public Immunization.Builder education​(Immunization.Education... education)
        Educational material presented to the patient (or guardian) at the time of vaccine administration.

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

        Parameters:
        education - Educational material presented to patient
        Returns:
        A reference to this Builder instance

      • education

        public Immunization.Builder education​(java.util.Collection<Immunization.Education> education)
        Educational material presented to the patient (or guardian) at the time of vaccine administration.

        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:
        education - Educational material presented to patient
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • programEligibility

        public Immunization.Builder programEligibility​(CodeableConcept... programEligibility)
        Indicates a patient's eligibility for a funding program.

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

        Parameters:
        programEligibility - Patient eligibility for a vaccination program
        Returns:
        A reference to this Builder instance

      • programEligibility

        public Immunization.Builder programEligibility​(java.util.Collection<CodeableConcept> programEligibility)
        Indicates a patient's eligibility for a funding program.

        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:
        programEligibility - Patient eligibility for a vaccination program
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • fundingSource

        public Immunization.Builder fundingSource​(CodeableConcept fundingSource)
        Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
        Parameters:
        fundingSource - Funding source for the vaccine
        Returns:
        A reference to this Builder instance

      • reaction

        public Immunization.Builder reaction​(Immunization.Reaction... reaction)
        Categorical data indicating that an adverse event is associated in time to an immunization.

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

        Parameters:
        reaction - Details of a reaction that follows immunization
        Returns:
        A reference to this Builder instance

      • reaction

        public Immunization.Builder reaction​(java.util.Collection<Immunization.Reaction> reaction)
        Categorical data indicating that an adverse event is associated in time to an immunization.

        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:
        reaction - Details of a reaction that follows immunization
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • protocolApplied

        public Immunization.Builder protocolApplied​(Immunization.ProtocolApplied... protocolApplied)
        The protocol (set of recommendations) being followed by the provider who administered the dose.

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

        Parameters:
        protocolApplied - Protocol followed by the provider
        Returns:
        A reference to this Builder instance

      • protocolApplied

        public Immunization.Builder protocolApplied​(java.util.Collection<Immunization.ProtocolApplied> protocolApplied)
        The protocol (set of recommendations) being followed by the provider who administered the dose.

        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:
        protocolApplied - Protocol followed by the provider
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • validate

        protected void validate​(Immunization immunization)