Package com.ibm.fhir.model.resource

Class ImmunizationRecommendation.Recommendation.Builder

    • Method Detail

      • id

        public ImmunizationRecommendation.Recommendation.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 ImmunizationRecommendation.Recommendation.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 ImmunizationRecommendation.Recommendation.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 ImmunizationRecommendation.Recommendation.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 ImmunizationRecommendation.Recommendation.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

      • vaccineCode

        public ImmunizationRecommendation.Recommendation.Builder vaccineCode​(CodeableConcept... vaccineCode)
        Vaccine(s) or vaccine group that pertain to the recommendation.

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

        Parameters:
        vaccineCode - Vaccine or vaccine group recommendation applies to
        Returns:
        A reference to this Builder instance

      • vaccineCode

        public ImmunizationRecommendation.Recommendation.Builder vaccineCode​(java.util.Collection<CodeableConcept> vaccineCode)
        Vaccine(s) or vaccine group that pertain to the recommendation.

        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:
        vaccineCode - Vaccine or vaccine group recommendation applies to
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • contraindicatedVaccineCode

        public ImmunizationRecommendation.Recommendation.Builder contraindicatedVaccineCode​(CodeableConcept... contraindicatedVaccineCode)
        Vaccine(s) which should not be used to fulfill the recommendation.

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

        Parameters:
        contraindicatedVaccineCode - Vaccine which is contraindicated to fulfill the recommendation
        Returns:
        A reference to this Builder instance

      • contraindicatedVaccineCode

        public ImmunizationRecommendation.Recommendation.Builder contraindicatedVaccineCode​(java.util.Collection<CodeableConcept> contraindicatedVaccineCode)
        Vaccine(s) which should not be used to fulfill the recommendation.

        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:
        contraindicatedVaccineCode - Vaccine which is contraindicated to fulfill the recommendation
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • forecastStatus

        public ImmunizationRecommendation.Recommendation.Builder forecastStatus​(CodeableConcept forecastStatus)
        Indicates the patient status with respect to the path to immunity for the target disease.

        This element is required.

        Parameters:
        forecastStatus - Vaccine recommendation status
        Returns:
        A reference to this Builder instance

      • forecastReason

        public ImmunizationRecommendation.Recommendation.Builder forecastReason​(CodeableConcept... forecastReason)
        The reason for the assigned forecast status.

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

        Parameters:
        forecastReason - Vaccine administration status reason
        Returns:
        A reference to this Builder instance

      • forecastReason

        public ImmunizationRecommendation.Recommendation.Builder forecastReason​(java.util.Collection<CodeableConcept> forecastReason)
        The reason for the assigned forecast status.

        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:
        forecastReason - Vaccine administration status reason
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • dateCriterion

        public ImmunizationRecommendation.Recommendation.Builder dateCriterion​(java.util.Collection<ImmunizationRecommendation.Recommendation.DateCriterion> dateCriterion)
        Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

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

      • description

        public ImmunizationRecommendation.Recommendation.Builder description​(String description)
        Contains the description about the protocol under which the vaccine was administered.
        Parameters:
        description - Protocol details
        Returns:
        A reference to this Builder instance

      • series

        public ImmunizationRecommendation.Recommendation.Builder series​(String series)
        One possible path to achieve presumed immunity against a disease - within the context of an authority.
        Parameters:
        series - Name of vaccination series
        Returns:
        A reference to this Builder instance

      • doseNumber

        public ImmunizationRecommendation.Recommendation.Builder doseNumber​(Element doseNumber)
        Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).

        This is a choice element with the following allowed types:

        Parameters:
        doseNumber - Recommended dose number within series
        Returns:
        A reference to this Builder instance

      • supportingImmunization

        public ImmunizationRecommendation.Recommendation.Builder supportingImmunization​(Reference... supportingImmunization)
        Immunization event history and/or evaluation that supports the status and recommendation.

        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:
        supportingImmunization - Past immunizations supporting recommendation
        Returns:
        A reference to this Builder instance

      • supportingImmunization

        public ImmunizationRecommendation.Recommendation.Builder supportingImmunization​(java.util.Collection<Reference> supportingImmunization)
        Immunization event history and/or evaluation that supports the status and recommendation.

        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:
        supportingImmunization - Past immunizations supporting recommendation
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • supportingPatientInformation

        public ImmunizationRecommendation.Recommendation.Builder supportingPatientInformation​(Reference... supportingPatientInformation)
        Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

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

        Parameters:
        supportingPatientInformation - Patient observations supporting recommendation
        Returns:
        A reference to this Builder instance

      • supportingPatientInformation

        public ImmunizationRecommendation.Recommendation.Builder supportingPatientInformation​(java.util.Collection<Reference> supportingPatientInformation)
        Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

        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:
        supportingPatientInformation - Patient observations supporting recommendation
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null